#include <WeibullClimateGrowth.h>
Public Member Functions | |
clWeibullClimateGrowth (clSimManager *p_oSimManager) | |
Constructor. | |
~clWeibullClimateGrowth () | |
Destructor. | |
float | CalcDiameterGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fHeightGrowth) |
Returns the value in the tree's float data member that holds the value that was calculated by PreGrowthCalcs(). | |
void | PreGrowthCalcs (clTreePopulation *p_oPop) |
Calculates growth. | |
void | DoShellSetup (xercesc::DOMDocument *p_oDoc) |
Does setup. | |
void | SetNameData (char *cNameString) |
Captures the namestring passed to this behavior. | |
Protected Member Functions | |
void | ValidateData () |
Makes sure all input data is valid. | |
void | GetGrowthCodes () |
Gets the return codes for the "Growth" float tree data member for each tree kind to which this behavior applies. | |
void | ReadParameterFile (xercesc::DOMDocument *p_oDoc) |
Reads data from the parameter file. | |
int | GetNumLargerNeighbors (clTree *p_oTarget, clTreePopulation *p_oPop) |
Counts the number of trees a target's neighborhood that have a DBH bigger than the target. | |
void | FormatQuery () |
Populates m_cQuery with the query for getting target trees. | |
Protected Attributes | |
short int ** | mp_iGrowthCodes |
Holds return data codes for the "Growth" tree data member. | |
float ** | mp_fCompC |
Competition effect C. | |
float ** | mp_fCompD |
Competition effect D. | |
float ** | mp_fGamma |
Size sensitivity to crowding parameter. | |
float * | mp_fMaxCrowdingRadius |
Maximum search radius, in meters, in which to look for crowding neighbors. | |
float * | mp_fMinimumNeighborDBH |
The minimum DBH, in cm, of neighbors to be included in the neighbor count. | |
double * | mp_fSizeX0 |
Size effect X0. | |
float * | mp_fSizeXb |
Size effect Xb. | |
float * | mp_fSizeMinDBH |
Size effect minimum DBH. | |
float ** | mp_fPrecipA |
Precipitation effect A. | |
float ** | mp_fPrecipB |
Precipitation effect B. | |
float ** | mp_fPrecipC |
Precipitation effect C. | |
float ** | mp_fTempA |
Temperature effect A. | |
float ** | mp_fTempB |
Temperature effect B. | |
float ** | mp_fTempC |
Temperature effect C. | |
float * | mp_fMaxRG |
Maximum potential growth value, in cm. | |
short int * | mp_iIndexes |
Speeds access to the arrays. | |
char * | m_cQuery |
Query string to get target trees. | |
float | m_fMinSaplingHeight |
Minimum sapling height. | |
short int | m_iNumTotalSpecies |
Keep our own copy for the destructor. |
This is a growth shell object which calculates growth as a function of climate and neighbor density.
The growth equation for one year's growth is:
The equation for Size Effect is:
where:
Size effect is subject to a minimum value for DBH, below which all trees will just get the minimum.
Precipitation Effect and Temperature Effect use the same function form, and both use separate parameters for juveniles and adults. The function is:
Climate Effect <- exp(-0.5*(abs(CV - C)/A)B)
where:
Competition Effect uses separate parameters for juveniles and adults. CE is calculated as:
Snags, seedlings, and already-dead trees are never counted in the neighbor count.
The amount of growth is in cm/year. For multi-year timesteps, the behavior will calculate total growth with a loop. Each loop iteration will increment DBH for one year. For each year, the Size Effect (SE) value and the DBHγ portion of the Competition Effect is recalculated with the previous year's new DBH value. All values for each year of growth are summed to get the growth for the timestep.
This cannot be applied to seedlings. An error will be thrown if seedlings are passed.
The parameter file call string for this to be diameter-incrementing with auto-height updating is "WeibullClimateGrowth"; for diameter-only incrementing, use "WeibullClimateGrowth diam only". The namestring for this behavior is "WeibullClimategrowthshell".
Copyright 2010 Charles D. Canham.
clWeibullClimateGrowth::clWeibullClimateGrowth | ( | clSimManager * | p_oSimManager | ) |
Constructor.
p_oSimManager | Sim Manager object. |
clWeibullClimateGrowth::~clWeibullClimateGrowth | ( | ) |
Destructor.
float clWeibullClimateGrowth::CalcDiameterGrowthValue | ( | clTree * | p_oTree, | |
clTreePopulation * | p_oPop, | |||
float | fHeightGrowth | |||
) | [virtual] |
Returns the value in the tree's float data member that holds the value that was calculated by PreGrowthCalcs().
p_oTree | Tree to which to apply growth. | |
p_oPop | Tree population object. | |
fHeightGrowth | Amount of height growth, in m (ignored). |
Reimplemented from clGrowthBase.
void clWeibullClimateGrowth::PreGrowthCalcs | ( | clTreePopulation * | p_oPop | ) | [virtual] |
Calculates growth.
The values are stashed in the "Growth" tree float data member for later application.
Steps:
Growth per timestep is calculated by looping over the number of years per timestep and incrementing the DBH.
p_oPop | Tree population object. |
Reimplemented from clGrowthBase.
void clWeibullClimateGrowth::DoShellSetup | ( | xercesc::DOMDocument * | p_oDoc | ) | [virtual] |
Does setup.
p_oDoc | DOM tree of parsed input tree. |
Reimplemented from clGrowthBase.
void clWeibullClimateGrowth::SetNameData | ( | char * | cNameString | ) | [virtual] |
Captures the namestring passed to this behavior.
This is overridden from clBehaviorBase so we can capture the namestring passed. Since this class can create multiple kinds of behaviors that function differently, this will capture what kind of behavior this is supposed to be.
cNameString | Behavior's namestring. |
Reimplemented from clBehaviorBase.
void clWeibullClimateGrowth::ValidateData | ( | ) | [protected] |
Makes sure all input data is valid.
The following must all be true:
modelErr | if any of the above conditions are not met. |
void clWeibullClimateGrowth::GetGrowthCodes | ( | ) | [protected] |
Gets the return codes for the "Growth" float tree data member for each tree kind to which this behavior applies.
modelErr | if a code comes back -1 for any species/type combo to which this behavior is applied. |
void clWeibullClimateGrowth::ReadParameterFile | ( | xercesc::DOMDocument * | p_oDoc | ) | [protected] |
Reads data from the parameter file.
p_oDoc | DOM tree of parsed input tree. |
modelErr | if this behavior has been applied to any types except sapling and adult. |
int clWeibullClimateGrowth::GetNumLargerNeighbors | ( | clTree * | p_oTarget, | |
clTreePopulation * | p_oPop | |||
) | [protected] |
Counts the number of trees a target's neighborhood that have a DBH bigger than the target.
p_oTarget | Target tree for which to count the larger neighbors. | |
p_oPop | Tree population, for getting neighbors. |
void clWeibullClimateGrowth::FormatQuery | ( | ) | [protected] |
Populates m_cQuery with the query for getting target trees.
short int** clWeibullClimateGrowth::mp_iGrowthCodes [protected] |
Holds return data codes for the "Growth" tree data member.
Array size is number of species to which this behavior applies by 2 (saplings and adults).
float** clWeibullClimateGrowth::mp_fCompC [protected] |
Competition effect C.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fCompD [protected] |
Competition effect D.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fGamma [protected] |
Size sensitivity to crowding parameter.
γ in Competition Effect equation above. Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float* clWeibullClimateGrowth::mp_fMaxCrowdingRadius [protected] |
Maximum search radius, in meters, in which to look for crowding neighbors.
For calculating the Competition Effect. Array is sized number of species to which this behavior applies.
float* clWeibullClimateGrowth::mp_fMinimumNeighborDBH [protected] |
The minimum DBH, in cm, of neighbors to be included in the neighbor count.
Array is sized number of species.
double* clWeibullClimateGrowth::mp_fSizeX0 [protected] |
Size effect X0.
This must be an array of doubles in order to support very small values. Array is sized number of species to which this behavior applies.
float* clWeibullClimateGrowth::mp_fSizeXb [protected] |
Size effect Xb.
Array is sized number of species to which this behavior applies.
float* clWeibullClimateGrowth::mp_fSizeMinDBH [protected] |
Size effect minimum DBH.
Array is sized number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fPrecipA [protected] |
Precipitation effect A.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fPrecipB [protected] |
Precipitation effect B.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fPrecipC [protected] |
Precipitation effect C.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fTempA [protected] |
Temperature effect A.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fTempB [protected] |
Temperature effect B.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float** clWeibullClimateGrowth::mp_fTempC [protected] |
Temperature effect C.
Array is sized 2 (juveniles = index 0, adults = index 1) by number of species to which this behavior applies.
float* clWeibullClimateGrowth::mp_fMaxRG [protected] |
Maximum potential growth value, in cm.
Array is sized number of species to which this behavior applies.
short int* clWeibullClimateGrowth::mp_iIndexes [protected] |
Speeds access to the arrays.
Array size is number of species.
char* clWeibullClimateGrowth::m_cQuery [protected] |
Query string to get target trees.
float clWeibullClimateGrowth::m_fMinSaplingHeight [protected] |
Minimum sapling height.
For doing neighbor searches.
short int clWeibullClimateGrowth::m_iNumTotalSpecies [protected] |
Keep our own copy for the destructor.
This is the total number of tree species.