Height-GLI Weibull Mortality - Version 2.0. More...

#include <HeightGLIWeibullMortality.h>

Inheritance diagram for clHeightGLIWeibullMortality:

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

	~clHeightGLIWeibullMortality ()
	Destructor. More...

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Calls GetTreeDataMemberCodes(), then ReadParameterFileData(). More...

deadCode	DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies)
	Calculates mortality according to the equation above. 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 void	SetNameData (std::string sNameString)
	Sets the string for the parameter file 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 Member Functions
void	GetTreeDataMemberCodes ()
	Queries for the return codes of the "Light", "Browsed", and "Height" tree data members. More...

void	ReadParameterFileData (xercesc::DOMDocument *p_oDoc)
	Reads the parameter file data. 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
short int **	mp_iLightCodes
	Return codes for the "Light" tree float data member variable. More...

short int **	mp_iHeightCodes
	Return codes for the "Height" tree float data member variable. More...

short int **	mp_iBrowsedCodes
	Return codes for the "Browsed" tree bool data member variable. More...

double *	mp_fMaxMort
	Max mortality - sized number of behavior species. More...

double *	mp_fA
	Mortality "a" parameter - sized number of behavior species. More...

double *	mp_fB
	Mortality "b" parameter - sized number of behavior species. More...

double *	mp_fC
	Mortality "c" parameter - sized number of behavior species. More...

double *	mp_fD
	Mortality "d" parameter - sized number of behavior species. More...

double *	mp_fBrowsedMaxMort
	Browsed max mortality - sized number of behavior species. More...

double *	mp_fBrowsedA
	Browsed "a" parameter - sized number of behavior species. More...

double *	mp_fBrowsedB
	Browsed "b" parameter - sized number of behavior species. More...

double *	mp_fBrowsedC
	Browsed "c" parameter - sized number of behavior species. More...

double *	mp_fBrowsedD
	Browsed "d" parameter - sized number of behavior species. More...

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

int	m_iYearsPerTimestep
	Number of years per timestep - for converting probabilities for multi- year timesteps. 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

Height-GLI Weibull Mortality - Version 2.0.

This evaluates mortality according to a weibull function of tree height and GLI.

The equation used in this behavior is:

p = M_max * exp(-a * H ^b - c * GLI ^d)

where

p = annual probability of mortality
M_max = max mortality parameter
a, b, c, d = parameters
H = tree height in meters
GLI, between 0 and 100

If browsing has been implemented (class clRandomBrowse), then this will attempt to implement a second set of parameters for when trees are browsed. Lack of the browse behavior will cause use of the unbrowsed parameters only. A mix of browse applied and unapplied can be used; however, there must be parameters for all the same species for browsed, even if they're not all used.

This class's namestring is "height gli weibull mortshell". The parameter file call string is "HeightGLIWeibullMortality".

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clHeightGLIWeibullMortality()

clHeightGLIWeibullMortality::clHeightGLIWeibullMortality ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim Manager object.

◆ ~clHeightGLIWeibullMortality()

clHeightGLIWeibullMortality::~clHeightGLIWeibullMortality ( )

Destructor.

Member Function Documentation

◆ DoMort()

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

virtual

Calculates mortality according to the equation above.

Then uses a random number to decide if a tree 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 clHeightGLIWeibullMortality::DoShellSetup ( xercesc::DOMDocument * p_oDoc )

virtual

Calls GetTreeDataMemberCodes(), then ReadParameterFileData().

Parameters

p_oDoc DOM tree of parsed input file.

Reimplemented from clMortalityBase.

◆ GetTreeDataMemberCodes()

void clHeightGLIWeibullMortality::GetTreeDataMemberCodes ( )

protected

Queries for the return codes of the "Light", "Browsed", and "Height" tree data members.

Return codes are captured in the mp_iLightCodes, mp_iBrowsedCodes, and mp_iHeightCodes arrays.

Exceptions

modelErr if any data member codes are missing for light or height. Missing browse is not an error.

◆ ReadParameterFileData()

void clHeightGLIWeibullMortality::ReadParameterFileData ( xercesc::DOMDocument * p_oDoc )

protected

Reads the parameter file data.

Unbrowsed parameters are always read. Browsed parameters are read only if there is a non -1 value somewhere in mp_iBrowsedCodes. However, if there is, then the same set of species had better be present for the browsed parameters as for the unbrowsed.

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if the max mortality parameter is not between 0 and 1.

Member Data Documentation

◆ m_iYearsPerTimestep

int clHeightGLIWeibullMortality::m_iYearsPerTimestep

protected

Number of years per timestep - for converting probabilities for multi- year timesteps.

◆ mp_fA

double* clHeightGLIWeibullMortality::mp_fA

protected

Mortality "a" parameter - sized number of behavior species.

◆ mp_fB

double* clHeightGLIWeibullMortality::mp_fB

protected

Mortality "b" parameter - sized number of behavior species.

◆ mp_fBrowsedA

double* clHeightGLIWeibullMortality::mp_fBrowsedA

protected

Browsed "a" parameter - sized number of behavior species.

◆ mp_fBrowsedB

double* clHeightGLIWeibullMortality::mp_fBrowsedB

protected

Browsed "b" parameter - sized number of behavior species.

◆ mp_fBrowsedC

double* clHeightGLIWeibullMortality::mp_fBrowsedC

protected

Browsed "c" parameter - sized number of behavior species.

◆ mp_fBrowsedD

double* clHeightGLIWeibullMortality::mp_fBrowsedD

protected

Browsed "d" parameter - sized number of behavior species.

◆ mp_fBrowsedMaxMort

double* clHeightGLIWeibullMortality::mp_fBrowsedMaxMort

protected

Browsed max mortality - sized number of behavior species.

◆ mp_fC

double* clHeightGLIWeibullMortality::mp_fC

protected

Mortality "c" parameter - sized number of behavior species.

◆ mp_fD

double* clHeightGLIWeibullMortality::mp_fD

protected

Mortality "d" parameter - sized number of behavior species.

◆ mp_fMaxMort

double* clHeightGLIWeibullMortality::mp_fMaxMort

protected

Max mortality - sized number of behavior species.

◆ mp_iBrowsedCodes

short int** clHeightGLIWeibullMortality::mp_iBrowsedCodes

protected

Return codes for the "Browsed" tree bool data member variable.

Array size is number of species to which this behavior applies by number of types

◆ mp_iHeightCodes

short int** clHeightGLIWeibullMortality::mp_iHeightCodes

protected

Return codes for the "Height" tree float data member variable.

Array size is number of species to which this behavior applies by number of types

◆ mp_iIndexes

int* clHeightGLIWeibullMortality::mp_iIndexes

protected

To help access the other arrays.

◆ mp_iLightCodes

short int** clHeightGLIWeibullMortality::mp_iLightCodes

protected

Return codes for the "Light" tree float data member variable.

Array size is number of species to which this behavior applies by number of types

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

HeightGLIWeibullMortality.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clHeightGLIWeibullMortality()

◆ ~clHeightGLIWeibullMortality()

Member Function Documentation

◆ DoMort()

◆ DoShellSetup()

◆ GetTreeDataMemberCodes()

◆ ReadParameterFileData()

Member Data Documentation

◆ m_iYearsPerTimestep

◆ mp_fA

◆ mp_fB

◆ mp_fBrowsedA

◆ mp_fBrowsedB

◆ mp_fBrowsedC

◆ mp_fBrowsedD

◆ mp_fBrowsedMaxMort

◆ mp_fC

◆ mp_fD

◆ mp_fMaxMort

◆ mp_iBrowsedCodes

◆ mp_iHeightCodes

◆ mp_iIndexes

◆ mp_iLightCodes