|
SORTIE Core C++ Documentation
|
Stochastic Mortality - Version 1.0. More...
#include <StochasticMort.h>
Public Member Functions | |
| clStochasticMort (clSimManager *p_oSimManager) | |
| Constructor. | |
| ~clStochasticMort () | |
| Destructor. | |
| void | DoShellSetup (xercesc::DOMDocument *p_oDoc) |
| Reads in values from the parameter file. | |
| deadCode | DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies) |
| Calculates mortality stochastically. | |
Public Member Functions inherited from clMortalityBase | |
| clMortalityBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clMortalityBase () |
| Destructor. | |
| void | Action () |
| Performs mortality calculations. | |
| clMortalityOrg * | GetMortOrg () |
| Gets the mortality org object. | |
| void | RegisterTreeDataMembers () |
| Triggers the mortality data member registrations. | |
| short int | GetNewTreeInts () |
| Overridden from clBehaviorBase. | |
| bool | UsesThisMortality (short int iSp, short int iTp) |
| Whether or not a species/type combo uses this mortality object. | |
| virtual void | PreMortCalcs (clTreePopulation *p_oPop) |
| Performs calculations before any trees have been killed. | |
Public Member Functions inherited from clBehaviorBase | |
| virtual float | GetBehaviorVersion () |
| Gets the behavior version number. | |
| clBehaviorBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clBehaviorBase () |
| Destructor. | |
| virtual short int | ValidateVersionNumber (float fTestVersion) |
| Makes sure that the version number of a file passed is between the minimum and current version numbers. | |
| virtual void | SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos) |
| Sets the species/type combos for a behavior. | |
| virtual void | SetNameData (char *cNameString) |
| Sets the string for the parameter file behavior. | |
| virtual short int | GetNewTreeFloats () |
| Gets the number of new tree float data members this behavior wants to register. | |
| virtual short int | GetNewTreeChars () |
| Gets the number of new tree character data members this behavior wants to register. | |
| virtual short int | GetNewTreeBools () |
| Gets the number of new tree bool data members this behavior wants to register. | |
| virtual short int | GetNumSpeciesTypeCombos () |
| Gets the number of species/type combos to which this behavior applies. | |
| virtual short int | GetNumBehaviorSpecies () |
| Gets the number of unique tree species to which this behavior applies. | |
| struct stcSpeciesTypeCombo | GetSpeciesTypeCombo (short int iIndex) |
| Gets one of this behavior's type/species combos. | |
| virtual short int | GetBehaviorSpecies (short int iIndex) |
| Gets one of the behavior's species. | |
| short int | GetBehaviorListNumber () |
| Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. | |
| 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. | |
| virtual DOMElement * | GetParentParametersElement (xercesc::DOMDocument *p_oDoc) |
| Formats the string for species/types query. | |
Public Member Functions inherited from clWorkerBase | |
| clWorkerBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clWorkerBase () |
| Destructor. | |
| char * | GetName () |
| Gets the object's namestring. | |
| void | DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType) |
| Triggers the setup process. | |
| virtual void | TimestepCleanup () |
| Performs any necessary cleanup operations at the end of a timestep. | |
| virtual void | EndOfRunCleanup () |
| Performs any necessary cleanup operations at the end of a run. | |
| virtual void | DoCommand (char *cCommand, char *cArguments) |
| If a behavior has registered a command line command with the sim manager, this allows it to be called. | |
Protected Attributes | |
| float * | mp_fRandomMort |
| Random mortality rate per species. | |
Protected Attributes inherited from clMortalityBase | |
| short int | m_iNumTotalSpecies |
| Keep a copy for the constructor. | |
| bool | m_bHooked |
| Whether or not this shell object is hooked to clMortalityOrg. | |
| bool ** | mp_bUsesThisMortality |
| 2D array, species by type, of whether or not this mortality shell applies to a given species/type combo. | |
Protected Attributes inherited from clBehaviorBase | |
| short int | m_iNumSpeciesTypeCombos |
| How many type/species combos a behavior will act on. | |
| short int | m_iNumBehaviorSpecies |
| How many distinct species are in the combo list - important for filling species-specific values from parameter file. | |
| short int * | mp_iWhatSpecies |
| List of distinct species - for filling species-specific values from parameter file. | |
| stcSpeciesTypeCombo * | mp_whatSpeciesTypeCombos |
| Array of species/type combos that the behavior will act on. | |
| short int | m_iNewTreeInts |
| The number of new tree integer data members this behavior wants to add. | |
| short int | m_iNewTreeFloats |
| The number of new tree float data members this behavior wants to add. | |
| short int | m_iNewTreeChars |
| The number of new tree character data members this behavior wants to add. | |
| short int | m_iNewTreeBools |
| The number of new tree boolean data members this behavior wants to add. | |
| short int | m_iBehaviorListNumber |
| The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. | |
| float | m_fVersionNumber |
| Version number - this will be rounded to 2 digits after the decimal place. | |
| std::string | m_sXMLRoot |
| XML root that encloses the parameters for this behavior. | |
| 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. | |
Protected Attributes inherited from clWorkerBase | |
| char | m_cNameString [MAX_NAMESTRING_SIZE] |
| Object's identifying namestring. | |
| int * | mp_iAllowedFileTypes |
| List of the input file types this object can handle. | |
| int | m_iNumAllowedTypes |
| Number of input file types this object can handle. | |
Additional Inherited Members | |
Protected Member Functions inherited from clMortalityBase | |
| void | GetData (xercesc::DOMDocument *p_oDoc) |
| Triggers all mortality setup. | |
| void | PopulateUsesThisMortality () |
| Declares and populates the mp_bUsesThisMortality array. | |
Static Protected Attributes inherited from clMortalityBase | |
| static clMortalityOrg * | mp_oMortalityOrg |
| clMortalityOrg object. | |
Stochastic Mortality - Version 1.0.
This evaluates stochastic mortality.
This class's namestring is "stochasticmortshell".
Copyright 2003 Charles D. Canham.
Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)
| clStochasticMort::clStochasticMort | ( | clSimManager * | p_oSimManager | ) |
Constructor.
| p_oSimManager | Sim Manager object. |
| clStochasticMort::~clStochasticMort | ( | ) |
Destructor.
|
virtual |
Calculates mortality stochastically.
| fDbh | DBH of tree being evaluated - for seedlings will be 0 |
| p_oTree | Tree being evaluated |
| iSpecies | Species of the tree being evaluated |
Implements clMortalityBase.
|
virtual |
Reads in values from the parameter file.
| p_oDoc | DOM tree of parsed input file. |
Reimplemented from clMortalityBase.
|
protected |
Random mortality rate per species.
This is read as an annual value and compounded to the number of years per timestep during setup.
1.8.2