Increments growth according to a logistic equation. More...

#include <LogisticGrowth.h>

Inheritance diagram for clLogisticGrowth:

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

	~clLogisticGrowth ()
	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 logistic 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 logistic 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...

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 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 Member Functions
float	CalculateFunctionValue (clTree *p_oTree)
	Calculates the value of the logistic growth function. 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_fAsympGrowthAtFullLight
	Asymptotic growth at full light - a - sized number of behavior species. More...

double *	mp_fShape1
	Shape parameter 1 - b - sized number of behavior species. More...

double *	mp_fShape2
	Shape parameter 2 - c - sized number of behavior species. More...

short int *	mp_iIndexes
	For accessing the other arrays. More...

float	m_fConversionFactor
	Conversion factor to translate the results of the function to the appropriate units per timestep, depending on the type of growth behavior this is. 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...

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 growth according to a logistic equation.

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/(1 + e^{(b - c * GLI)})

where

Y = either radial growth in mm/year or height growth in cm/yr
a = asymptotic growth at full light
b and c are shape parameters
GLI is global light index, from 0 to 100

The name string is "logisticgrowthshell". In the parameter file: For diameter growth with no automatic height adjustment, call "LogisticGrowth diam only". For diameter growth with automatic height adjustment, call "LogisticGrowth". For height growth, call "LogisticGrowth height". XML root is "LogisticGrowth".

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clLogisticGrowth()

clLogisticGrowth::clLogisticGrowth ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

◆ ~clLogisticGrowth()

clLogisticGrowth::~clLogisticGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcDiameterGrowthValue()

float clLogisticGrowth::CalcDiameterGrowthValue	(	clTree *	p_oTree,
		clTreePopulation *	p_oPop,
		float	fHeightGrowth
	)

inlinevirtual

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

Parameters

p_oTree	Tree for which to calculate growth.
p_oPop	Tree population object, just in case it's needed.
fHeightGrowth	Amount of height growth, in m (ignored).

Returns: Amount, in cm, by which to increase the tree's diameter.

Reimplemented from clGrowthBase.

◆ CalcHeightGrowthValue()

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

inlinevirtual

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

Parameters

p_oTree	Tree for which to calculate growth.
p_oPop	Tree population object, just in case it's needed.
fDiameterGrowth	Amount 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 clLogisticGrowth::CalculateFunctionValue ( clTree * p_oTree )

protected

Calculates the value of the logistic growth function.

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

Parameters

p_oTree Tree for which to calculate growth. This is needed to get the GLI.

Returns: The value of the logistic growth function. Units depend on the type of growth that this is.

◆ DoShellSetup()

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

Exceptions

modelErr if any species/type combo to which this behavior is applied does not have a light behavior.

Reimplemented from clGrowthBase.

◆ SetNameData()

void clLogisticGrowth::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

sNameString Behavior's namestring.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ m_fConversionFactor

float clLogisticGrowth::m_fConversionFactor

protected

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

◆ mp_fAsympGrowthAtFullLight

double* clLogisticGrowth::mp_fAsympGrowthAtFullLight

protected

Asymptotic growth at full light - a - sized number of behavior species.

◆ mp_fShape1

double* clLogisticGrowth::mp_fShape1

protected

Shape parameter 1 - b - sized number of behavior species.

◆ mp_fShape2

double* clLogisticGrowth::mp_fShape2

protected

Shape parameter 2 - c - sized number of behavior species.

◆ mp_iIndexes

short int* clLogisticGrowth::mp_iIndexes

protected

For accessing the other arrays.

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

LogisticGrowth.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clLogisticGrowth()

◆ ~clLogisticGrowth()

Member Function Documentation

◆ CalcDiameterGrowthValue()

◆ CalcHeightGrowthValue()

◆ CalculateFunctionValue()

◆ DoShellSetup()

◆ SetNameData()

Member Data Documentation

◆ m_fConversionFactor

◆ mp_fAsympGrowthAtFullLight

◆ mp_fShape1

◆ mp_fShape2

◆ mp_iIndexes