SORTIE Core C++ Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clBCMort Class Reference

BC Mortality - Version 1.0. More...

#include <BCMort.h>

Inheritance diagram for clBCMort:
clMortalityBase clBehaviorBase clWorkerBase

Public Member Functions

 clBCMort (clSimManager *p_oSimManager)
 Constructor. More...
 
 ~clBCMort ()
 Destructor. More...
 
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Reads in values from the parameter file and makes sure all data needed is collected. More...
 
deadCode DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies)
 Calculates mortality according to the BC mortality equation. More...
 
- Public Member Functions inherited from clMortalityBase
 clMortalityBase (clSimManager *p_oSimManager)
 Constructor. More...
 
virtual ~clMortalityBase ()
 Destructor. More...
 
void Action ()
 Performs mortality calculations. More...
 
clMortalityOrgGetMortOrg ()
 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...
 
clSimManagerGetSimManager ()
 
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 GetGrowthVariableCodes ()
 Queries for the return codes of the "Growth" float data member of 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

short int ** mp_iGrowthCodes
 Data member codes for "Growth" member - species by type. More...
 
double * mp_fMortAtZeroGrowth
 Mortality at zero growth - old code m1. More...
 
double * mp_fLightDepMort
 Light dependent mortality - old code m2. 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...
 
stcSpeciesTypeCombomp_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...
 
clSimManagermp_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 clMortalityOrgmp_oMortalityOrg
 clMortalityOrg object. More...
 

Detailed Description

BC Mortality - Version 1.0.

This evaluates mortality according to the BC mortality equation.

This class's namestring is "bcmortshell". The parameter file call string is "BCMortality".

NOTE from old code: mortality function in Kobe and Coates(1997) uses annual mm growth new function is not correct if m1 != 1.0 (Confirm this statement)

Copyright 2011 Charles D. Canham.

Author
Lora E. Murphy


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

Constructor & Destructor Documentation

◆ clBCMort()

clBCMort::clBCMort ( clSimManager p_oSimManager)

Constructor.

Sets the namestring.

◆ ~clBCMort()

clBCMort::~clBCMort ( )

Destructor.

Member Function Documentation

◆ DoMort()

deadCode clBCMort::DoMort ( clTree p_oTree,
const float &  fDbh,
const short int &  iSpecies 
)
virtual

Calculates mortality according to the BC mortality equation.

Parameters
fDbhDBH of tree being evaluated - for seedlings will be 0
p_oTreeTree being evaluated
iSpeciesSpecies of the tree being evaluated
Returns
natural if the tree is to die, notdead if it lives.

Implements clMortalityBase.

◆ DoShellSetup()

void clBCMort::DoShellSetup ( xercesc::DOMDocument *  p_oDoc)
virtual

Reads in values from the parameter file and makes sure all data needed is collected.

Parameters
p_oDocParsed DOM tree of parameter file.

Reimplemented from clMortalityBase.

◆ GetGrowthVariableCodes()

void clBCMort::GetGrowthVariableCodes ( )
protected

Queries for the return codes of the "Growth" float data member of a tree.

This data member should have been registered by clGrowthBase child classes. Return codes are captured in the mp_iGrowthCodes array.

Exceptions
modelErrif there is no code for any species/type combo which uses this behavior.

Member Data Documentation

◆ m_iNumberYearsPerTimestep

int clBCMort::m_iNumberYearsPerTimestep
protected

Number of years per timestep.

◆ mp_fLightDepMort

double* clBCMort::mp_fLightDepMort
protected

Light dependent mortality - old code m2.

◆ mp_fMortAtZeroGrowth

double* clBCMort::mp_fMortAtZeroGrowth
protected

Mortality at zero growth - old code m1.

◆ mp_iGrowthCodes

short int** clBCMort::mp_iGrowthCodes
protected

Data member codes for "Growth" member - species by type.


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