Stochastic Bi-Level Mortality - Version 2.0. More...

#include <StochasticBiLevelMortality.h>

Inheritance diagram for clStochasticBiLevelMortality:

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

	~clStochasticBiLevelMortality ()
	Destructor. More...

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Reads in values from the parameter file. More...

deadCode	DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies)
	Calculates mortality. More...

void	SetNameData (std::string sNameString)
	Captures the behavior name passed from the parameter file to set flags based on expected behavior. More...

Public Member Functions inherited from clMortalityBase
	clMortalityBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clMortalityBase ()
	Destructor. More...

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

clMortalityOrg *	GetMortOrg ()
	Gets the mortality org object. More...

void	RegisterTreeDataMembers ()
	Triggers the mortality data member registrations. More...

short int	GetNewTreeInts ()
	Overridden from clBehaviorBase. More...

bool	UsesThisMortality (short int iSp, short int iTp)
	Whether or not a species/type combo uses this mortality object. More...

virtual void	PreMortCalcs (clTreePopulation *p_oPop)
	Performs calculations before any trees have been killed. 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	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 Types
typedef float(clStochasticBiLevelMortality::*	Ptr2LightLevel) (clTree *, const short int &)
	Define a type for pointers to functions to get light level. More...

Protected Member Functions
float	GetStormLightLevel (clTree *p_oTree, const short int &iSpecies)
	Gets the light level from the Storm Light grid for a tree. More...

float	GetGLILightLevel (clTree *p_oTree, const short int &iSpecies)
	Gets the GLI light level for a tree. More...

Protected Member Functions inherited from clMortalityBase
void	GetData (xercesc::DOMDocument *p_oDoc)
	Triggers all mortality setup. More...

void	PopulateUsesThisMortality ()
	Declares and populates the mp_bUsesThisMortality array. 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...

Protected Attributes
Ptr2LightLevel	getLightLevel
	Function pointer for using the appropriate light level getting function. More...

clGrid *	mp_oStormLight
	"Storm Light" grid object More...

clTreePopulation *	mp_oPop
	Tree population - for getting data codes. More...

double *	mp_fLoLightMortProb
	Probability of mortality at low light - sized number of behavior species. More...

double *	mp_fHiLightMortProb
	Probability of mortality at low light - sized number of behavior species. More...

double *	mp_fHiLightThreshold
	Threshold between low light and high light mortality, as a value between 0 and 100 - sized number of behavior species. More...

int *	mp_iIndexes
	To help access the other arrays. More...

int **	mp_iGLILightCodes
	Data member return codes for "Light" data member, if being used. More...

int	m_iLightCode
	Code for the "Light" data member of the "Storm Light" grid, if used. More...

bool	m_bIsGLI
	Whether this is the GLI version (true) or the Storm Light version (false) More...

Protected Attributes inherited from clMortalityBase
short int	m_iNumTotalSpecies
	Keep a copy for the constructor. More...

bool	m_bHooked
	Whether or not this shell object is hooked to clMortalityOrg. More...

bool **	mp_bUsesThisMortality
	2D array, species by type, of whether or not this mortality shell applies to a given species/type combo. 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
Static Protected Attributes inherited from clMortalityBase
static clMortalityOrg *	mp_oMortalityOrg
	clMortalityOrg object. More...

Detailed Description

Stochastic Bi-Level Mortality - Version 2.0.

This evaluates mortality at a constant rate, with a separate rate at high and low light for each species. Trees are chosen at random to die.

Light levels come from either the "Storm Light" grid object produced by clStormLight or a GLI value stored in the "Light" data member of a tree.

This class's namestring is "stochastic bilevel mortshell". The parameter file call string is "StochasticBiLevelMortality" or "StochasticBiLevelMortality - GLI".

Author: Lora E. Murphy

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

Member Typedef Documentation

◆ Ptr2LightLevel

typedef float(clStochasticBiLevelMortality::* clStochasticBiLevelMortality::Ptr2LightLevel) (clTree *, const short int &)

protected

Define a type for pointers to functions to get light level.

Constructor & Destructor Documentation

◆ clStochasticBiLevelMortality()

clStochasticBiLevelMortality::clStochasticBiLevelMortality ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim Manager object.

◆ ~clStochasticBiLevelMortality()

clStochasticBiLevelMortality::~clStochasticBiLevelMortality ( )

Destructor.

Member Function Documentation

◆ DoMort()

deadCode clStochasticBiLevelMortality::DoMort	(	clTree *	p_oTree,
		const float &	fDbh,
		const short int &	iSpecies
	)

virtual

Calculates mortality.

This retrieves the light level in the tree's grid cell. If it is above the threshold, the high-light mortality probability is used. If it is below the threshold, the low-light probability is used. A random number is compared to the appropriate rate to see if the tree lives or dies.

Parameters

p_oTree	Tree being evaluated
fDbh	Tree's DBH
iSpecies	Species of the tree being evaluated

Returns: natural if the tree is to die, notdead if it lives.

Implements clMortalityBase.

◆ DoShellSetup()

void clStochasticBiLevelMortality::DoShellSetup ( xercesc::DOMDocument * p_oDoc )

virtual

Reads in values from the parameter file.

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if the "Storm Light" grid is missing, or if any mortality rate is not between 0 and 1.

Reimplemented from clMortalityBase.

◆ GetGLILightLevel()

float clStochasticBiLevelMortality::GetGLILightLevel	(	clTree *	p_oTree,
		const short int &	iSpecies
	)

protected

Gets the GLI light level for a tree.

Parameters

p_oTree	Tree to get light level for.
iSpecies	Tree's species.

Returns: Light level.

◆ GetStormLightLevel()

float clStochasticBiLevelMortality::GetStormLightLevel	(	clTree *	p_oTree,
		const short int &	iSpecies
	)

protected

Gets the light level from the Storm Light grid for a tree.

Parameters

p_oTree	Tree to get light level for.
iSpecies	Tree's species.

Returns: Light level.

◆ SetNameData()

void clStochasticBiLevelMortality::SetNameData ( std::string sNameString )

virtual

Captures the behavior name passed from the parameter file to set flags based on expected behavior.

Parameters

sNameString Behavior name from parameter file.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ getLightLevel

Ptr2LightLevel clStochasticBiLevelMortality::getLightLevel

protected

Function pointer for using the appropriate light level getting function.

◆ m_bIsGLI

bool clStochasticBiLevelMortality::m_bIsGLI

protected

Whether this is the GLI version (true) or the Storm Light version (false)

◆ m_iLightCode

int clStochasticBiLevelMortality::m_iLightCode

protected

Code for the "Light" data member of the "Storm Light" grid, if used.

◆ mp_fHiLightMortProb

double* clStochasticBiLevelMortality::mp_fHiLightMortProb

protected

Probability of mortality at low light - sized number of behavior species.

This value comes from the parameter file as an annual probability, which is transformed in DoShellSetup() to a timestep probability.

◆ mp_fHiLightThreshold

double* clStochasticBiLevelMortality::mp_fHiLightThreshold

protected

Threshold between low light and high light mortality, as a value between 0 and 100 - sized number of behavior species.

◆ mp_fLoLightMortProb

double* clStochasticBiLevelMortality::mp_fLoLightMortProb

protected

Probability of mortality at low light - sized number of behavior species.

This value comes from the parameter file as an annual probability, which is transformed in DoShellSetup() to a timestep probability.

◆ mp_iGLILightCodes

int** clStochasticBiLevelMortality::mp_iGLILightCodes

protected

Data member return codes for "Light" data member, if being used.

First index is species, second is type.

◆ mp_iIndexes

int* clStochasticBiLevelMortality::mp_iIndexes

protected

To help access the other arrays.

◆ mp_oPop

clTreePopulation* clStochasticBiLevelMortality::mp_oPop

protected

Tree population - for getting data codes.

◆ mp_oStormLight

clGrid* clStochasticBiLevelMortality::mp_oStormLight

protected

"Storm Light" grid object

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

StochasticBiLevelMortality.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr2LightLevel

Constructor & Destructor Documentation

◆ clStochasticBiLevelMortality()

◆ ~clStochasticBiLevelMortality()

Member Function Documentation

◆ DoMort()

◆ DoShellSetup()

◆ GetGLILightLevel()

◆ GetStormLightLevel()

◆ SetNameData()

Member Data Documentation

◆ getLightLevel

◆ m_bIsGLI

◆ m_iLightCode

◆ mp_fHiLightMortProb

◆ mp_fHiLightThreshold

◆ mp_fLoLightMortProb

◆ mp_iGLILightCodes

◆ mp_iIndexes

◆ mp_oPop

◆ mp_oStormLight