#include <NCIBAGrowth.h>
Inheritance diagram for clNCIBAGrowth:
Public Member Functions | |
clNCIBAGrowth (clSimManager *p_oSimManager) | |
Constructor. | |
~clNCIBAGrowth () | |
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 for all NCI trees. | |
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. | |
float | GetBasalAreas (clTree *p_oTarget, clTreePopulation *p_oPop) |
Calculates the sum of the basal areas for neighbors larger than the target tree's DBH. | |
void | ReadParameterFile (xercesc::DOMDocument *p_oDoc) |
Reads data from the parameter file. | |
void | AssembleUniqueTypes () |
Assembles a unique list of types applied to this behavior and places it in mp_iWhatBehaviorTypes. | |
Protected Attributes | |
short int ** | mp_iGrowthCodes |
Holds return data codes for the "Growth" tree data member. | |
float * | mp_fCrowdingSlope |
Crowding effect slope. | |
float * | mp_fCrowdingSteepness |
Crowding effect steepness. | |
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 NCI calculations. | |
float * | mp_fXb |
Size effect variance parameter. | |
float * | mp_fMaxPotentialValue |
Maximum potential growth value, in cm. | |
float * | mp_fX0 |
Size effect mode parameter. | |
float * | mp_fGamma |
Size sensitivity to NCI parameter. | |
short int * | mp_iIndexes |
Speeds access to the arrays. | |
short int * | mp_iWhatBehaviorTypes |
List of types managed by this behavior. | |
float | m_fMinSaplingHeight |
Minimum sapling height. | |
short int | m_iNumBehaviorTypes |
Number of types managed by this behavior. | |
short int | m_iNumTotalSpecies |
Keep our own copy for the destructor. |
This is a growth shell object which applies the NCI (neighborhood competition index) function. The competition index uses neighbor basal area.
The growth equation for one year's growth is:
The equation for Size Effect is:
where:
Crowding Effect is calculated as:
Snags and already-dead trees are never counted in the basal area sum.
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 Crowding 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 "ncibagrowth"; for diameter-only incrementing, use "ncibagrowth diam only". The namestring for this behavior is "ncibagrowthshell".
Copyright 2005 Charles D. Canham.
clNCIBAGrowth::clNCIBAGrowth | ( | clSimManager * | p_oSimManager | ) |
Constructor.
p_oSimManager | Sim Manager object. |
float clNCIBAGrowth::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 clNCIBAGrowth::PreGrowthCalcs | ( | clTreePopulation * | p_oPop | ) | [virtual] |
Calculates growth for all NCI trees.
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 clNCIBAGrowth::DoShellSetup | ( | xercesc::DOMDocument * | p_oDoc | ) | [virtual] |
Does setup.
p_oDoc | DOM tree of parsed input tree. |
Reimplemented from clGrowthBase.
void clNCIBAGrowth::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 clNCIBAGrowth::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 clNCIBAGrowth::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. |
float clNCIBAGrowth::GetBasalAreas | ( | clTree * | p_oTarget, | |
clTreePopulation * | p_oPop | |||
) | [protected] |
Calculates the sum of the basal areas for neighbors larger than the target tree's DBH.
p_oTarget | Target tree for which to calculate the sum of neighbor basal areas. | |
p_oPop | Tree population, for getting neighbors. |
void clNCIBAGrowth::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. |
short int** clNCIBAGrowth::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* clNCIBAGrowth::mp_fCrowdingSlope [protected] |
Crowding effect slope.
C in Crowding Effect equation above. Array is sized number of species to which this behavior applies. This array is accessed by using the index returned for mp_iIndexes[species number].
float* clNCIBAGrowth::mp_fCrowdingSteepness [protected] |
Crowding effect steepness.
D in Crowding Effect equation above. Array is sized number of species to which this behavior applies. This array is accessed by using the index returned for mp_iIndexes[species number].
float* clNCIBAGrowth::mp_fMaxCrowdingRadius [protected] |
Maximum search radius, in meters, in which to look for crowding neighbors.
For calculating the Crowding Effect. Array is sized number of species to which this behavior applies. This array is accessed by using the index returned for mp_iIndexes[species number].
float* clNCIBAGrowth::mp_fMinimumNeighborDBH [protected] |
The minimum DBH, in cm, of neighbors to be included in NCI calculations.
Array is sized number of species.
float* clNCIBAGrowth::mp_fXb [protected] |
Size effect variance parameter.
Xb in Size Effect equation above. Array is sized number of species to which this behavior applies. This array is accessed by using the index returned for mp_iIndexes[species number].
float* clNCIBAGrowth::mp_fMaxPotentialValue [protected] |
Maximum potential growth value, in cm.
Array is sized number of species to which this behavior applies. This array is accessed by using the index returned for mp_iIndexes[species number].
float* clNCIBAGrowth::mp_fX0 [protected] |
Size effect mode parameter.
X0 in Size Effect equation above. Array is sized number of species to which this behavior applies. This array is accessed by using the index returned for mp_iIndexes[species number].
float* clNCIBAGrowth::mp_fGamma [protected] |
Size sensitivity to NCI parameter.
γ in Crowding Effect equation above. Array assumed to be sized number of species to which this behavior applies. This array is accessed by using the index returned for mp_iIndexes[species number].
short int* clNCIBAGrowth::mp_iIndexes [protected] |
Speeds access to the arrays.
Array size is number of species.
short int* clNCIBAGrowth::mp_iWhatBehaviorTypes [protected] |
List of types managed by this behavior.
float clNCIBAGrowth::m_fMinSaplingHeight [protected] |
Minimum sapling height.
For doing neighbor searches.
short int clNCIBAGrowth::m_iNumBehaviorTypes [protected] |
Number of types managed by this behavior.
short int clNCIBAGrowth::m_iNumTotalSpecies [protected] |
Keep our own copy for the destructor.
This is the total number of tree species.