Establishment - Version 1.0. More...

#include <Establishment.h>

Inheritance diagram for clEstablishment:

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

	~clEstablishment ()
	Destructor. More...

void	GetData (xercesc::DOMDocument *p_oDoc)
	Does setup. More...

void	Action ()
	Performs establishment. More...

void	TimestepCleanup ()
	Zeroes out the seed grid. 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	EndOfRunCleanup ()
	Performs any necessary cleanup operations at the end of a run. More...

Protected Attributes
clGrid *	mp_oSeedGrid
	Pointer to the "Dispersed Seeds" grid created by disperse behaviors. More...

short int *	mp_iSeedGridCode
	Data member codes for seed grid for number of seeds. 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

Establishment - Version 1.0.

This behavior germinates seeds into seedlings. For each species to which this behavior is applied, this behavior takes all seeds in each grid cell of the seed grid and randomly places them around the area encompassed by the grid cell. The tree population is allowed to randomly pick a diameter at 10 cm.

To reduce memory requirements, a seedling efficiency routine can be turned on. For each seedling created, it will immediately assess its probability of surviving the next timestep, based on conditions in this timestep (with certain exceptions). If it is determined that the seedling is not likely to survive, it is removed right away. This cuts down on the total number of seedlings that needs to be under management at any one time - which can be significant for particularly fecund trees; millions of seedlings can be created, of which only a few percent will survive the next timestep, but which suck RAM tremendously in the meantime.

A fatal error is thrown if there are no disperse behaviors for the run.

The namestring and parameter file call string for this class is "Establishment". Apply this behavior to species; use any type, since it will be ignored.

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clEstablishment()

clEstablishment::clEstablishment ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim Manager object.

◆ ~clEstablishment()

clEstablishment::~clEstablishment ( )

Destructor.

Member Function Documentation

◆ Action()

void clEstablishment::Action ( )

virtual

Performs establishment.

All seeds get a random location within the grid cell they are in and then become seedlings.

Reimplemented from clBehaviorBase.

◆ GetData()

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

virtual

Does setup.

This reads in the "use efficiency routine" flag from the parameter file and gets pointers to the dispersed seeds grid.

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if there is not a disperse behavior used for each species that gets establishment.

Implements clWorkerBase.

◆ TimestepCleanup()

void clEstablishment::TimestepCleanup ( )

virtual

Zeroes out the seed grid.

Reimplemented from clWorkerBase.

Member Data Documentation

◆ mp_iSeedGridCode

short int* clEstablishment::mp_iSeedGridCode

protected

Data member codes for seed grid for number of seeds.

Array size is # total species.

◆ mp_oSeedGrid

clGrid* clEstablishment::mp_oSeedGrid

protected

Pointer to the "Dispersed Seeds" grid created by disperse behaviors.

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

Establishment.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clEstablishment()

◆ ~clEstablishment()

Member Function Documentation

◆ Action()

◆ GetData()

◆ TimestepCleanup()

Member Data Documentation

◆ mp_iSeedGridCode

◆ mp_oSeedGrid