SORTIE Core C++ Documentation
Public Member Functions | List of all members
clConstantRadialGrowth Class Reference

Constant radial growth - Version 1.0. More...

#include <ConstantRadialGrowth.h>

Inheritance diagram for clConstantRadialGrowth:
clMichMenBase clGrowthBase clBehaviorBase clWorkerBase

Public Member Functions

 clConstantRadialGrowth (clSimManager *p_oSimManager)
 Constructor.
 
float CalcDiameterGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fHeightGrowth)
 This applies the growth.
 
void SetNameData (char *cNameString)
 Captures the namestring passed to this behavior.
 
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Reads in values from the parameter file.
 
- Public Member Functions inherited from clMichMenBase
 clMichMenBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clMichMenBase ()
 Destructor.
 
- Public Member Functions inherited from clGrowthBase
 clGrowthBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clGrowthBase ()
 Destructor.
 
void Action ()
 Performs all growth calculations if "hooked".
 
virtual float CalcHeightGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fDiameterGrowth)
 Calculates the amount of height growth increase for a particular tree, if applicable.
 
virtual void PreGrowthCalcs (clTreePopulation *p_oPop)
 Performs calculations before any DBHs have been changed.
 
growthType GetGrowthMethod ()
 Gets the method by which this behavior increments growth.
 
clGrowthOrgGetGrowthOrg ()
 Get the growth org object.
 
void RegisterTreeDataMembers ()
 Performs data member registrations for "Growth".
 
- Public Member Functions inherited from clBehaviorBase
virtual float GetBehaviorVersion ()
 Gets the behavior version number.
 
 clBehaviorBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clBehaviorBase ()
 Destructor.
 
virtual short int ValidateVersionNumber (float fTestVersion)
 Makes sure that the version number of a file passed is between the minimum and current version numbers.
 
virtual void SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
 Sets the species/type combos for a behavior.
 
virtual short int GetNewTreeInts ()
 Gets the number of new tree integer data members this behavior wants to register.
 
virtual short int GetNewTreeFloats ()
 Gets the number of new tree float data members this behavior wants to register.
 
virtual short int GetNewTreeChars ()
 Gets the number of new tree character data members this behavior wants to register.
 
virtual short int GetNewTreeBools ()
 Gets the number of new tree bool data members this behavior wants to register.
 
virtual short int GetNumSpeciesTypeCombos ()
 Gets the number of species/type combos to which this behavior applies.
 
virtual short int GetNumBehaviorSpecies ()
 Gets the number of unique tree species to which this behavior applies.
 
struct stcSpeciesTypeCombo GetSpeciesTypeCombo (short int iIndex)
 Gets one of this behavior's type/species combos.
 
virtual short int GetBehaviorSpecies (short int iIndex)
 Gets one of the behavior's species.
 
short int GetBehaviorListNumber ()
 Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list.
 
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.
 
virtual DOMElement * GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
 Formats the string for species/types query.
 
- Public Member Functions inherited from clWorkerBase
 clWorkerBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clWorkerBase ()
 Destructor.
 
char * GetName ()
 Gets the object's namestring.
 
void DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
 Triggers the setup process.
 
virtual void TimestepCleanup ()
 Performs any necessary cleanup operations at the end of a timestep.
 
virtual void EndOfRunCleanup ()
 Performs any necessary cleanup operations at the end of a run.
 
virtual void DoCommand (char *cCommand, char *cArguments)
 If a behavior has registered a command line command with the sim manager, this allows it to be called.
 

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.
 
float CalculateMichaelisMentonDiam (short int &iSpecies, float &fGli)
 Calculates the result of the Michaelis-Menton function using diameter growth parameters.
 
float CalculateMichaelisMentonHeight (short int &iSpecies, float &fGli)
 Calculates the result of the Michaelis-Menton function using height growth parameters.
 
float ApplyGrowthLimits (const short int &iSpecies, const float &fAmountDiamIncrease, const float &fDiam)
 Applies applicable growth limits according to the flags set.
 
float GetGrowthMemberValue (clTree *p_oTree, float fDiameterGrowth)
 Gets the proper value for the "Growth" data member for mortality calculations based on growth.
 
- Protected Attributes inherited from clMichMenBase
float * mp_fSlopeDiamGrowthResponse
 Slope of diameter growth response.
 
float * mp_fSlopeHeightGrowthResponse
 Slope of height growth response.
 
float * mp_fAdultConstBAInc
 Adult constant basal area increment in cm2/timestep (parameter file value is expected in cm2/yr).
 
float * mp_fAdultConstRadInc
 Adult constant radial increment in cm/timestep (parameter file value is expected in mm/yr).
 
float * mp_fAsympDiamGrowth
 Asymptotic diameter growth.
 
float * mp_fAsympHeightGrowth
 Asymptotic height growth.
 
bool m_bConstRadialLimited
 Whether or not growth is limited to constant radial increment.
 
bool m_bConstBasalAreaLimited
 Whether or not growth is limited to constant basal area increment.
 
- Static Protected Attributes inherited from clGrowthBase
static clGrowthOrgmp_oGrowthOrg
 clGrowthOrg object - this pointer is held in common by all shells
 

Detailed Description

Constant radial growth - Version 1.0.

This is a growth shell object which applies a constant radial growth to all trees which use it. The radial growth increment, which should have been converted to diameter increment in cm/timestep, is returned directly.

This class's namestring is "constradgrowthshell". The parameter file call string is "ConstRadialGrowth", for diameter growth with auto-height updating, or "ConstRadialGrowth diam only" for diameter-only growth.

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

clConstantRadialGrowth::clConstantRadialGrowth ( clSimManager p_oSimManager)

Constructor.

The constructor sets the namestring.

Parameters
p_oSimManagerSim Manager object.

Member Function Documentation

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

This applies the growth.

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

Reimplemented from clGrowthBase.

void clConstantRadialGrowth::DoShellSetup ( xercesc::DOMDocument *  p_oDoc)
virtual

Reads in values from the parameter file.

Parameters
p_oDocDOM tree from parsed parameter file.

Reimplemented from clGrowthBase.

void clConstantRadialGrowth::SetNameData ( char *  cNameString)
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
cNameStringBehavior's namestring.

Reimplemented from clBehaviorBase.


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