#include <CompetitionMort.h>
Inheritance diagram for clCompetitionMort:
Public Member Functions | |
clCompetitionMort (clSimManager *p_oSimManager) | |
Constructor. | |
~clCompetitionMort () | |
Destructor. | |
void | DoShellSetup (xercesc::DOMDocument *p_oDoc) |
Reads in values from the parameter file and makes sure all data needed is collected. | |
bool | DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies) |
Calculates mortality according to the competition mortality equation. | |
Protected Member Functions | |
void | GetLgmVariableCodes () |
Queries for the return codes of the "lgm" float data member of a tree. | |
Protected Attributes | |
short int ** | mp_iLgmCodes |
data member codes for "lgm" member - species by type | |
float * | mp_fCompMort |
Shape parameter for competition-dependent mortality function. | |
float * | mp_fCompMortMax |
Parameter for competition-dependent morality function that determines the maximum Relative Increment suject to mortality Array sized number of species to which this behavior applies. | |
float | m_fNumberYearsPerTimestep |
Number of years per timestep. | |
float * | mp_fXb |
Size effect variance parameter (Xb). | |
float * | mp_fMaxPotentialGrowth |
Maximum potential growth in cm/yr. | |
float * | mp_fX0 |
Size effect mode parameter (X0). | |
short int * | mp_iIndexes |
Speeds access to the arrays. |
This evaluates mortality according to Relative Increment (Actual Diameter Growth(i.e. lgm)/Potential Diameter Growth). The probability of mortality is a function of Relative Increment.
Competition-Dependent Mortality can only be used in conjunction with NCI Growth.
This class's namestring is "competitionmortshell". The parameter file call string is "competitionmortality".
Copyright 2003 Charles D. Canham.
clCompetitionMort::clCompetitionMort | ( | clSimManager * | p_oSimManager | ) |
Constructor.
Sets the namestring.
bool clCompetitionMort::DoMort | ( | clTree * | p_oTree, | |
const float & | fDbh, | |||
const short int & | iSpecies | |||
) | [virtual] |
Calculates mortality according to the competition mortality equation.
p_oTree | Tree being evaluated. | |
fDbh | DBH of tree being evaluated. | |
iSpecies | Species of the tree being evaluated. |
Implements clMortalityBase.
void clCompetitionMort::DoShellSetup | ( | xercesc::DOMDocument * | p_oDoc | ) | [virtual] |
Reads in values from the parameter file and makes sure all data needed is collected.
p_oDoc | Parsed DOM tree of parameter file. |
Reimplemented from clMortalityBase.
void clCompetitionMort::GetLgmVariableCodes | ( | ) | [protected] |
Queries for the return codes of the "lgm" float data member of a tree.
This data member should have been registered by light. Return codes are captured in the mp_iLgmCodes array.
modelErr | if there is no code for any species/type combo which uses this behavior. |
float* clCompetitionMort::mp_fCompMort [protected] |
Shape parameter for competition-dependent mortality function.
Array sized number of species to which this behavior applies.
float* clCompetitionMort::mp_fMaxPotentialGrowth [protected] |
Maximum potential growth in cm/yr.
Array sized number of species to which this behavior applies.
float* clCompetitionMort::mp_fX0 [protected] |
Size effect mode parameter (X0).
Array sized number of species to which this behavior applies.
float* clCompetitionMort::mp_fXb [protected] |
Size effect variance parameter (Xb).
Array sized number of species to which this behavior applies.