Post-Harvest Skidding Mortality - Version 1.0. More...

#include <PostHarvestSkiddingMort.h>

Inheritance diagram for clPostHarvestSkiddingMort:

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

	~clPostHarvestSkiddingMort ()
	Destructor. More...

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Reads in values from the parameter file, makes sure all data needed is collected, calls the function to setup the time since harvest grid, and registers the codes for harvest intensity. More...

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

void	PreMortCalcs (clTreePopulation *p_oPop)
	Calls the function to calculate time since the last harvest once per timestep. 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...

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	SetupTimeSinceHarvestGrid ()
	This creates the Years Since Harvest grid at the beginning of the simulation, and sets pointers to grids and saves other relevant grid info in class members. More...

float	LocalBasalAreaAroundTree (clTree *p_oTree)
	This calculates the basal area (in m2/ha) of all trees within a certain distance of the tree passed as an argument. More...

int	GetTimeSinceHarvest (clTree *p_oTree)
	Returns the Time value from the Time Since Harvest grid at the location of a tree. More...

void	CalcTimeSinceHarvest ()
	Updates the Years Since Last Harvest grid. 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
double *	mp_fPreHarvestBackgroundMort
	Parameter for the annual mortality rate before harvesting. More...

double *	mp_fWindthrowHarvestBasicProb
	Parameter for the basic post-harvest increase in windthrow mortality. More...

double *	mp_fSnagRecruitHarvestBasicProb
	Parameter for the basic post-harvest increase in snag-recruitment mortality. More...

double *	mp_fWindthrowSizeEffect
	Parameter for the increase in post-harvest windthrow mortality with size. More...

double *	mp_fWindthrowHarvestIntensityEffect
	Parameter for the increase in post-harvest windthrow mortality with nearby harvesting. More...

double *	mp_fSnagRecruitHarvestIntensityEffect
	Parameter for the increase in post-harvest snag-recruitment mortality with nearby harvesting. More...

double *	mp_fWindthrowCrowdingEffect
	Parameter for the decrease in post-harvest windthrow mortality with crowding. More...

double *	mp_fSnagRecruitCrowdingEffect
	Parameter for the increase in post-harvest snag-recruitment mortality with crowding. More...

double *	mp_fWindthrowHarvestRateParam
	Parameter for rate of decrease in post-harvest windthrow mortality with time since harvest. More...

double *	mp_fSnagRecruitHarvestRateParam
	Parameter for rate of decrease in post-harvest snag-recruitment mortality with time since harvest. More...

double *	mp_fWindthrowBackgroundProb
	Parameter for background post-harvest windthrow mortality. More...

double *	mp_fSnagRecruitBackgroundProb
	Parameter for background post-harvest snag-recruitment mortality. More...

double	m_fCrowdingEffectRadius
	Distance from a tree at which local basal area is calculated for crowding effect. More...

int	m_iHarvestTypeCode
	Code for Harvest Type in Harvest Results grid. More...

int **	mp_iHarvestIntensityCodes
	Codes for the harvest intensity around each tree. More...

int	m_iTimeCode
	Code for Time (since last harvest) in the Years Since Last Harvest grid. More...

int	m_iLastUpdated
	Code for LastUpdated (timestep) in the Years Since Last Harvest grid. More...

int	m_iNumXCells
	Number of X cells in grids. More...

int	m_iNumYCells
	Number of Y cells in grids. More...

int	m_iNumSpecies
	Number of species. More...

clGrid *	mp_oTimeSinceHarvestGrid
	Pointer to Years Since Last Harvest grid. More...

clGrid *	mp_oHarvestResultsGrid
	Pointer to Harvest Results grid. More...

int	m_iNumberYearsPerTimestep
	Number of years per timestep. 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

Post-Harvest Skidding Mortality - Version 1.0.

This evaluates mortality as a function of time since the last harvest, harvest intensity, DBH, and local basal area. If harvesting has not occurred, then a constant background mortality rate is applied.

This class's namestring is "PostHarvestSkiddingMortshell". Its parameter file call string is "PostHarvestSkiddingMortality".

Author: Mark C. Vanderwel

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

Constructor & Destructor Documentation

◆ clPostHarvestSkiddingMort()

clPostHarvestSkiddingMort::clPostHarvestSkiddingMort ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

◆ ~clPostHarvestSkiddingMort()

clPostHarvestSkiddingMort::~clPostHarvestSkiddingMort ( )

Destructor.

Member Function Documentation

◆ CalcTimeSinceHarvest()

void clPostHarvestSkiddingMort::CalcTimeSinceHarvest ( )

protected

Updates the Years Since Last Harvest grid.

Note that harvesting occurs at the beginning of the timestep, but mortality occurs at the end of the timestep. So, if there was harvesting this timestep post-harvest mortality will be calculated annually for 1 to (Years per timestep) years after harvesting.

◆ DoMort()

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

virtual

Calculates mortality.

Parameters

fDbh	DBH of tree being evaluated - for seedlings will be 0
p_oTree	Tree being evaluated
iSpecies	Species of the tree being evaluated

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

Implements clMortalityBase.

◆ DoShellSetup()

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

virtual

Reads in values from the parameter file, makes sure all data needed is collected, calls the function to setup the time since harvest grid, and registers the codes for harvest intensity.

Parameters

p_oDoc Parsed DOM tree of parameter file.

Reimplemented from clMortalityBase.

◆ GetTimeSinceHarvest()

int clPostHarvestSkiddingMort::GetTimeSinceHarvest ( clTree * p_oTree )

protected

Returns the Time value from the Time Since Harvest grid at the location of a tree.

If there has been no harvest in the tree's grid cell, a value of 1000 will be returned.

Parameters

p_oTree Tree being evaluated

Returns: The time since harvest, in years, at the tree's location.

◆ LocalBasalAreaAroundTree()

float clPostHarvestSkiddingMort::LocalBasalAreaAroundTree ( clTree * p_oTree )

protected

This calculates the basal area (in m2/ha) of all trees within a certain distance of the tree passed as an argument.

Parameters

p_oTree Tree being evaluated

Returns: The local basal area of nearby trees.

◆ PreMortCalcs()

void clPostHarvestSkiddingMort::PreMortCalcs ( clTreePopulation * p_oPop )

virtual

Calls the function to calculate time since the last harvest once per timestep.

Parameters

p_oPop Pointer to tree population object.

Reimplemented from clMortalityBase.

◆ SetupTimeSinceHarvestGrid()

void clPostHarvestSkiddingMort::SetupTimeSinceHarvestGrid ( )

protected

This creates the Years Since Harvest grid at the beginning of the simulation, and sets pointers to grids and saves other relevant grid info in class members.

Member Data Documentation

◆ m_fCrowdingEffectRadius

double clPostHarvestSkiddingMort::m_fCrowdingEffectRadius

protected

Distance from a tree at which local basal area is calculated for crowding effect.

◆ m_iHarvestTypeCode

int clPostHarvestSkiddingMort::m_iHarvestTypeCode

protected

Code for Harvest Type in Harvest Results grid.

◆ m_iLastUpdated

int clPostHarvestSkiddingMort::m_iLastUpdated

protected

Code for LastUpdated (timestep) in the Years Since Last Harvest grid.

◆ m_iNumberYearsPerTimestep

int clPostHarvestSkiddingMort::m_iNumberYearsPerTimestep

protected

Number of years per timestep.

◆ m_iNumSpecies

int clPostHarvestSkiddingMort::m_iNumSpecies

protected

Number of species.

For destructor.

◆ m_iNumXCells

int clPostHarvestSkiddingMort::m_iNumXCells

protected

Number of X cells in grids.

◆ m_iNumYCells

int clPostHarvestSkiddingMort::m_iNumYCells

protected

Number of Y cells in grids.

◆ m_iTimeCode

int clPostHarvestSkiddingMort::m_iTimeCode

protected

Code for Time (since last harvest) in the Years Since Last Harvest grid.

◆ mp_fPreHarvestBackgroundMort

double* clPostHarvestSkiddingMort::mp_fPreHarvestBackgroundMort

protected

Parameter for the annual mortality rate before harvesting.

◆ mp_fSnagRecruitBackgroundProb

double* clPostHarvestSkiddingMort::mp_fSnagRecruitBackgroundProb

protected

Parameter for background post-harvest snag-recruitment mortality.

◆ mp_fSnagRecruitCrowdingEffect

double* clPostHarvestSkiddingMort::mp_fSnagRecruitCrowdingEffect

protected

Parameter for the increase in post-harvest snag-recruitment mortality with crowding.

◆ mp_fSnagRecruitHarvestBasicProb

double* clPostHarvestSkiddingMort::mp_fSnagRecruitHarvestBasicProb

protected

Parameter for the basic post-harvest increase in snag-recruitment mortality.

◆ mp_fSnagRecruitHarvestIntensityEffect

double* clPostHarvestSkiddingMort::mp_fSnagRecruitHarvestIntensityEffect

protected

Parameter for the increase in post-harvest snag-recruitment mortality with nearby harvesting.

◆ mp_fSnagRecruitHarvestRateParam

double* clPostHarvestSkiddingMort::mp_fSnagRecruitHarvestRateParam

protected

Parameter for rate of decrease in post-harvest snag-recruitment mortality with time since harvest.

◆ mp_fWindthrowBackgroundProb

double* clPostHarvestSkiddingMort::mp_fWindthrowBackgroundProb

protected

Parameter for background post-harvest windthrow mortality.

◆ mp_fWindthrowCrowdingEffect

double* clPostHarvestSkiddingMort::mp_fWindthrowCrowdingEffect

protected

Parameter for the decrease in post-harvest windthrow mortality with crowding.

◆ mp_fWindthrowHarvestBasicProb

double* clPostHarvestSkiddingMort::mp_fWindthrowHarvestBasicProb

protected

Parameter for the basic post-harvest increase in windthrow mortality.

◆ mp_fWindthrowHarvestIntensityEffect

double* clPostHarvestSkiddingMort::mp_fWindthrowHarvestIntensityEffect

protected

Parameter for the increase in post-harvest windthrow mortality with nearby harvesting.

◆ mp_fWindthrowHarvestRateParam

double* clPostHarvestSkiddingMort::mp_fWindthrowHarvestRateParam

protected

Parameter for rate of decrease in post-harvest windthrow mortality with time since harvest.

◆ mp_fWindthrowSizeEffect

double* clPostHarvestSkiddingMort::mp_fWindthrowSizeEffect

protected

Parameter for the increase in post-harvest windthrow mortality with size.

◆ mp_iHarvestIntensityCodes

int** clPostHarvestSkiddingMort::mp_iHarvestIntensityCodes

protected

Codes for the harvest intensity around each tree.

◆ mp_oHarvestResultsGrid

clGrid* clPostHarvestSkiddingMort::mp_oHarvestResultsGrid

protected

Pointer to Harvest Results grid.

◆ mp_oTimeSinceHarvestGrid

clGrid* clPostHarvestSkiddingMort::mp_oTimeSinceHarvestGrid

protected

Pointer to Years Since Last Harvest grid.

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

PostHarvestSkiddingMort.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clPostHarvestSkiddingMort()

◆ ~clPostHarvestSkiddingMort()

Member Function Documentation

◆ CalcTimeSinceHarvest()

◆ DoMort()

◆ DoShellSetup()

◆ GetTimeSinceHarvest()

◆ LocalBasalAreaAroundTree()

◆ PreMortCalcs()

◆ SetupTimeSinceHarvestGrid()

Member Data Documentation

◆ m_fCrowdingEffectRadius

◆ m_iHarvestTypeCode

◆ m_iLastUpdated

◆ m_iNumberYearsPerTimestep

◆ m_iNumSpecies

◆ m_iNumXCells

◆ m_iNumYCells

◆ m_iTimeCode

◆ mp_fPreHarvestBackgroundMort

◆ mp_fSnagRecruitBackgroundProb

◆ mp_fSnagRecruitCrowdingEffect

◆ mp_fSnagRecruitHarvestBasicProb

◆ mp_fSnagRecruitHarvestIntensityEffect

◆ mp_fSnagRecruitHarvestRateParam

◆ mp_fWindthrowBackgroundProb

◆ mp_fWindthrowCrowdingEffect

◆ mp_fWindthrowHarvestBasicProb

◆ mp_fWindthrowHarvestIntensityEffect

◆ mp_fWindthrowHarvestRateParam

◆ mp_fWindthrowSizeEffect

◆ mp_iHarvestIntensityCodes

◆ mp_oHarvestResultsGrid

◆ mp_oTimeSinceHarvestGrid