clStochasticMort Class Reference

Stochastic Mortality - Version 1.0. More...

#include <StochasticMort.h>

Inheritance diagram for clStochasticMort:

clMortalityBase clBehaviorBase clWorkerBase List of all members.

Public Member Functions

 clStochasticMort (clSimManager *p_oSimManager)
 Constructor.
 ~clStochasticMort ()
 Destructor.
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Reads in values from the parameter file.
bool DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies)
 Calculates mortality stochastically.
void SetNameData (char *cNameString)
 Captures the behavior name passed from the parameter file.

Protected Attributes

float * mp_fRandomMort
 Random mortality rate per species.
bool m_bIsAdult
 If true - adult stochastic - if false, juvenile.

Detailed Description

Stochastic Mortality - Version 1.0.

This evaluates stochastic mortality, either adult or juvenile. The one that is done depends on which behavior name string is put in the parameter file - either "adultstochasticmort" or "juvstochasticmort". This controls which set of parameters is read in from the parameter file. The self-thinning is calculated the same way either way. There may be more than one object of this class running around.

This class's namestring is "stochasticmortshell".

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta (LEM)


Constructor & Destructor Documentation

clStochasticMort::clStochasticMort ( clSimManager p_oSimManager  ) 

Constructor.

Parameters:
p_oSimManager Sim Manager object.


Member Function Documentation

void clStochasticMort::DoShellSetup ( xercesc::DOMDocument *  p_oDoc  )  [virtual]

Reads in values from the parameter file.

Parameters:
p_oDoc DOM tree of parsed input file.

Reimplemented from clMortalityBase.

bool clStochasticMort::DoMort ( clTree p_oTree,
const float &  fDbh,
const short int &  iSpecies 
) [virtual]

Calculates mortality stochastically.

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:
True if the tree is to die, false if it lives.

Implements clMortalityBase.

void clStochasticMort::SetNameData ( char *  cNameString  )  [virtual]

Captures the behavior name passed from the parameter file.

This is useful since this class can produce a few different kinds of behaviors.

Parameters:
cNameString Behavior name from parameter file.

Reimplemented from clBehaviorBase.


Member Data Documentation

float* clStochasticMort::mp_fRandomMort [protected]

Random mortality rate per species.

This is read as an annual value and compounded to the number of years per timestep during setup.

bool clStochasticMort::m_bIsAdult [protected]

If true - adult stochastic - if false, juvenile.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:30:45 2007 for SORTIE Core C++ Documentation by  doxygen 1.5.2