Implements diameter growth according to a completely whacked-out scheme for Puerto Rico. More...

#include <PRSemiStochGrowth.h>

Inheritance diagram for clPRSemiStochGrowth:

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

	~clPRSemiStochGrowth ()
	Destructor. More...

float	CalcDiameterGrowthValue (clTree p_oTree, clTreePopulation p_oPop, float fHeightGrowth)
	Calculates the amount of diameter growth increase for a particular tree. 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	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...

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
double *	mp_fHeightThreshold
	Height threshold between deterministic and stochastic growth - in m - sized number of behavior species. More...

double *	mp_fA
	"a" parameter for deterministic growth - sized number of behavior species More...

double *	mp_fB
	"b" parameter for deterministic growth - sized number of behavior species More...

double *	mp_fMeanDiam
	Mean diameter (cm) for stochastic growth - sized number of behavior species. More...

double *	mp_fDiamStdDev
	Diameter standard deviation (cm) for stochastic growth - sized number of behavior species. More...

short int *	mp_iIndexes
	For accessing the other arrays. 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

Implements diameter growth according to a completely whacked-out scheme for Puerto Rico.

This was meant for palm growth, and palms are freaky. Not nice trees at all. This is merely for explanation for the insanity of this particular growth behavior. Of course it's no excuse but then again I don't make this stuff up.

Trees of less than a certain height get what is essentially an allometry shortcut: diameter is incremented in whatever direction is necessary to get it to match the outcome of an equation involving height. Trees above the height get a random diameter drawn from a normal distribution with a mean and standard deviation supplied by the user.

This can only increment diameter along with a HeightIncrementer - i.e. no diam-with-auto-height use.

For trees below the cutoff, their growth is figured as follows:

Y = (A * EXP (-B*Height)) - Diam

where

Y = diameter growth for the timestep, in cm
a = parameter
b = parameter
Height = tree height in cm
diam = diameter of the tree at which to apply growth (before growth), in cm

The name string is "prsemistochgrowthshell". The parameter file call string is "PRSemiStochastic diam only".

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clPRSemiStochGrowth()

clPRSemiStochGrowth::clPRSemiStochGrowth ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim manager for this run.

◆ ~clPRSemiStochGrowth()

clPRSemiStochGrowth::~clPRSemiStochGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcDiameterGrowthValue()

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

virtual

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

If the tree is less than the height cutoff for stochastic growth, the equation above is calculated. Otherwise, this returns the difference between the existing diameter and a randomly drawn diameter.

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.

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

Reimplemented from clGrowthBase.

◆ DoShellSetup()

void clPRSemiStochGrowth::DoShellSetup ( xercesc::DOMDocument * p_oDoc )

virtual

Does the setup for this behavior.

This reads in the parameters from the parameter file.

Parameters

p_oDoc Parsed parameter file.

Reimplemented from clGrowthBase.

Member Data Documentation

◆ mp_fA

double* clPRSemiStochGrowth::mp_fA

protected

"a" parameter for deterministic growth - sized number of behavior species

◆ mp_fB

double* clPRSemiStochGrowth::mp_fB

protected

"b" parameter for deterministic growth - sized number of behavior species

◆ mp_fDiamStdDev

double* clPRSemiStochGrowth::mp_fDiamStdDev

protected

Diameter standard deviation (cm) for stochastic growth - sized number of behavior species.

◆ mp_fHeightThreshold

double* clPRSemiStochGrowth::mp_fHeightThreshold

protected

Height threshold between deterministic and stochastic growth - in m - sized number of behavior species.

◆ mp_fMeanDiam

double* clPRSemiStochGrowth::mp_fMeanDiam

protected

Mean diameter (cm) for stochastic growth - sized number of behavior species.

◆ mp_iIndexes

short int* clPRSemiStochGrowth::mp_iIndexes

protected

For accessing the other arrays.

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

PRSemiStochGrowth.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clPRSemiStochGrowth()

◆ ~clPRSemiStochGrowth()

Member Function Documentation

◆ CalcDiameterGrowthValue()

◆ DoShellSetup()

Member Data Documentation

◆ mp_fA

◆ mp_fB

◆ mp_fDiamStdDev

◆ mp_fHeightThreshold

◆ mp_fMeanDiam

◆ mp_iIndexes