SORTIE Core C++ Documentation
|
NCI juvenile growth - Version 1. More...
#include <NCIJuvenileGrowth.h>
Public Member Functions | |
clNCIJuvenileGrowth (clSimManager *p_oSimManager) | |
Constructor. | |
~clNCIJuvenileGrowth () | |
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. | |
![]() | |
clGrowthBase (clSimManager *p_oSimManager) | |
Constructor. | |
virtual | ~clGrowthBase () |
Destructor. | |
void | Action () |
Performs all growth calculations if "hooked". | |
virtual float | CalcHeightGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fDiameterGrowth) |
Calculates the amount of height growth increase for a particular tree, if applicable. | |
virtual float | GetGrowthMemberValue (clTree *p_oTree, float fDiameterGrowth) |
Calculates the value to go into a tree's "Growth" data member as the amount of growth. | |
growthType | GetGrowthMethod () |
Gets the method by which this behavior increments growth. | |
clGrowthOrg * | GetGrowthOrg () |
Get the growth org object. | |
void | RegisterTreeDataMembers () |
Performs data member registrations for "Growth". | |
![]() | |
virtual float | GetBehaviorVersion () |
Gets the behavior version number. | |
clBehaviorBase (clSimManager *p_oSimManager) | |
Constructor. | |
virtual | ~clBehaviorBase () |
Destructor. | |
virtual short int | ValidateVersionNumber (float fTestVersion) |
Makes sure that the version number of a file passed is between the minimum and current version numbers. | |
virtual void | SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos) |
Sets the species/type combos for a behavior. | |
virtual short int | GetNewTreeInts () |
Gets the number of new tree integer data members this behavior wants to register. | |
virtual short int | GetNewTreeFloats () |
Gets the number of new tree float data members this behavior wants to register. | |
virtual short int | GetNewTreeChars () |
Gets the number of new tree character data members this behavior wants to register. | |
virtual short int | GetNewTreeBools () |
Gets the number of new tree bool data members this behavior wants to register. | |
virtual short int | GetNumSpeciesTypeCombos () |
Gets the number of species/type combos to which this behavior applies. | |
virtual short int | GetNumBehaviorSpecies () |
Gets the number of unique tree species to which this behavior applies. | |
struct stcSpeciesTypeCombo | GetSpeciesTypeCombo (short int iIndex) |
Gets one of this behavior's type/species combos. | |
virtual short int | GetBehaviorSpecies (short int iIndex) |
Gets one of the behavior's species. | |
short int | GetBehaviorListNumber () |
Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. | |
void | SetBehaviorListNumber (short int iNumber) |
Sets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. | |
virtual DOMElement * | GetParentParametersElement (xercesc::DOMDocument *p_oDoc) |
Formats the string for species/types query. | |
![]() | |
clWorkerBase (clSimManager *p_oSimManager) | |
Constructor. | |
virtual | ~clWorkerBase () |
Destructor. | |
char * | GetName () |
Gets the object's namestring. | |
void | DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType) |
Triggers the setup process. | |
virtual void | TimestepCleanup () |
Performs any necessary cleanup operations at the end of a timestep. | |
virtual void | EndOfRunCleanup () |
Performs any necessary cleanup operations at the end of a run. | |
virtual void | DoCommand (char *cCommand, char *cArguments) |
If a behavior has registered a command line command with the sim manager, this allows it to be called. | |
Protected Member Functions | |
float | CalculateNCI (clTree *p_oTree, clTreePopulation *p_oPop, clAllometry *p_oAllom, clPlot *p_oPlot) |
Calculates the NCI value for a tree. | |
void | ValidateData () |
Makes sure all input data is valid. | |
void | GetTreeMemberCodes () |
Gets the return codes for needed tree data members. | |
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. | |
![]() | |
void | GetData (xercesc::DOMDocument *p_oDoc) |
Triggers all growth setup if an object is hooked. | |
Protected Attributes | |
short int ** | mp_iGrowthCodes |
Holds return data codes for the "Growth" tree data member. | |
short int * | mp_iWhatBehaviorTypes |
List of types managed by this behavior. | |
short int | m_iNumBehaviorTypes |
Number of types managed by this behavior. | |
float ** | mp_fLambda |
Lamba for NCI. | |
float * | mp_fAlpha |
Neighbor diam10 effect. | |
float * | mp_fBeta |
Neighbor distance effect. | |
float * | mp_fCrowdingSlope |
Crowding effect slope. | |
float * | mp_fCrowdingSteepness |
Crowding effect steepness. | |
float * | mp_fMinimumNeighborDiam10 |
The minimum Diam10, in cm, of neighbors to be included in NCI calculations. | |
float * | mp_fSizeEffectA |
Size effect "a" parameter. | |
float * | mp_fSizeEffectB |
Size effect "b" parameter. | |
float * | mp_fMaxGrowth |
Maximum growth, cm/yr. | |
float * | mp_fMaxCrowdingRadius |
Maximum search radius, in meters, in which to look for crowding neighbors. | |
float | m_fDiam10Divisor |
The value to divide diam10 by in NCI. | |
short int * | mp_iIndexes |
Speeds access to the arrays. | |
bool | m_bIncludeSnags |
Whether or not to include snags in NCI. | |
![]() | |
growthType | m_iGrowthMethod |
The method by which this object plans to update tree dimensions. | |
float | m_fConvertCmPerTSToMmPerYr |
Conversion factor from cm diameter growth per timestep to mm radial growth per year. | |
float | m_fConvertMmPerYearToCmPerTS |
Conversion factor to take amounts from mm of radial growth per year to cm of diameter growth per timestep. | |
bool | m_bHooked |
Wwhether or not this shell object is hooked to clGrowthOrg. | |
bool | m_bGoLast |
Whether or not this behavior's growth should go last when used with a complementary growth behavior. | |
![]() | |
short int | m_iNumSpeciesTypeCombos |
How many type/species combos a behavior will act on. | |
short int | m_iNumBehaviorSpecies |
How many distinct species are in the combo list - important for filling species-specific values from parameter file. | |
short int * | mp_iWhatSpecies |
List of distinct species - for filling species-specific values from parameter file. | |
stcSpeciesTypeCombo * | mp_whatSpeciesTypeCombos |
Array of species/type combos that the behavior will act on. | |
short int | m_iNewTreeInts |
The number of new tree integer data members this behavior wants to add. | |
short int | m_iNewTreeFloats |
The number of new tree float data members this behavior wants to add. | |
short int | m_iNewTreeChars |
The number of new tree character data members this behavior wants to add. | |
short int | m_iNewTreeBools |
The number of new tree boolean data members this behavior wants to add. | |
short int | m_iBehaviorListNumber |
The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. | |
float | m_fVersionNumber |
Version number - this will be rounded to 2 digits after the decimal place. | |
std::string | m_sXMLRoot |
XML root that encloses the parameters for this behavior. | |
float | m_fMinimumVersionNumber |
Minimum version number - this behavior will run parameter data for a file marked between this number and the current version number, inclusive. | |
![]() | |
char | m_cNameString [MAX_NAMESTRING_SIZE] |
Object's identifying namestring. | |
int * | mp_iAllowedFileTypes |
List of the input file types this object can handle. | |
int | m_iNumAllowedTypes |
Number of input file types this object can handle. | |
Additional Inherited Members | |
![]() | |
enum | growthType { diameter_auto, diameter_only, height_only } |
Values describing the method by which the object instance of this class plans to implement tree growth. More... | |
![]() | |
static clGrowthOrg * | mp_oGrowthOrg |
clGrowthOrg object - this pointer is held in common by all shells | |
NCI juvenile growth - Version 1.
This is a growth shell object which applies a variant on the NCI (neighborhood competition index) function designed for juvenile trees.
Growth per year is Growth = Max Growth * Size Effect * Crowding Effect. 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 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.
Size Effect = a * d10 ^ b, where d10 is diameter at 10 cm height. Crowding Effect = exp(-C * NCI ^ D). NCI is calculated with d10, not DBH, even for adults; the d10 - DBH conversion equation will be used with the sapling parameters.
This can only be applied to seedlings and saplings. An error will be thrown otherwise.
The parameter file call string for this to be diameter-incrementing with auto-height updating is "NCIJuvenileGrowth"; for diameter-only incrementing, use "NCIJuvenileGrowth diam only". The namestring for this behavior is "ncijuvenilegrowthshell".
Copyright 2011 Charles D. Canham.
Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)
clNCIJuvenileGrowth::clNCIJuvenileGrowth | ( | clSimManager * | p_oSimManager | ) |
Constructor.
p_oSimManager | Sim Manager object. |
clNCIJuvenileGrowth::~clNCIJuvenileGrowth | ( | ) |
Destructor.
|
protected |
Assembles a unique list of types applied to this behavior and places it in mp_iWhatBehaviorTypes.
|
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.
|
protected |
Calculates the NCI value for a tree.
p_oTree | Tree for which to calculate NCI. |
p_oPop | Tree population object. |
p_oAllom | Allometry object. |
p_oPlot | Plot object. |
|
virtual |
Does setup.
p_oDoc | DOM tree of parsed input tree. |
Reimplemented from clGrowthBase.
|
protected |
Gets the return codes for needed tree data members.
modelErr | if a code comes back -1 for any species/type combo to which this behavior is applied. |
|
virtual |
Calculates growth for all NCI trees.
The values are stashed in the "Growth" tree float data member for later application.
Steps:
This must be called first of any growth stuff, since it uses other trees' DBHs to calculate NCI, and these must be before growth has been applied.
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.
|
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 seedling. |
|
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.
|
protected |
Makes sure all input data is valid.
The following must all be true:
modelErr | if any of the above conditions are not met. |
|
protected |
Whether or not to include snags in NCI.
|
protected |
The value to divide diam10 by in NCI.
q in the NCI equation above. May be set to 1.
|
protected |
Number of types managed by this behavior.
|
protected |
Neighbor diam10 effect.
α variable in Crowding Effect equation. 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].
|
protected |
Neighbor distance effect.
β variable in Crowding Effect equation. 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].
|
protected |
Crowding effect slope.
C in Crowding Effect equation. 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].
|
protected |
Crowding effect steepness.
D in Crowding Effect equation. 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].
|
protected |
Lamba for NCI.
Array is sized number of behavior species by number of total species. This array is accessed by using the species number as an array index.
|
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].
|
protected |
Maximum growth, cm/yr.
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].
|
protected |
The minimum Diam10, in cm, of neighbors to be included in NCI calculations.
Array is sized total number of species.
|
protected |
Size effect "a" parameter.
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].
|
protected |
Size effect "b" parameter.
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].
|
protected |
Holds return data codes for the "Growth" tree data member.
Array size is number of species to which this behavior applies by 2 (seedlings and saplings).
|
protected |
Speeds access to the arrays.
Array size is is number of species.
|
protected |
List of types managed by this behavior.