Storm Killer - Version 1.0. More...

#include <StormKiller.h>

Inheritance diagram for clStormKiller:

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

	~clStormKiller ()
	Destructor. More...

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

void	Action ()
	Kills storm-damaged 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)
	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	GetStmDmgCodes ()
	Gets codes for the "stm_dmg" data member for each tree type to which this behavior applies. 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
char *	m_cQuery
	String to pass to clTreePopulation::Find() in order to get the trees to apply damage to. More...

double *	mp_fMinStormDBH
	The minimum DBH, in cm, for trees that can be damaged by storms. More...

double *	mp_fStmDmgMedA
	Medium damage a. More...

double *	mp_fStmDmgHeavyA
	Heavy damage a. More...

double *	mp_fStmDmgMedB
	Medium damage b. More...

double *	mp_fStmDmgHeavyB
	Heavy damage b. More...

double *	mp_fPropTipUp
	Proportion of dead heavy-damaged trees that tip-up, between 0 and 1. More...

int **	mp_iStmDmgCodes
	Return codes for the "stm_dmg" int tree data member. More...

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

int	m_iSnagYears
	Number of years snags stick around. More...

int	m_iNumTypes
	Number of total types (despite the fact that this behavior won't deal with all of them). 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 Killer - Version 1.0.

The storm killer kills trees that are storm-damaged.

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. Damage as a result of the storm is assessed by clStormDamageApplier. Damage is either none, medium, or heavy.

If a tree has medium or heavy damage, its probability of survival is:

P(i) = exp(a_i + b_i * DBH) / (1 + exp(a_i + b_i * DBH))

where:

a_i and b_i are parameters for that tree's species for that damage category
DBH is the tree's DBH, in cm

There is a minimum DBH for which to apply storms for each species. Set this to zero if storms apply to all trees.

Once the probability for survival has been assessed, this behavior uses a random number to determine whether or not the tree actually dies. Dead heavy damaged trees have an additional probability of becoming a tip-up. Damaged trees can only die the timestep the storm occurs.

If this behavior is applied to snags, then dead non-tip-ups become snags. This behavior sets a counter which holds time-since-damage and the damage level that killed them (even if they already had higher damage as an alive tree). After the value in the snag lifetime parameter, these snags are removed. Snags not created by this behavior are not touched.

If this behavior is not applied to snags, tip-ups become snags whose "dead" flag is set to true. (This flag comes from mortality behaviors and is not added by this behavior.) This behavior then has nothing more to do with these trees.

If this behavior is not applied to snags, then all trees that die get their "dead" flags set to true. (This flag comes from mortality behaviors and is not added by this behavior.) This behavior then has nothing more to do with these trees.

This behavior cannot be applied to seedlings. The clStormDamageApplier behavior is required.

The namestring and parameter file call string for this is "StormKiller".

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

Constructor & Destructor Documentation

◆ clStormKiller()

clStormKiller::clStormKiller ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager clSimManager object.

◆ ~clStormKiller()

clStormKiller::~clStormKiller ( )

Destructor.

Member Function Documentation

◆ Action()

void clStormKiller::Action ( )

virtual

Kills storm-damaged 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 survival based on its damage and randomly pick whether or not to kill it. Trees with heavy damage are assessed for the possibility of tip-up by comparing another random number to mp_fPropTipUp.

If we have values of -1 for stm_dmg for snags, then all dead are "killed" by getting their "dead" tree data member set to true. Otherwise, they are passed as killed with a code of "storm" to the tree population. If they were tip-up, then their "dead" tree data member is set to true.

Reimplemented from clBehaviorBase.

◆ FormatQueryString()

void clStormKiller::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 clStormKiller::GetData ( xercesc::DOMDocument * p_oDoc )

virtual

Does behavior setup.

Calls GetParameterFileData() to read in values from the parameter file.
Calls FormatQueryString().
Calls GetStmDmgCodes() to get the appropriate tree data member codes.

Parameters

p_oDoc Parsed parameter file.

Implements clWorkerBase.

◆ GetDeadCodes()

void clStormKiller::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.

◆ GetParameterFileData()

void clStormKiller::GetParameterFileData ( xercesc::DOMDocument * p_oDoc )

protected

Reads parameter file data.

Parameters

p_oDoc Parsed parameter file.

Exceptions

modelErr

if:

The value for m_iSnagYears is not greater than or equal to 0
The value in proportion that become tip-ups is not between 0 and 1

◆ GetStmDmgCodes()

void clStormKiller::GetStmDmgCodes ( )

protected

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

Exceptions

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

Member Data Documentation

◆ m_cQuery

char* clStormKiller::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_iNumTypes

int clStormKiller::m_iNumTypes

protected

Number of total types (despite the fact that this behavior won't deal with all of them).

◆ m_iSnagYears

int clStormKiller::m_iSnagYears

protected

Number of years snags stick around.

From the parameter file.