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

#include <LogBiLevelGrowth.h>

Inheritance diagram for clLogBiLevelGrowth:

Public Member Functions
	clLogBiLevelGrowth (clSimManager *p_oSimManager)
	Constructor. More...

	~clLogBiLevelGrowth ()
	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 lognormal growth equation. More...

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Does the setup for 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	CalcDiameterGrowthValue (clTree p_oTree, clTreePopulation p_oPop, float fHeightGrowth)
	Calculates the amount of diameter 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...

clGrowthOrg *	GetGrowthOrg ()
	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 void	SetNameData (std::string sNameString)
	Sets the string for the parameter file 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...

clSimManager *	GetSimManager ()

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
clGrid *	mp_oStormLight
	"Storm Light" grid object More...

double *	mp_fLoLightMaxGrowth
	Max growth, in m, in low light - sized number of behavior species. More...

double *	mp_fLoLightX0
	X0 in low light - sized number of behavior species. More...

double *	mp_fLoLightXb
	Xb in low light - sized number of behavior species. More...

double *	mp_fHiLightMaxGrowth
	Max growth, in m, in high light - sized number of behavior species. More...

double *	mp_fHiLightX0
	X0 in high light - sized number of behavior species. More...

double *	mp_fHiLightXb
	Xb in high light - 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...

stcSpeciesTypeCombo *	mp_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...

clSimManager *	mp_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 clGrowthOrg *	mp_oGrowthOrg
	clGrowthOrg object - this pointer is held in common by all shells More...

Detailed Description

Increments height growth according to a lognormal 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 only be used to create a height growth increment.

The equation used in this behavior is:

Y = MG * exp(0.5 * (ln(H/X₀)/X_b)²)

where

Y = height growth in m/year
MG = max growth
X₀ = parameter
X_b = parameter
H = tree's height in m

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 "logbilevelgrowthshell". The parameter file call string is "LogBilevelGrowth height only".

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clLogBiLevelGrowth()

clLogBiLevelGrowth::clLogBiLevelGrowth ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

◆ ~clLogBiLevelGrowth()

clLogBiLevelGrowth::~clLogBiLevelGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcHeightGrowthValue()

float clLogBiLevelGrowth::CalcHeightGrowthValue	(	clTree *	p_oTree,
		clTreePopulation *	p_oPop,
		float	fDiameterGrowth
	)

virtual

Calculates the amount of height growth increase for a particular tree using the lognormal 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_oTree	Tree for which to calculate growth.
p_oPop	Tree population object, just in case it's needed.
fDiameterGrowth	Diameter growth, in cm.

Returns: Amount, in m, by which to increase the tree's height.

Reimplemented from clGrowthBase.

◆ DoShellSetup()

void clLogBiLevelGrowth::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_oDoc Parsed parameter file.

Exceptions

modelErr

if:

the high-light growth threshold is not between 0 and 100
a value for an X_b is 0
a value for an X₀ is 0
a value for max growth is less than 0

Reimplemented from clGrowthBase.

Member Data Documentation

◆ m_iLightCode

int clLogBiLevelGrowth::m_iLightCode

protected

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

◆ m_iYearsPerTimestep

int clLogBiLevelGrowth::m_iYearsPerTimestep

protected

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

◆ mp_fHiLightMaxGrowth

double* clLogBiLevelGrowth::mp_fHiLightMaxGrowth

protected

Max growth, in m, in high light - sized number of behavior species.

◆ mp_fHiLightThreshold

double* clLogBiLevelGrowth::mp_fHiLightThreshold

protected

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

◆ mp_fHiLightX0

double* clLogBiLevelGrowth::mp_fHiLightX0

protected

X0 in high light - sized number of behavior species.

◆ mp_fHiLightXb

double* clLogBiLevelGrowth::mp_fHiLightXb

protected

Xb in high light - sized number of behavior species.

◆ mp_fLoLightMaxGrowth

double* clLogBiLevelGrowth::mp_fLoLightMaxGrowth

protected

Max growth, in m, in low light - sized number of behavior species.

◆ mp_fLoLightX0

double* clLogBiLevelGrowth::mp_fLoLightX0

protected

X0 in low light - sized number of behavior species.

◆ mp_fLoLightXb

double* clLogBiLevelGrowth::mp_fLoLightXb

protected

Xb in low light - sized number of behavior species.

◆ mp_iIndexes

int* clLogBiLevelGrowth::mp_iIndexes

protected

To help access the other arrays.

◆ mp_oStormLight

clGrid* clLogBiLevelGrowth::mp_oStormLight

protected

"Storm Light" grid object

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

LogBiLevelGrowth.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clLogBiLevelGrowth()

◆ ~clLogBiLevelGrowth()

Member Function Documentation

◆ CalcHeightGrowthValue()

◆ DoShellSetup()

Member Data Documentation

◆ m_iLightCode

◆ m_iYearsPerTimestep

◆ mp_fHiLightMaxGrowth

◆ mp_fHiLightThreshold

◆ mp_fHiLightX0

◆ mp_fHiLightXb

◆ mp_fLoLightMaxGrowth

◆ mp_fLoLightX0

◆ mp_fLoLightXb

◆ mp_iIndexes

◆ mp_oStormLight