SORTIE Core C++ Documentation
Public Member Functions | Protected Attributes | List of all members
clLinearBiLevelGrowth Class Reference

Increments growth according to a simple linear equation, with the possibility of two sets of parameters for each species. More...

#include <LinearBiLevelGrowth.h>

Inheritance diagram for clLinearBiLevelGrowth:
clGrowthBase clBehaviorBase clWorkerBase

Public Member Functions

 clLinearBiLevelGrowth (clSimManager *p_oSimManager)
 Constructor. More...
 
 ~clLinearBiLevelGrowth ()
 Destructor. More...
 
float CalcDiameterGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fHeightGrowth)
 Calculates the amount of diameter growth increase for a particular tree using the linear growth equation. More...
 
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Does the setup for this behavior. More...
 
void SetNameData (std::string sNameString)
 Captures the namestring passed to this behavior. More...
 
- Public Member Functions inherited from clGrowthBase
 clGrowthBase (clSimManager *p_oSimManager)
 Constructor. More...
 
virtual ~clGrowthBase ()
 Destructor. More...
 
void Action ()
 Performs all growth calculations if "hooked". More...
 
virtual float CalcHeightGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fDiameterGrowth)
 Calculates the amount of height growth increase for a particular tree, if applicable. More...
 
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. More...
 
virtual void PreGrowthCalcs (clTreePopulation *p_oPop)
 Performs calculations before any DBHs have been changed. More...
 
growthType GetGrowthMethod ()
 Gets the method by which this behavior increments growth. More...
 
clGrowthOrgGetGrowthOrg ()
 Get the growth org object. More...
 
void RegisterTreeDataMembers ()
 Performs data member registrations for "Growth". More...
 
- Public Member Functions inherited from clBehaviorBase
virtual float GetBehaviorVersion ()
 Gets the behavior version number. More...
 
 clBehaviorBase (clSimManager *p_oSimManager)
 Constructor. More...
 
virtual ~clBehaviorBase ()
 Destructor. More...
 
virtual short int ValidateVersionNumber (float fTestVersion)
 Makes sure that the version number of a file passed is between the minimum and current version numbers. More...
 
virtual void SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
 Sets the species/type combos for a behavior. More...
 
virtual short int GetNewTreeInts ()
 Gets the number of new tree integer data members this behavior wants to register. More...
 
virtual short int GetNewTreeFloats ()
 Gets the number of new tree float data members this behavior wants to register. More...
 
virtual short int GetNewTreeChars ()
 Gets the number of new tree character data members this behavior wants to register. More...
 
virtual short int GetNewTreeBools ()
 Gets the number of new tree bool data members this behavior wants to register. More...
 
virtual short int GetNumSpeciesTypeCombos ()
 Gets the number of species/type combos to which this behavior applies. More...
 
virtual short int GetNumBehaviorSpecies ()
 Gets the number of unique tree species to which this behavior applies. More...
 
struct stcSpeciesTypeCombo GetSpeciesTypeCombo (short int iIndex)
 Gets one of this behavior's type/species combos. More...
 
virtual short int GetBehaviorSpecies (short int iIndex)
 Gets one of the behavior's species. More...
 
short int GetBehaviorListNumber ()
 Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...
 
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. More...
 
std::string FormatSpeciesTypeQueryString ()
 Formats the string for species/types query. More...
 
virtual DOMElement * GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
 This will get the correct set of parameters for this behavior based on the behavior list position number. More...
 
- Public Member Functions inherited from clWorkerBase
 clWorkerBase (clSimManager *p_oSimManager)
 Constructor. More...
 
virtual ~clWorkerBase ()
 Destructor. More...
 
std::string GetName ()
 Gets the object's namestring. More...
 
clSimManagerGetSimManager ()
 
void DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
 Triggers the setup process. More...
 
virtual void TimestepCleanup ()
 Performs any necessary cleanup operations at the end of a timestep. More...
 
virtual void EndOfRunCleanup ()
 Performs any necessary cleanup operations at the end of a run. More...
 

Protected Attributes

clGridmp_oStormLight
 "Storm Light" grid object More...
 
double * mp_fLoLightSlope
 Slope of growth equation in low light - b - sized number of behavior species. More...
 
double * mp_fLoLightIntercept
 Intercept of growth equation in low light - a - sized number of behavior species. More...
 
double * mp_fHiLightSlope
 Slope of growth equation in high light - b - sized number of behavior species. More...
 
double * mp_fHiLightIntercept
 Intercept of growth equation in high light - a - sized number of behavior species. More...
 
double * mp_fHiLightThreshold
 Threshold between low light and high light growth, as a value between 0 and 100 - sized number of behavior species. More...
 
int * mp_iIndexes
 To help access the other arrays. More...
 
int m_iYearsPerTimestep
 Conversion factor to translate the results of the function to the appropriate units per timestep. More...
 
int m_iLightCode
 Code for the "Light" data member of the "Storm Light" grid. More...
 
- Protected Attributes inherited from clGrowthBase
growthType m_iGrowthMethod
 The method by which this object plans to update tree dimensions. More...
 
float m_fConvertCmPerTSToMmPerYr
 Conversion factor from cm diameter growth per timestep to mm radial growth per year. More...
 
float m_fConvertMmPerYearToCmPerTS
 Conversion factor to take amounts from mm of radial growth per year to cm of diameter growth per timestep. More...
 
bool m_bHooked
 Wwhether or not this shell object is hooked to clGrowthOrg. More...
 
bool m_bGoLast
 Whether or not this behavior's growth should go last when used with a complementary growth behavior. More...
 
- Protected Attributes inherited from clBehaviorBase
short int m_iNumSpeciesTypeCombos
 How many type/species combos a behavior will act on. More...
 
short int m_iNumBehaviorSpecies
 How many distinct species are in the combo list - important for filling species-specific values from parameter file. More...
 
short int * mp_iWhatSpecies
 List of distinct species - for filling species-specific values from parameter file. More...
 
stcSpeciesTypeCombomp_whatSpeciesTypeCombos
 Array of species/type combos that the behavior will act on. More...
 
short int m_iNewTreeInts
 The number of new tree integer data members this behavior wants to add. More...
 
short int m_iNewTreeFloats
 The number of new tree float data members this behavior wants to add. More...
 
short int m_iNewTreeChars
 The number of new tree character data members this behavior wants to add. More...
 
short int m_iNewTreeBools
 The number of new tree boolean data members this behavior wants to add. More...
 
short int m_iBehaviorListNumber
 The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. More...
 
float m_fVersionNumber
 Version number - this will be rounded to 2 digits after the decimal place. More...
 
std::string m_sXMLRoot
 XML root that encloses the parameters for this behavior. More...
 
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. More...
 
- Protected Attributes inherited from clWorkerBase
std::string m_sNameString
 If a behavior has registered a command line command with the sim manager, this allows it to be called. More...
 
clSimManagermp_oSimManager
 Pointer to the simulation manager object. More...
 
int * mp_iAllowedFileTypes
 List of the input file types this object can handle. More...
 
int m_iNumAllowedTypes
 Number of input file types this object can handle. More...
 

Additional Inherited Members

- Public Types inherited from clGrowthBase
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...
 
- Protected Member Functions inherited from clGrowthBase
void GetData (xercesc::DOMDocument *p_oDoc)
 Triggers all growth setup if an object is hooked. More...
 
- Protected Member Functions inherited from clWorkerBase
void AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
 Creates the proper identifying filecode for an XML file. More...
 
- Static Protected Attributes inherited from clGrowthBase
static clGrowthOrgmp_oGrowthOrg
 clGrowthOrg object - this pointer is held in common by all shells More...
 

Detailed Description

Increments growth according to a simple linear equation, with the possibility of two sets of parameters for each species.

The two sets of parameters can be used for two different growth rates at high and low light. This behavior can be used to create a growth increment with no automatic height adjustment or a growth increment with automatic height adjustment.

The equation used in this behavior is:

Y = a + b * diam

where

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.

The name string is "linearbilevelgrowthshell". In the parameter file: For diameter growth with no automatic height adjustment, call "LinearBilevelGrowth diam only". For diameter growth with automatic height adjustment, call "LinearBilevelGrowth".

Copyright 2011 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)

Constructor & Destructor Documentation

◆ clLinearBiLevelGrowth()

clLinearBiLevelGrowth::clLinearBiLevelGrowth ( clSimManager p_oSimManager)

Constructor.

Sets the namestring.

◆ ~clLinearBiLevelGrowth()

clLinearBiLevelGrowth::~clLinearBiLevelGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcDiameterGrowthValue()

float clLinearBiLevelGrowth::CalcDiameterGrowthValue ( clTree p_oTree,
clTreePopulation p_oPop,
float  fHeightGrowth 
)
virtual

Calculates the amount of diameter growth increase for a particular tree using the linear growth 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.

Parameters
p_oTreeTree for which to calculate growth.
p_oPopTree population object, just in case it's needed.
fHeightGrowthAmount of height growth, in m (ignored).
Returns
Amount, in cm, by which to increase the tree's diameter.

Reimplemented from clGrowthBase.

◆ DoShellSetup()

void clLinearBiLevelGrowth::DoShellSetup ( xercesc::DOMDocument *  p_oDoc)
virtual

Does the setup for this behavior.

This reads in the parameters from the parameter file, and retrieves the "Storm Light" grid if present.

Parameters
p_oDocParsed parameter file.
Exceptions
modelErrif the high-light growth threshold is not between 0 and 100.

Reimplemented from clGrowthBase.

◆ SetNameData()

void clLinearBiLevelGrowth::SetNameData ( std::string  sNameString)
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.

Parameters
sNameStringBehavior's namestring.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ m_iLightCode

int clLinearBiLevelGrowth::m_iLightCode
protected

Code for the "Light" data member of the "Storm Light" grid.

◆ m_iYearsPerTimestep

int clLinearBiLevelGrowth::m_iYearsPerTimestep
protected

Conversion factor to translate the results of the function to the appropriate units per timestep.

◆ mp_fHiLightIntercept

double* clLinearBiLevelGrowth::mp_fHiLightIntercept
protected

Intercept of growth equation in high light - a - sized number of behavior species.

◆ mp_fHiLightSlope

double* clLinearBiLevelGrowth::mp_fHiLightSlope
protected

Slope of growth equation in high light - b - sized number of behavior species.

◆ mp_fHiLightThreshold

double* clLinearBiLevelGrowth::mp_fHiLightThreshold
protected

Threshold between low light and high light growth, as a value between 0 and 100 - sized number of behavior species.

◆ mp_fLoLightIntercept

double* clLinearBiLevelGrowth::mp_fLoLightIntercept
protected

Intercept of growth equation in low light - a - sized number of behavior species.

◆ mp_fLoLightSlope

double* clLinearBiLevelGrowth::mp_fLoLightSlope
protected

Slope of growth equation in low light - b - sized number of behavior species.

◆ mp_iIndexes

int* clLinearBiLevelGrowth::mp_iIndexes
protected

To help access the other arrays.

◆ mp_oStormLight

clGrid* clLinearBiLevelGrowth::mp_oStormLight
protected

"Storm Light" grid object


The documentation for this class was generated from the following file: