clGMFMort Class Reference

GMF Mortality - Version 1.0. More...

#include <GMFMort.h>

Inheritance diagram for clGMFMort:

clMortalityBase clBehaviorBase clWorkerBase List of all members.

Public Member Functions

 clGMFMort (clSimManager *p_oSimManager)
 Constructor.
 ~clGMFMort ()
 Destructor.
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Performs setup.
bool DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies)
 Calculates mortality according to the GMF mortality equation.

Protected Member Functions

void GetGrowthVariableCodes ()
 Queries for the return codes of the "Growth" float data member of a tree.

Protected Attributes

short int ** mp_iGrowthCodes
 data member codes for "Growth" member - species by type
float * mp_fMortAtZeroGrowth
 Mortality at zero growth.
float * mp_fLightDepMort
 Light dependent mortality.

Detailed Description

GMF Mortality - Version 1.0.

This evaluates growth-based mortality according to the GMF mortality equation. Since this equation assumes a timestep length of 5 years, and the equation has not yet been reworked, this will throw a fatal error if the timestep length is not five years.

All species/type combos wishing to use this behavior must have the "Growth" data member registered. It is assumed that the value in that data member when mortality is called is the amount of growth for this timestep.

This class's namestring is "gmfmortshell".

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta (LEM)
April 29, 2004 - Adjusted for the new mortality data member (LEM)


Constructor & Destructor Documentation

clGMFMort::clGMFMort clSimManager p_oSimManager  ) 
 

Constructor.

Sets the namestring.

Parameters:
p_oSimManager Pointer to Simulation Manager.


Member Function Documentation

bool clGMFMort::DoMort clTree p_oTree,
const float &  fDbh,
const short int &  iSpecies
[virtual]
 

Calculates mortality according to the GMF mortality equation.

Parameters:
fDbh DBH of tree being evaluated - for seedlings will be 0
p_oTree Tree being evaluated
iSpecies Species of the tree being evaluated
Returns:
True if the tree is to die, false if it lives.

Implements clMortalityBase.

void clGMFMort::DoShellSetup xercesc::DOMDocument *  p_oDoc  )  [virtual]
 

Performs setup.

This reads in values from parameter file. It also collects data member codes for "Growth" for each type/species combo to which it is assigned.

Parameters:
p_oDoc DOM Tree from parsed parameter file.
Exceptions:
modelErr if there is a species/type code for which "Growth" has not been registered as a float.

Reimplemented from clMortalityBase.

void clGMFMort::GetGrowthVariableCodes  )  [protected]
 

Queries for the return codes of the "Growth" float data member of a tree.

This data member should have been registered by light. Return codes are captured in the mp_iGrowthCodes array.

Exceptions:
modelErr if there is no code for any species/type combo which uses this behavior.


Member Data Documentation

float* clGMFMort::mp_fLightDepMort [protected]
 

Light dependent mortality.

Old parameter m2

float* clGMFMort::mp_fMortAtZeroGrowth [protected]
 

Mortality at zero growth.

Old parameter m1


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 12:51:12 2006 for SORTIE Core C++ Documentation by  doxygen 1.4.6-NO