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

Increments growth according to a linear equation with exponential reduction for shade. More...

#include <ShadedLinearGrowth.h>

Inheritance diagram for clShadedLinearGrowth:
clGrowthBase clBehaviorBase clWorkerBase

Public Member Functions

 clShadedLinearGrowth (clSimManager *p_oSimManager)
 Constructor. More...
 
 ~clShadedLinearGrowth ()
 Destructor. More...
 
float CalcHeightGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fDiameterGrowth)
 Calculates the amount of height growth increase for a particular tree using the shaded linear growth equation. More...
 
float CalcDiameterGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fHeightGrowth)
 Calculates the amount of diameter growth increase for a particular tree using the shaded 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 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 Member Functions

float CalculateFunctionValue (int iSpecies, float fGLI, float fDiam)
 Calculates the value of the shaded linear growth function for one increment. 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...
 

Protected Attributes

double * mp_fSlope
 Growth slope - b - sized number of behavior species. More...
 
double * mp_fIntercept
 Growth intercept - a - sized number of behavior species. More...
 
double * mp_fShader
 Shading effect - c - sized number of behavior species. More...
 
short int * mp_iIndexes
 For accessing the other arrays. More...
 
double m_fConversionFactor
 Conversion factor to translate the results of the function to the appropriate units, depending on the type of growth behavior this is. More...
 
int m_iNumberOfYearsPerTimestep
 Number of years per timestep. 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...
 
- 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 linear equation with exponential reduction for shade.

This can be used to create a growth increment with no automatic height adjustment, a growth increment with automatic height adjustment, or a height increment.

The equation used in this behavior is:

Y = (a + b * diam)*(GLI/100)c

where

This behavior compounds this result for multi-year timesteps. In the case of diameter growth, a copy of the diameter value is incremented X times (with X being the number of years per timestep) and the final increment is the sum of all the interim increments. In the case of height growth, the amount of diameter growth is divided by X and this value used to increment height X times, with the nth diameter (n = 1 to X) being the original diameter plus (n * diameter growth / X).

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

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

◆ clShadedLinearGrowth()

clShadedLinearGrowth::clShadedLinearGrowth ( clSimManager p_oSimManager)

Constructor.

Sets the namestring.

◆ ~clShadedLinearGrowth()

clShadedLinearGrowth::~clShadedLinearGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcDiameterGrowthValue()

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

Calculates the amount of diameter growth increase for a particular tree using the shaded linear growth equation.

The function value is calculated for each year of the timestep by repeatedly incrementing a copy of the diameter (the tree's actual diameter remains untouched, as it is supposed to). The final increment is the sum of all the intermediate increments.

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.

◆ CalcHeightGrowthValue()

float clShadedLinearGrowth::CalcHeightGrowthValue ( clTree p_oTree,
clTreePopulation p_oPop,
float  fDiameterGrowth 
)
virtual

Calculates the amount of height growth increase for a particular tree using the shaded linear growth equation.

The function value is calculated for each year of the timestep by using the original diameter plus fDiameterGrowth divided by the years per timestep times the loop counter for the year being compounded. The final increment is the sum of all the intermediate increments.

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

Reimplemented from clGrowthBase.

◆ CalculateFunctionValue()

float clShadedLinearGrowth::CalculateFunctionValue ( int  iSpecies,
float  fGLI,
float  fDiam 
)
inlineprotected

Calculates the value of the shaded linear growth function for one increment.

The meaning of what is returned depends on the type of growth the behavior is doing.

Parameters
iSpeciesTree species.
fGLIThe GLI value.
fDiamThe diameter for which to calculate this increment.
Returns
The value of the shaded linear growth function. Units depend on the type of growth that this is.

◆ DoShellSetup()

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

Does the setup for this behavior.

This reads in the parameters from the parameter file, and validates that all species/type combos use light (each must have "Light" registered).

Parameters
p_oDocParsed parameter file.
Exceptions
modelErrif any species/type combo to which this behavior is applied does not have a light behavior.

Reimplemented from clGrowthBase.

◆ SetNameData()

void clShadedLinearGrowth::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_fConversionFactor

double clShadedLinearGrowth::m_fConversionFactor
protected

Conversion factor to translate the results of the function to the appropriate units, depending on the type of growth behavior this is.

◆ m_iNumberOfYearsPerTimestep

int clShadedLinearGrowth::m_iNumberOfYearsPerTimestep
protected

Number of years per timestep.

◆ mp_fIntercept

double* clShadedLinearGrowth::mp_fIntercept
protected

Growth intercept - a - sized number of behavior species.

◆ mp_fShader

double* clShadedLinearGrowth::mp_fShader
protected

Shading effect - c - sized number of behavior species.

◆ mp_fSlope

double* clShadedLinearGrowth::mp_fSlope
protected

Growth slope - b - sized number of behavior species.

◆ mp_iIndexes

short int* clShadedLinearGrowth::mp_iIndexes
protected

For accessing the other arrays.


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