|
| clNCIGrowth (clSimManager *p_oSimManager) |
| Constructor.
|
|
| ~clNCIGrowth () |
| 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.
|
|
|
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.
|
|
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.
|
|
NCI growth - Version 2.1.
This is a growth shell object which applies the NCI (neighborhood competition index) function as it is defined in clNCIBase.
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 is a generic behavior. It is expected that not all terms in the growth equation will be used. A user can turn off some of the terms by setting key parameters to 0 or 1. To be efficient, this behavior looks for this and has several alternate function forms to avoid extra math. It calls the correct function form through function pointers, which it sets during setup.
If any damage effect parameters are used, this behavior must be combined with the storm damage behaviors. If the shading effect is used, some light behavior must be used (and it really should be clSailLight, but this isn't enforced).
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 "NCIGrowth"; for diameter-only incrementing, use "NCIGrowth diam only". The namestring for this behavior is "ncigrowthshell". The XML string is "NCIGrowth".
Copyright 2011 Charles D. Canham.
- Author
- Lora E. Murphy
Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)