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

Weibull Climate growth - Version 1.0. More...

#include <WeibullClimateQuadratGrowth.h>

Inheritance diagram for clWeibullClimateQuadratGrowth:
clGrowthBase clBehaviorBase clWorkerBase

Public Member Functions

 clWeibullClimateQuadratGrowth (clSimManager *p_oSimManager)
 Constructor.
 
 ~clWeibullClimateQuadratGrowth ()
 Destructor.
 
float CalcDiameterGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fHeightGrowth)
 Queries the grid for the growth value for this tree's cell that was calculated by PreGrowthCalcs() and returns it.
 
void PreGrowthCalcs (clTreePopulation *p_oPop)
 Calculates growth.
 
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Does setup.
 
void SetNameData (char *cNameString)
 Captures the namestring passed to this behavior.
 
- 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 float GetGrowthMemberValue (clTree *p_oTree, float fDiameterGrowth)
 Calculates the value to go into a tree's "Growth" data member as the amount of growth.
 
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.
 

Protected Member Functions

void ValidateData (clTreePopulation *p_oPop)
 Makes sure all input data is valid.
 
void ReadParameterFile (xercesc::DOMDocument *p_oDoc, clTreePopulation *p_oPop)
 Reads data from the parameter file.
 
int GetNumNeighbors (float &fX, float &fY, clTreePopulation *p_oPop)
 Counts the number of trees a target's neighborhood that have a DBH bigger than the minimum cutoff.
 
void FormatQuery (clTreePopulation *p_oPop)
 Populates m_cQuery with the query for getting target trees.
 
void SetupGrid (clTreePopulation *p_oPop)
 Sets up the "Weibull Climate Quadrat Growth" grid.
 
- Protected Member Functions inherited from clGrowthBase
void GetData (xercesc::DOMDocument *p_oDoc)
 Triggers all growth setup if an object is hooked.
 

Protected Attributes

clGridmp_oGrid
 Grid holding amount of growth for each species.
 
float * mp_fCompC
 Competition effect C.
 
float * mp_fCompD
 Competition effect D.
 
float * mp_fMinimumNeighborDBH
 The minimum DBH, in cm, of neighbors to be included in the neighbor count.
 
float * mp_fPrecipA
 Precipitation effect A.
 
float * mp_fPrecipB
 Precipitation effect B.
 
float * mp_fPrecipC
 Precipitation effect C.
 
float * mp_fTempA
 Temperature effect A.
 
float * mp_fTempB
 Temperature effect B.
 
float * mp_fTempC
 Temperature effect C.
 
float * mp_fMaxRG
 Maximum potential growth value, in cm.
 
short int * mp_iIndexes
 Speeds access to the arrays.
 
short int * mp_iGridGrowthCodes
 Holds data member codes for the "growth_x" data members of the "Weibull Climate Quadrat Growth" grid.
 
char * m_cQuery
 Query string to get target trees.
 
float m_fMinSaplingHeight
 Minimum sapling height.
 
float m_fMaxCrowdingRadius
 Maximum search radius, in meters, in which to look for crowding neighbors.
 
short int m_iNumNeighCode
 Return code for the "num_neigh" grid data member.
 
- Protected Attributes inherited from clGrowthBase
growthType m_iGrowthMethod
 The method by which this object plans to update tree dimensions.
 
float m_fConvertCmPerTSToMmPerYr
 Conversion factor from cm diameter growth per timestep to mm radial growth per year.
 
float m_fConvertMmPerYearToCmPerTS
 Conversion factor to take amounts from mm of radial growth per year to cm of diameter growth per timestep.
 
bool m_bHooked
 Wwhether or not this shell object is hooked to clGrowthOrg.
 
bool m_bGoLast
 Whether or not this behavior's growth should go last when used with a complementary growth behavior.
 
- Protected Attributes inherited from clBehaviorBase
short int m_iNumSpeciesTypeCombos
 How many type/species combos a behavior will act on.
 
short int m_iNumBehaviorSpecies
 How many distinct species are in the combo list - important for filling species-specific values from parameter file.
 
short int * mp_iWhatSpecies
 List of distinct species - for filling species-specific values from parameter file.
 
stcSpeciesTypeCombomp_whatSpeciesTypeCombos
 Array of species/type combos that the behavior will act on.
 
short int m_iNewTreeInts
 The number of new tree integer data members this behavior wants to add.
 
short int m_iNewTreeFloats
 The number of new tree float data members this behavior wants to add.
 
short int m_iNewTreeChars
 The number of new tree character data members this behavior wants to add.
 
short int m_iNewTreeBools
 The number of new tree boolean data members this behavior wants to add.
 
short int m_iBehaviorListNumber
 The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior.
 
float m_fVersionNumber
 Version number - this will be rounded to 2 digits after the decimal place.
 
std::string m_sXMLRoot
 XML root that encloses the parameters for this behavior.
 
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.
 
- Protected Attributes inherited from clWorkerBase
char m_cNameString [MAX_NAMESTRING_SIZE]
 Object's identifying namestring.
 
int * mp_iAllowedFileTypes
 List of the input file types this object can handle.
 
int m_iNumAllowedTypes
 Number of input file types this object can handle.
 

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...
 
- Static Protected Attributes inherited from clGrowthBase
static clGrowthOrgmp_oGrowthOrg
 clGrowthOrg object - this pointer is held in common by all shells
 

Detailed Description

Weibull Climate growth - Version 1.0.

This is a growth shell object which calculates growth as a function of climate and neighbor density. This simplifies the process by calculating annual growth on a per quadrat basis.

The growth equation for one year's growth is:

Growth = Max Growth * Precipitation Effect * Climate Effect * Competition Effect


where Max Growth is annual amount of diameter growth, and the Effects are values between 0 and 1 which serve to reduce the maximum.

Precipitation Effect and Temperature Effect use the same function form. The function is:
Climate Effect <- exp(-0.5*(abs(CV - C)/A)B) where:

Competition Effect is calculated as:

CE = exp(-(C * ndD)


where:

Snags, seedlings, and already-dead trees are never counted in the neighbor count.

The annual growth for each species is calculated for each grid cell in the "Weibull Climate Quadrat Growth" grid, which this behavior creates. Trees take their growth from the grid cell in which they are found.

The parameter file call string for this to be diameter-incrementing with auto-height updating is "WeibullClimateQuadratGrowth"; for diameter-only incrementing, use "WeibullClimateQuadratGrowth diam only". The namestring for this behavior is "WeibullClimateQuadratGrowthshell".

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

clWeibullClimateQuadratGrowth::clWeibullClimateQuadratGrowth ( clSimManager p_oSimManager)

Constructor.

Parameters
p_oSimManagerSim Manager object.
clWeibullClimateQuadratGrowth::~clWeibullClimateQuadratGrowth ( )

Destructor.

Member Function Documentation

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

Queries the grid for the growth value for this tree's cell that was calculated by PreGrowthCalcs() and returns it.

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

Reimplemented from clGrowthBase.

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

Does setup.

  1. AssembleUniqueTypes() is called to create a list of unique behavior types.
  2. ReadParameterFile() is called to read the parameter file's data.
  3. ValidateData() is called to validate the data.
  4. SetupGrid() is called to create the growth grid.
Parameters
p_oDocDOM tree of parsed input tree.

Reimplemented from clGrowthBase.

void clWeibullClimateQuadratGrowth::FormatQuery ( clTreePopulation p_oPop)
protected

Populates m_cQuery with the query for getting target trees.

Parameters
p_oPopTree population object.
int clWeibullClimateQuadratGrowth::GetNumNeighbors ( float &  fX,
float &  fY,
clTreePopulation p_oPop 
)
protected

Counts the number of trees a target's neighborhood that have a DBH bigger than the minimum cutoff.

Parameters
fXX location from which to count the larger neighbors.
fYY location from which to count the larger neighbors.
p_oPopTree population, for getting neighbors.
Returns
Number of larger neighbors.
void clWeibullClimateQuadratGrowth::PreGrowthCalcs ( clTreePopulation p_oPop)
virtual

Calculates growth.

This retrieves trees to which this behavior applies, and for each one makes sure that growth has been calculated for its species and grid cell. This does not assign a growth value to the trees; that happens in CalcDiameterGrowthValue. Doing it this way ensures two things: that growth is not calculated if it is not needed, and that we don't have to worry about accidentally assigning growth to a tree to which this behavior is not applied.

Steps:

  1. Reset all growth values in the grid to -1.
  2. Calculate temperature and precipitation effects for each species for the current values of the plot climate variables
  3. Get all trees for this behavior.
  4. For each tree, determine whether or not growth has been calculated for the grid cell that it is in; if yes, do nothing
  5. If growth needs to be calculated, count the number of neighbors
  6. Calculate the amount of growth for each using the equations above. Stash the end result in "Growth".

This must be called first of any growth stuff, since it uses other trees' DBHs to count neighbors, and this must be done before growth has been applied.

Parameters
p_oPopTree population object.

Reimplemented from clGrowthBase.

void clWeibullClimateQuadratGrowth::ReadParameterFile ( xercesc::DOMDocument *  p_oDoc,
clTreePopulation p_oPop 
)
protected

Reads data from the parameter file.

Parameters
p_oDocDOM tree of parsed input tree.
p_oPopTree population object.
Exceptions
modelErrif this behavior has been applied to any types except sapling and adult.
void clWeibullClimateQuadratGrowth::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.

void clWeibullClimateQuadratGrowth::SetupGrid ( clTreePopulation p_oPop)
protected

Sets up the "Weibull Climate Quadrat Growth" grid.

This ignores any maps.

Parameters
p_oPopTree population object.
void clWeibullClimateQuadratGrowth::ValidateData ( clTreePopulation p_oPop)
protected

Makes sure all input data is valid.

The following must all be true:

  • Max radius of neighbor effects must be > 0
  • Max growth for each species must be > 0
  • Temp and precip A for each species must be > 0
Parameters
p_oPopTree population object.
Exceptions
modelErrif any of the above conditions are not met.

Member Data Documentation

char* clWeibullClimateQuadratGrowth::m_cQuery
protected

Query string to get target trees.

float clWeibullClimateQuadratGrowth::m_fMaxCrowdingRadius
protected

Maximum search radius, in meters, in which to look for crowding neighbors.

For calculating the Competition Effect.

float clWeibullClimateQuadratGrowth::m_fMinSaplingHeight
protected

Minimum sapling height.

For doing neighbor searches.

short int clWeibullClimateQuadratGrowth::m_iNumNeighCode
protected

Return code for the "num_neigh" grid data member.

float* clWeibullClimateQuadratGrowth::mp_fCompC
protected

Competition effect C.

Array size is number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fCompD
protected

Competition effect D.

Array size is number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fMaxRG
protected

Maximum potential growth value, in cm.

Array is sized number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fMinimumNeighborDBH
protected

The minimum DBH, in cm, of neighbors to be included in the neighbor count.

Array is sized number of species.

float* clWeibullClimateQuadratGrowth::mp_fPrecipA
protected

Precipitation effect A.

Array size is number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fPrecipB
protected

Precipitation effect B.

Array size is number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fPrecipC
protected

Precipitation effect C.

Array size is number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fTempA
protected

Temperature effect A.

Array size is number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fTempB
protected

Temperature effect B.

Array size is number of species to which this behavior applies.

float* clWeibullClimateQuadratGrowth::mp_fTempC
protected

Temperature effect C.

Array size is number of species to which this behavior applies.

short int* clWeibullClimateQuadratGrowth::mp_iGridGrowthCodes
protected

Holds data member codes for the "growth_x" data members of the "Weibull Climate Quadrat Growth" grid.

Array size is total # species.

short int* clWeibullClimateQuadratGrowth::mp_iIndexes
protected

Speeds access to the arrays.

Array size is number of species.

clGrid* clWeibullClimateQuadratGrowth::mp_oGrid
protected

Grid holding amount of growth for each species.

The grid name is "Weibull Climate Quadrat Growth". It has X+1 float data members, where X = the total number of species. The data member names are "growth_x", for the amount of diameter growth (where "x" is the species number), and "num_neigh" for the number of neighbors.


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