#include <GMFMort.h>
Public Member Functions | |
clGMFMort (clSimManager *p_oSimManager) | |
Constructor. | |
~clGMFMort () | |
Destructor. | |
void | DoShellSetup (xercesc::DOMDocument *p_oDoc) |
Performs setup. | |
deadCode | 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. |
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". The parameter file call string is "gmfmortality".
Copyright 2003 Charles D. Canham.
clGMFMort::clGMFMort | ( | clSimManager * | p_oSimManager | ) |
Constructor.
Sets the namestring.
p_oSimManager | Pointer to Simulation Manager. |
clGMFMort::~clGMFMort | ( | ) |
Destructor.
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.
p_oDoc | DOM Tree from parsed parameter file. |
modelErr | if there is a species/type code for which "Growth" has not been registered as a float. |
Reimplemented from clMortalityBase.
deadCode clGMFMort::DoMort | ( | clTree * | p_oTree, | |
const float & | fDbh, | |||
const short int & | iSpecies | |||
) | [virtual] |
Calculates mortality according to the GMF mortality equation.
fDbh | DBH of tree being evaluated - for seedlings will be 0 | |
p_oTree | Tree being evaluated | |
iSpecies | Species of the tree being evaluated |
Implements 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.
modelErr | if there is no code for any species/type combo which uses this behavior. |
short int** clGMFMort::mp_iGrowthCodes [protected] |
data member codes for "Growth" member - species by type
float* clGMFMort::mp_fMortAtZeroGrowth [protected] |
Mortality at zero growth.
Old parameter m1
float* clGMFMort::mp_fLightDepMort [protected] |
Light dependent mortality.
Old parameter m2