#include <LogisticBiLevelMortality.h>
Public Member Functions | |
clLogisticBiLevelMortality (clSimManager *p_oSimManager) | |
Constructor. | |
~clLogisticBiLevelMortality () | |
Destructor. | |
void | DoShellSetup (xercesc::DOMDocument *p_oDoc) |
Reads in values from the parameter file. | |
whyDead | DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies) |
Calculates mortality according to the logistic equation. | |
Protected Attributes | |
clGridBase * | mp_oStormLight |
"Storm Light" grid object | |
clTreePopulation * | mp_oPop |
Tree population - for getting data codes. | |
float * | mp_fLoLightB |
Mortality equation low light "b" - sized number of behavior species. | |
float * | mp_fLoLightA |
Mortality equation low light "a" - sized number of behavior species. | |
float * | mp_fHiLightB |
Mortality equation high light "b" - sized number of behavior species. | |
float * | mp_fHiLightA |
Mortality equation high light "a" - sized number of behavior species. | |
float * | mp_fHiLightThreshold |
Threshold between low light and high light mortality, as a value between 0 and 100 - sized number of behavior species. | |
int * | mp_iIndexes |
To help access the other arrays. | |
float | m_fYearsPerTimestep |
Conversion factor to translate the results of the function to the appropriate units per timestep. | |
int | m_iLightCode |
Code for the "Light" data member of the "Storm Light" grid. |
This evaluates mortality according to a logistic equation, with the possibility of two sets of parameters for each species. The two sets of parameters can be used for two different mortality rates at high and low light.
The equation used in this behavior is:
This behavior can also take into account light levels coming from the "Storm Light" grid object produced by clStormLight. This behavior can use two different sets of parameter values - one at low light and one at high light. The user sets the threshold between the two. The equation remains the same.
This class's namestring is "logistic bilevel mortshell". The parameter file call string is "Logistic Bi-Level Mortality".
Copyright 2005 Charles D. Canham.
clLogisticBiLevelMortality::clLogisticBiLevelMortality | ( | clSimManager * | p_oSimManager | ) |
Constructor.
p_oSimManager | Sim Manager object. |
clLogisticBiLevelMortality::~clLogisticBiLevelMortality | ( | ) |
Destructor.
void clLogisticBiLevelMortality::DoShellSetup | ( | xercesc::DOMDocument * | p_oDoc | ) | [virtual] |
Reads in values from the parameter file.
p_oDoc | DOM tree of parsed input file. |
Reimplemented from clMortalityBase.
whyDead clLogisticBiLevelMortality::DoMort | ( | clTree * | p_oTree, | |
const float & | fDbh, | |||
const short int & | iSpecies | |||
) | [virtual] |
Calculates mortality according to the logistic equation.
If the light grid is present, this retrieves the light level in the tree's grid cell. If it is above the threshold, the high-light parameters are used. If it is below the threshold, the low-light parameters are used. If the light grid is not present, the low-light parameters are used.
p_oTree | Tree being evaluated | |
fDbh | Tree's DBH | |
iSpecies | Species of the tree being evaluated |
Implements clMortalityBase.
clGridBase* clLogisticBiLevelMortality::mp_oStormLight [protected] |
"Storm Light" grid object
clTreePopulation* clLogisticBiLevelMortality::mp_oPop [protected] |
Tree population - for getting data codes.
float* clLogisticBiLevelMortality::mp_fLoLightB [protected] |
Mortality equation low light "b" - sized number of behavior species.
float* clLogisticBiLevelMortality::mp_fLoLightA [protected] |
Mortality equation low light "a" - sized number of behavior species.
float* clLogisticBiLevelMortality::mp_fHiLightB [protected] |
Mortality equation high light "b" - sized number of behavior species.
float* clLogisticBiLevelMortality::mp_fHiLightA [protected] |
Mortality equation high light "a" - sized number of behavior species.
float* clLogisticBiLevelMortality::mp_fHiLightThreshold [protected] |
Threshold between low light and high light mortality, as a value between 0 and 100 - sized number of behavior species.
int* clLogisticBiLevelMortality::mp_iIndexes [protected] |
To help access the other arrays.
float clLogisticBiLevelMortality::m_fYearsPerTimestep [protected] |
Conversion factor to translate the results of the function to the appropriate units per timestep.
int clLogisticBiLevelMortality::m_iLightCode [protected] |
Code for the "Light" data member of the "Storm Light" grid.