Storm Direct Killer - Version 1.0. More...

#include <StormDirectKiller.h>

Inheritance diagram for clStormDirectKiller:

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

	~clStormDirectKiller ()
	Destructor. More...

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

void	Action ()
	Applies storm damage to trees. 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 Member Functions
void	GetParameterFileData (xercesc::DOMDocument p_oDoc, clTreePopulation p_oPop)
	Reads parameter file data. More...

void	FormatQueryString ()
	Formats the string in m_cQuery. More...

void	GetDeadCodes (clTreePopulation *p_oPop)
	Gets codes for the "dead" data member for each tree type to which this behavior applies. More...

void	GetGridInfo ()
	Gets the pointer to the "Storm Damage" grid and its appropriate data members. 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
clGrid *	mp_oStormDamageGrid
	Pointer to the "Storm Damage" grid. More...

char *	m_cQuery
	String to pass to clTreePopulation::Find() in order to get the trees to apply damage to. More...

double *	mp_fA
	Storm "a" parameter. More...

double *	mp_fB
	Storm "b" parameter. More...

int **	mp_iDeadCodes
	Return codes for the "dead" bool tree data member. More...

int	m_iNumTypes
	Number of total types. More...

int	m_iDmgIndexCode
	Return code for the "1dmg_index" float data member of the "Storm Damage" 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...

Detailed Description

Storm Direct Killer - Version 1.0.

This kills trees directly after a storm based solely on the damage at their location. Whether storms have occurred is assessed by clStorm. This behavior uses the values in the "Storm Damage" grid for storm severity, with 0 meaning that no storm has occurred.

A given tree's probability of mortality is

P = exp(a + b * s) / (1 + exp(a + b * s)))

where:

a and b are parameters
s is the storm damage index between 0 and 1, which comes from the tree's grid cell in "Storm Damage"

This behavior will use a random number to determine whether a tree dies based on its probability of mortality. A tree that dies gets its "dead" flag set to "storm". (This flag comes from mortality behaviors and is not added by this behavior.)

The call string for this is "StormDirectKiller".

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

Constructor & Destructor Documentation

◆ clStormDirectKiller()

clStormDirectKiller::clStormDirectKiller ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager clSimManager object.

◆ ~clStormDirectKiller()

clStormDirectKiller::~clStormDirectKiller ( )

Destructor.

Member Function Documentation

◆ Action()

void clStormDirectKiller::Action ( )

virtual

Applies storm damage to trees.

It uses the value in m_cQuery to get the trees to which this behavior applies. Then, for each tree, it will assess its probability of mortality for each storm that occurred in the current timestep. Random numbers are used to determine which trees die. Those that die get their "dead" flag set to "storm".

Reimplemented from clBehaviorBase.

◆ FormatQueryString()

void clStormDirectKiller::FormatQueryString ( )

protected

Formats the string in m_cQuery.

This value will be used in Action() to pass to clTreePopulation::Find() in order to get the trees to act on.

◆ GetData()

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

virtual

Does behavior setup.

Calls:

Parameters

p_oDoc Parsed parameter file.

Implements clWorkerBase.

◆ GetDeadCodes()

void clStormDirectKiller::GetDeadCodes ( clTreePopulation * p_oPop )

protected

Gets codes for the "dead" data member for each tree type to which this behavior applies.

Parameters

p_oPop Tree population object.

Exceptions

modelErr if the codes are not available for every tree type to which this behavior is applied.

◆ GetGridInfo()

void clStormDirectKiller::GetGridInfo ( )

protected

Gets the pointer to the "Storm Damage" grid and its appropriate data members.

Exceptions

modelErr if the "Storm Damage" grid has not been created.

◆ GetParameterFileData()

void clStormDirectKiller::GetParameterFileData	(	xercesc::DOMDocument *	p_oDoc,
		clTreePopulation *	p_oPop
	)

protected

Reads parameter file data.

Parameters

p_oDoc	Parsed parameter file.
p_oPop	Tree population object.

Member Data Documentation

◆ m_cQuery

char* clStormDirectKiller::m_cQuery

protected

String to pass to clTreePopulation::Find() in order to get the trees to apply damage to.

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

◆ m_iDmgIndexCode

int clStormDirectKiller::m_iDmgIndexCode

protected

Return code for the "1dmg_index" float data member of the "Storm Damage" grid.

◆ m_iNumTypes

int clStormDirectKiller::m_iNumTypes

protected

Number of total types.

◆ mp_fA

double* clStormDirectKiller::mp_fA

protected

Storm "a" parameter.

Array size is total number of species. From the parameter file.

◆ mp_fB

double* clStormDirectKiller::mp_fB

protected

Storm "b" parameter.

Array size is total number of species. From the parameter file.

◆ mp_iDeadCodes

int** clStormDirectKiller::mp_iDeadCodes

protected

Return codes for the "dead" bool tree data member.

Array index one is sized m_iNumTypes; array index two is sized total number of species.

◆ mp_oStormDamageGrid

clGrid* clStormDirectKiller::mp_oStormDamageGrid

protected

Pointer to the "Storm Damage" grid.

This grid is created by clStorm.

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

StormDirectKiller.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ clStormDirectKiller()

◆ ~clStormDirectKiller()

Member Function Documentation

◆ Action()

◆ FormatQueryString()

◆ GetData()

◆ GetDeadCodes()

◆ GetGridInfo()

◆ GetParameterFileData()

Member Data Documentation

◆ m_cQuery

◆ m_iDmgIndexCode

◆ m_iNumTypes

◆ mp_fA

◆ mp_fB

◆ mp_iDeadCodes

◆ mp_oStormDamageGrid