Stochastic Gap Growth, Version 1.0. More...

#include <StochasticGapGrowth.h>

Inheritance diagram for clStochasticGapGrowth:

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

	~clStochasticGapGrowth ()
	Destructor. More...

void	Action ()
	Performs growth calculations. More...

void	GetData (xercesc::DOMDocument *p_oDoc)
	Does the setup for this behavior. 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	RegisterTreeDataMembers ()
	Registers tree data members. 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
clGrid *	mp_oGapLight
	Pointer to the "Gap Light" grid (this behavior does not create this grid). More...

clGrid *	mp_oGrowthCounter
	Grid called "Growth Counter", created by this behavior. More...

bool **	mp_bAppliedTo
	Array for determining to which trees this behavior is applied. More...

char *	m_cQuery
	Query for finding trees to which this behavior applies. More...

int	m_iNumSpecies
	Keep a copy of this for the destructor for freeing memory. More...

short int	m_iIsGapCode
	Data member code for the "Is Gap" bool data member of the "Gap Light" grid. More...

short int	m_iCurrentCode
	Data member code for the "Current" int data member of the "Growth Counter" grid. More...

short int	m_iTargetCode
	Data member code for the "Target" int data member of the "Growth Counter" grid. 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
Protected Member Functions inherited from clWorkerBase
void	AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
	Creates the proper identifying filecode for an XML file. More...

Detailed Description

Stochastic Gap Growth, Version 1.0.

This behavior takes a shortcut for simulating rapid growth in high-light, very competitive conditions.

The behavior creates growth under gap conditions. To recognize gap conditions, it relies on the "Gap Light" grid produced by the clGapLight class. For any cell which has gap status, from the group of trees in that cell to which this behavior is applied, a tree is randomly chosen to be given whatever growth is necessary for it to reach the minimum DBH for adults. No other trees in the cell grow at all. In cells that have non-gap status, no trees at all grow.

To randomly select a tree to grow, this behavior uses a grid called "Growth Counter". The behavior counts up the number of eligible trees in each cell of "Growth Counter". It then multiplies a random number by the number of trees, arriving at a target tree (i.e. number 34 out of 56 found). Then this tree is given the amount of growth necessary for it to reach the minimum adult DBH.

The namestring and parameter file call string for this behavior is "StochasticGapGrowth". Note that this behavior does not descend from clGrowthBase. There is nothing to be gained from that association, and it is easier for this behavior to perform all of its work at once rather than on one tree at a time.

It is a fatal error if this behavior cannot find the "Gap Light" grid during setup.

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clStochasticGapGrowth()

clStochasticGapGrowth::clStochasticGapGrowth ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

◆ ~clStochasticGapGrowth()

clStochasticGapGrowth::~clStochasticGapGrowth ( )

Destructor.

Frees memory.

Member Function Documentation

◆ Action()

void clStochasticGapGrowth::Action ( )

virtual

Performs growth calculations.

This function cycles through all of the trees twice. On the first pass, each tree is assigned to the appropriate cell in "Growth Counter". If that cell has gap status, the number in the "Current" data member is incremented. If the cell does not have gap status, nothing happens. Then, for each cell in "Growth Counter" that has a positive count in "Current", a random number is multiplied by it and that number is placed in "Target". Then the trees are cycled through again in exactly the same way. For each cell, when the tree number in "Target" has been reached, that tree is allowed to grow to adult status.

Reimplemented from clBehaviorBase.

◆ GetData()

void clStochasticGapGrowth::GetData ( xercesc::DOMDocument * p_oDoc )

virtual

Does the setup for this behavior.

This gets a pointer to the "Gap Light" grid and sets up the "Growth Counter" grid. Then it populates the mp_bAppliedTo array. Then it sets up the query for doing tree searches.

Parameters

p_oDoc Parsed parameter file.

Exceptions

modelErr if the "Gap Light" grid cannot be found.

Implements clWorkerBase.

Member Data Documentation

◆ m_cQuery

char* clStochasticGapGrowth::m_cQuery

protected

Query for finding trees to which this behavior applies.

This will instigate a species/type search for all the species and types to which this behavior applies.

◆ m_iCurrentCode

short int clStochasticGapGrowth::m_iCurrentCode

protected

Data member code for the "Current" int data member of the "Growth Counter" grid.

◆ m_iIsGapCode

short int clStochasticGapGrowth::m_iIsGapCode

protected

Data member code for the "Is Gap" bool data member of the "Gap Light" grid.

◆ m_iNumSpecies

int clStochasticGapGrowth::m_iNumSpecies

protected

Keep a copy of this for the destructor for freeing memory.

◆ m_iTargetCode

short int clStochasticGapGrowth::m_iTargetCode

protected

Data member code for the "Target" int data member of the "Growth Counter" grid.

◆ mp_bAppliedTo

bool** clStochasticGapGrowth::mp_bAppliedTo

protected

Array for determining to which trees this behavior is applied.

The array size is # total species by # total types.

◆ mp_oGapLight

clGrid* clStochasticGapGrowth::mp_oGapLight

protected

Pointer to the "Gap Light" grid (this behavior does not create this grid).

This grid is expected to have one bool data member called "Is Gap".

◆ mp_oGrowthCounter

clGrid* clStochasticGapGrowth::mp_oGrowthCounter

protected

Grid called "Growth Counter", created by this behavior.

It has a grid cell resolution matching "Gap Light". It has two int data members, "Current" (which holds the number of trees found in gap cells) and "Target" (which holds the target number of the tree, out of the total in "Current", which has been chosen to grow). Any map of this grid entered in the parameter file will be ignored, including just setting the grid cell resolution.

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

StochasticGapGrowth.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clStochasticGapGrowth()

◆ ~clStochasticGapGrowth()

Member Function Documentation

◆ Action()

◆ GetData()

Member Data Documentation

◆ m_cQuery

◆ m_iCurrentCode

◆ m_iIsGapCode

◆ m_iNumSpecies

◆ m_iTargetCode

◆ mp_bAppliedTo

◆ mp_oGapLight

◆ mp_oGrowthCounter