#include <BCMort.h>
Public Member Functions | |
clBCMort (clSimManager *p_oSimManager) | |
Constructor. | |
~clBCMort () | |
Destructor. | |
void | DoShellSetup (xercesc::DOMDocument *p_oDoc) |
Reads in values from the parameter file and makes sure all data needed is collected. | |
deadCode | DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies) |
Calculates mortality according to the BC 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 - old code m1. | |
float * | mp_fLightDepMort |
Light dependent mortality - old code m2. | |
float | m_fNumberYearsPerTimestep |
Number of years per timestep. |
This evaluates mortality according to the BC mortality equation.
This class's namestring is "bcmortshell". The parameter file call string is "bcmortality".
NOTE from old code: mortality function in Kobe&Coates(1997) uses annual mm growth new function is not correct if m1 != 1.0 (Confirm this statement)
Copyright 2003 Charles D. Canham.
clBCMort::clBCMort | ( | clSimManager * | p_oSimManager | ) |
Constructor.
Sets the namestring.
clBCMort::~clBCMort | ( | ) |
Destructor.
void clBCMort::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.
deadCode clBCMort::DoMort | ( | clTree * | p_oTree, | |
const float & | fDbh, | |||
const short int & | iSpecies | |||
) | [virtual] |
Calculates mortality according to the BC 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 clBCMort::GetGrowthVariableCodes | ( | ) | [protected] |
Queries for the return codes of the "Growth" float data member of a tree.
This data member should have been registered by clGrowthBase child classes. 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** clBCMort::mp_iGrowthCodes [protected] |
data member codes for "Growth" member - species by type
float* clBCMort::mp_fMortAtZeroGrowth [protected] |
Mortality at zero growth - old code m1.
float* clBCMort::mp_fLightDepMort [protected] |
Light dependent mortality - old code m2.
float clBCMort::m_fNumberYearsPerTimestep [protected] |
Number of years per timestep.