SORTIE Core C++ Documentation
Public Member Functions | Protected Attributes | List of all members
clDoubleMMRelGrowth Class Reference

Double-resource relative growth - Version 1.0. More...

#include <DoubleMMRelGrowth.h>

Inheritance diagram for clDoubleMMRelGrowth:
clMichMenBase clGrowthBase clBehaviorBase clWorkerBase

Public Member Functions

 clDoubleMMRelGrowth (clSimManager *p_oSimManager)
 Constructor. More...
 
 ~clDoubleMMRelGrowth ()
 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 clMichMenBase
 clMichMenBase (clSimManager *p_oSimManager)
 Constructor. More...
 
virtual ~clMichMenBase ()
 Destructor. 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 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...
 
clGrowthOrgGetGrowthOrg ()
 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...
 
clSimManagerGetSimManager ()
 
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

clGridmp_oResourceGrid
 Grid containing the levels of the second resource. More...
 
double * mp_fResourceInfluence
 Parameter governing the influence of the second resource (C in equation above). More...
 
int m_iNumberYearsPerTimestep
 Number of years per timestep - from sim manager. More...
 
short int m_iResourceCode
 The float data member code for the resource grid. More...
 
- Protected Attributes inherited from clMichMenBase
double * mp_fSlopeDiamGrowthResponse
 Slope of diameter growth response. More...
 
double * mp_fSlopeHeightGrowthResponse
 Slope of height growth response. More...
 
double * mp_fAdultConstBAInc
 Adult constant basal area increment in cm2/timestep (parameter file value is expected in cm2/yr). More...
 
double * mp_fAdultConstRadInc
 Adult constant radial increment in cm/timestep (parameter file value is expected in mm/yr). More...
 
double * mp_fAsympDiamGrowth
 Asymptotic diameter growth. More...
 
double * mp_fAsympHeightGrowth
 Asymptotic height growth. More...
 
bool m_bConstRadialLimited
 Whether or not growth is limited to constant radial increment. More...
 
bool m_bConstBasalAreaLimited
 Whether or not growth is limited to constant basal area increment. 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...
 
stcSpeciesTypeCombomp_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...
 
clSimManagermp_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 clMichMenBase
void GetParameterFileData (xercesc::DOMDocument *p_oDoc)
 Extracts growth parameters. More...
 
float CalculateMichaelisMentonDiam (short int &iSpecies, float &fGli)
 Calculates the result of the Michaelis-Menton function using diameter growth parameters. More...
 
float CalculateMichaelisMentonHeight (short int &iSpecies, float &fGli)
 Calculates the result of the Michaelis-Menton function using height growth parameters. More...
 
float ApplyGrowthLimits (const short int &iSpecies, const float &fAmountDiamIncrease, const float &fDiam)
 Applies applicable growth limits according to the flags set. More...
 
float GetGrowthMemberValue (clTree *p_oTree, float fDiameterGrowth)
 Gets the proper value for the "Growth" data member for mortality calculations based on 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 clGrowthOrgmp_oGrowthOrg
 clGrowthOrg object - this pointer is held in common by all shells More...
 

Detailed Description

Double-resource relative growth - Version 1.0.

This is a growth shell object which applies a double Michaelis-Menton function to find relative growth as a function of light and some other resource.

The growth equation is:

Y = ((A + C*R) * GLI) / (((A + C*R)/S) + GLI)

where

To compound the growth over the number of years per timestep, the following equation is used:

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

where:

The identity of the second resource (R) in the Michaelis-Menton function is unimportant. It is assumed that the parameters will be scaled appropriately for the data range for whatever resource it is. The resource levels are obtained from a grid object called "Resource", with a single float data member called "Resource" which contains the level of the resource in question. If the grid is not present, this is considered a fatal error by this behavior.

To call this from the parameter file, use either "DoubleResourceRelative diam with auto height" (for diam with auto height growth) or "DoubleResourceRelative diam only" (for diam only growth).

The namestring for this class is "doublemmrelgrowthshell".

Copyright 2011 Charles D. Canham.

Author
Lora E. Murphy


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

Constructor & Destructor Documentation

◆ clDoubleMMRelGrowth()

clDoubleMMRelGrowth::clDoubleMMRelGrowth ( clSimManager p_oSimManager)

Constructor.

Sets the namestring.

Parameters
p_oSimManagerSim Manager object.

◆ ~clDoubleMMRelGrowth()

clDoubleMMRelGrowth::~clDoubleMMRelGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcDiameterGrowthValue()

float clDoubleMMRelGrowth::CalcDiameterGrowthValue ( clTree p_oTree,
clTreePopulation p_oPop,
float  fHeightGrowth 
)
virtual

Applies growth as described in the equation above.

Parameters
p_oTreeTree for which to calculate growth.
p_oPopTree population.
fHeightGrowthAmount of height growth, in m (ignored).
Returns
Amount of growth increase, in cm.

Reimplemented from clGrowthBase.

◆ DoShellSetup()

void clDoubleMMRelGrowth::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 "lgm" registered).

Parameters
p_oDocDOM tree of parsed input file.
Exceptions
modelErrif any species/type combo to which this behavior is applied does not have a light behavior, or if there is no grid called "Resource".

Reimplemented from clGrowthBase.

◆ SetNameData()

void clDoubleMMRelGrowth::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
sNameStringBehavior name from parameter file.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ m_iNumberYearsPerTimestep

int clDoubleMMRelGrowth::m_iNumberYearsPerTimestep
protected

Number of years per timestep - from sim manager.

◆ m_iResourceCode

short int clDoubleMMRelGrowth::m_iResourceCode
protected

The float data member code for the resource grid.

◆ mp_fResourceInfluence

double* clDoubleMMRelGrowth::mp_fResourceInfluence
protected

Parameter governing the influence of the second resource (C in equation above).

Array size is number of behavior species.

◆ mp_oResourceGrid

clGrid* clDoubleMMRelGrowth::mp_oResourceGrid
protected

Grid containing the levels of the second resource.

This is not created by this behavior; it is expected to already be available. It should be named "Resource" and have one float data member called "Resource".


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