Increments height growth according to an equation originally developed for New Zealand seedling growth. More...

#include <MichMenNegGrowth.h>

Inheritance diagram for clMichMenNegGrowth:

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

	~clMichMenNegGrowth ()
	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 growth equation described ablove. More...

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Does setup. More...

void	RegisterTreeDataMembers ()
	Registers the float data member and captures the return codes. 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...

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
double *	mp_fAlpha
	alpha - sized number of behavior species More...

double *	mp_fBeta
	beta - sized number of behavior species More...

double *	mp_fPhi
	phi - sized number of behavior species More...

double *	mp_fGamma
	gamma - sized number of behavior species More...

double *	mp_fStdDev
	standard deviation of growth stochasticity in cm/year More...

double *	mp_fProbAutoCorr
	one year probability of autocorrelation More...

int *	mp_iIndexes
	To help access the other arrays. More...

short int **	mp_iAutoCorrCodes
	Return codes for the "autocorr" tree float data member variable. More...

int	m_iYearsPerTimestep
	Conversion factor to translate the results of the function to the appropriate units 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...

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 an equation originally developed for New Zealand seedling growth.

This behavior can only be used to create a height growth increment.

The equation used in this behavior is:

Y = (alpha;GLI) / (GLI + α/β) * H^φ - γ where

Y = height growth in cm/year
GLI = light level
α, β, φ, and γ = parameters
H = tree's height in cm

This is looped over the number of years per timestep, allowing H to increment at each intermediate year.

Growth has a stochastic component. The user provides a standard deviation for a normal distribution of mean zero and a draw on this distribution is added to the growth for each year. Growth can also be autocorrelated. Each species has a probability of autocorrelation from year to year and if a random draw triggers autocorrelation, the next year gets the same random additional growth factor as the previous year. This may mean multiple random draws per timestep in a multiyear timestep.

All trees must have the "Light" data member registered (i.e. must have a light behavior applied).

The name string is "michmenneggrowthshell". The parameter file call string is "MichaelisMentenNegativeGrowth height only". This creates a growth data member called "autocorr".

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clMichMenNegGrowth()

clMichMenNegGrowth::clMichMenNegGrowth ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

◆ ~clMichMenNegGrowth()

clMichMenNegGrowth::~clMichMenNegGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcHeightGrowthValue()

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

virtual

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

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 clMichMenNegGrowth::DoShellSetup ( xercesc::DOMDocument * p_oDoc )

virtual

Does setup.

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

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if any species/type combo to which this behavior is applied does not have a light behavior, or if beta = 0.

Reimplemented from clGrowthBase.

◆ RegisterTreeDataMembers()

void clMichMenNegGrowth::RegisterTreeDataMembers ( )

virtual

Registers the float data member and captures the return codes.

Reimplemented from clGrowthBase.

Member Data Documentation

◆ m_iYearsPerTimestep

int clMichMenNegGrowth::m_iYearsPerTimestep

protected

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

◆ mp_fAlpha

double* clMichMenNegGrowth::mp_fAlpha

protected

alpha - sized number of behavior species

◆ mp_fBeta

double* clMichMenNegGrowth::mp_fBeta

protected

beta - sized number of behavior species

◆ mp_fGamma

double* clMichMenNegGrowth::mp_fGamma

protected

gamma - sized number of behavior species

◆ mp_fPhi

double* clMichMenNegGrowth::mp_fPhi

protected

phi - sized number of behavior species

◆ mp_fProbAutoCorr

double* clMichMenNegGrowth::mp_fProbAutoCorr

protected

one year probability of autocorrelation

◆ mp_fStdDev

double* clMichMenNegGrowth::mp_fStdDev

protected

standard deviation of growth stochasticity in cm/year

◆ mp_iAutoCorrCodes

short int** clMichMenNegGrowth::mp_iAutoCorrCodes

protected

Return codes for the "autocorr" tree float data member variable.

Array of behavior species by type (even if not every type is represented).

◆ mp_iIndexes

int* clMichMenNegGrowth::mp_iIndexes

protected

To help access the other arrays.

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

MichMenNegGrowth.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clMichMenNegGrowth()

◆ ~clMichMenNegGrowth()

Member Function Documentation

◆ CalcHeightGrowthValue()

◆ DoShellSetup()

◆ RegisterTreeDataMembers()

Member Data Documentation

◆ m_iYearsPerTimestep

◆ mp_fAlpha

◆ mp_fBeta

◆ mp_fGamma

◆ mp_fPhi

◆ mp_fProbAutoCorr

◆ mp_fStdDev

◆ mp_iAutoCorrCodes

◆ mp_iIndexes