Browsed relative Michaelis-Menton growth - Version 1.0. More...

#include <BrowsedRelativeGrowth.h>

Inheritance diagram for clBrowsedRelativeGrowth:

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

	~clBrowsedRelativeGrowth ()
	Destructor. More...

float	CalcDiameterGrowthValue (clTree p_oTree, clTreePopulation p_oPop, float fHeightGrowth)
	Applies growth as described in the equation above. More...

void	SetNameData (std::string sNameString)
	Captures the behavior name passed from the parameter file. More...

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Does setup. 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 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_fUnbrowsedS
	Slope of growth response, unbrowsed. More...

double *	mp_fBrowsedS
	Slope of growth response, browsed. More...

double *	mp_fUnbrowsedA
	Asymptotic diameter growth, unbrowsed. More...

double *	mp_fBrowsedA
	Asymptotic diameter growth, browsed. More...

double *	mp_fUnbrowsedDiamExp
	Diameter exponent, unbrowsed. More...

double *	mp_fBrowsedDiamExp
	Diameter exponent, browsed. More...

short int **	mp_iLightCodes
	Codes for "Light" data member. More...

short int **	mp_iBrowsedCodes
	Codes for "Browsed" data member. More...

int	m_ifNumberYearsPerTimestep
	Number of years per timestep - from sim manager. More...

short int	m_iNumSpecies
	Number of species. 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

Browsed relative Michaelis-Menton growth - Version 1.0.

This is a growth shell object which applies the Michaelis-Menton function to find relative growth. There are two growth rates: one for browsed, and one for unbrowsed.

Browsedness is determined by the Random Browse behavior (class clRandomBrowse). This class expects that behavior to be enabled and the "Browsed" bool data member to be present for all trees to which this behavior is applied.

The growth equation is:

Y = (A * gli) / ((A/S) + gli)

where Y is the relative annual radial growth, A is asymptotic diameter growth, gli is the amount of light, and S is the slope of growth response.

The actual amount of new growth is:

G = ((Y + 1)^T - 1) * diam^Q

where Y is from the equation above, T is the number of years per timestep, diam is the tree's diameter, and Q is the diameter exponent.

(There are some strangenesses in the math - 1s are added and subtracted at various times and I don't know why. This is based on code I didn't originally write.)

The namestring for this class is "browsedrelgrowthshell". Call in the parameter file via "BrowsedRelativeGrowth" or "BrowsedRelativeGrowth diam only".

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clBrowsedRelativeGrowth()

clBrowsedRelativeGrowth::clBrowsedRelativeGrowth ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim Manager object.

◆ ~clBrowsedRelativeGrowth()

clBrowsedRelativeGrowth::~clBrowsedRelativeGrowth ( )

Destructor.

Member Function Documentation

◆ CalcDiameterGrowthValue()

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

virtual

Applies growth as described in the equation above.

Parameters

p_oTree	Tree for which to calculate growth.
p_oPop	Tree population.
fHeightGrowth	Amount of height growth, in m (ignored).

Returns: Amount of growth increase, in cm.

Reimplemented from clGrowthBase.

◆ DoShellSetup()

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

virtual

Does setup.

Reads in values from the parameter file,, and validates that all species/type combos use light and browse.

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 the browse behavior.

Reimplemented from clGrowthBase.

◆ SetNameData()

void clBrowsedRelativeGrowth::SetNameData ( std::string sNameString )

virtual

Captures the behavior name passed from the parameter file.

This is useful since this class can produce a few different kinds of behaviors.

Parameters

sNameString Behavior name from parameter file.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ m_ifNumberYearsPerTimestep

int clBrowsedRelativeGrowth::m_ifNumberYearsPerTimestep

protected

Number of years per timestep - from sim manager.

◆ m_iNumSpecies

short int clBrowsedRelativeGrowth::m_iNumSpecies

protected

Number of species.

For destructor.

◆ mp_fBrowsedA

double* clBrowsedRelativeGrowth::mp_fBrowsedA

protected

Asymptotic diameter growth, browsed.

Array size is number of species.

◆ mp_fBrowsedDiamExp

double* clBrowsedRelativeGrowth::mp_fBrowsedDiamExp

protected

Diameter exponent, browsed.

Array size is number of species

◆ mp_fBrowsedS

double* clBrowsedRelativeGrowth::mp_fBrowsedS

protected

Slope of growth response, browsed.

Array size is number of species.

◆ mp_fUnbrowsedA

double* clBrowsedRelativeGrowth::mp_fUnbrowsedA

protected

Asymptotic diameter growth, unbrowsed.

Array size is number of species.

◆ mp_fUnbrowsedDiamExp

double* clBrowsedRelativeGrowth::mp_fUnbrowsedDiamExp

protected

Diameter exponent, unbrowsed.

Array size is number of species

◆ mp_fUnbrowsedS

double* clBrowsedRelativeGrowth::mp_fUnbrowsedS

protected

Slope of growth response, unbrowsed.

Array size is number of species.

◆ mp_iBrowsedCodes

short int** clBrowsedRelativeGrowth::mp_iBrowsedCodes

protected

Codes for "Browsed" data member.

Array size is number of species by number of types.

◆ mp_iLightCodes

short int** clBrowsedRelativeGrowth::mp_iLightCodes

protected

Codes for "Light" data member.

Array size is number of species by number of types.

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

BrowsedRelativeGrowth.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clBrowsedRelativeGrowth()

◆ ~clBrowsedRelativeGrowth()

Member Function Documentation

◆ CalcDiameterGrowthValue()

◆ DoShellSetup()

◆ SetNameData()

Member Data Documentation

◆ m_ifNumberYearsPerTimestep

◆ m_iNumSpecies

◆ mp_fBrowsedA

◆ mp_fBrowsedDiamExp

◆ mp_fBrowsedS

◆ mp_fUnbrowsedA

◆ mp_fUnbrowsedDiamExp

◆ mp_fUnbrowsedS

◆ mp_iBrowsedCodes

◆ mp_iLightCodes