clHeightGLIWeibullMortality Class Reference

Height-GLI Weibull Mortality - Version 1.0. More...

#include <HeightGLIWeibullMortality.h>

Inheritance diagram for clHeightGLIWeibullMortality:

clMortalityBase clBehaviorBase clWorkerBase List of all members.

Public Member Functions

 clHeightGLIWeibullMortality (clSimManager *p_oSimManager)
 Constructor.
 ~clHeightGLIWeibullMortality ()
 Destructor.
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Reads in values from the parameter file, then calls GetTreeDataMemberCodes().
bool DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies)
 Calculates mortality according to the equation above.

Protected Member Functions

void GetTreeDataMemberCodes ()
 Queries for the return codes of the "Light" and "Height" tree data members.

Protected Attributes

short int ** mp_iLightCodes
 Return codes for the "Light" tree float data member variable.
short int ** mp_iHeightCodes
 Return codes for the "Height" tree float data member variable.
float * mp_fMaxMort
 Max mortality - sized number of behavior species.
float * mp_fA
 Mortality "a" parameter - sized number of behavior species.
float * mp_fB
 Mortality "b" parameter - sized number of behavior species.
float * mp_fC
 Mortality "c" parameter - sized number of behavior species.
float * mp_fD
 Mortality "d" parameter - sized number of behavior species.
int * mp_iIndexes
 To help access the other arrays.
float m_fYearsPerTimestep
 Number of years per timestep - for converting probabilities for multi- year timesteps.

Detailed Description

Height-GLI Weibull Mortality - Version 1.0.

This evaluates mortality according to a weibull function of tree height and GLI.

The equation used in this behavior is:

p = Mmax * exp(-a * H b - c * GLI d)
where

This class's namestring is "height gli weibull mortshell". The parameter file call string is "Height GLI Weibull Mortality".

Copyright 2006 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
January 26, 2006 - Created (LEM)


Constructor & Destructor Documentation

clHeightGLIWeibullMortality::clHeightGLIWeibullMortality clSimManager p_oSimManager  ) 
 

Constructor.

Parameters:
p_oSimManager Sim Manager object.


Member Function Documentation

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

Calculates mortality according to the equation above.

Then uses a random number to decide if a tree dies.

Parameters:
p_oTree Tree being evaluated
fDbh Tree's DBH
iSpecies Species of the tree being evaluated
Returns:
True if the tree is to die, false if it lives.

Implements clMortalityBase.

void clHeightGLIWeibullMortality::DoShellSetup xercesc::DOMDocument *  p_oDoc  )  [virtual]
 

Reads in values from the parameter file, then calls GetTreeDataMemberCodes().

Parameters:
p_oDoc DOM tree of parsed input file.
Exceptions:
modelErr if the max mortality parameter is not between 0 and 1.

Reimplemented from clMortalityBase.

void clHeightGLIWeibullMortality::GetTreeDataMemberCodes  )  [protected]
 

Queries for the return codes of the "Light" and "Height" tree data members.

Return codes are captured in the mp_iLightCodes and mp_iHeightCodes arrays.

Exceptions:
modelErr if any data member codes are missing.


Member Data Documentation

short int** clHeightGLIWeibullMortality::mp_iHeightCodes [protected]
 

Return codes for the "Height" tree float data member variable.

Array size is number of species to which this behavior applies by number of types

short int** clHeightGLIWeibullMortality::mp_iLightCodes [protected]
 

Return codes for the "Light" tree float data member variable.

Array size is number of species to which this behavior applies by number of types


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 12:51:14 2006 for SORTIE Core C++ Documentation by  doxygen 1.4.6-NO