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

Calculates the size effect with a compound exponential function. More...

#include <SizeEffectCompoundExpInf.h>

Inheritance diagram for clSizeEffectCompoundExpInf:
clSizeEffectBase

Public Member Functions

 clSizeEffectCompoundExpInf ()
 Constructor. More...
 
 ~clSizeEffectCompoundExpInf ()
 Destructor. More...
 
double CalculateSizeEffect (clTree *p_oTree, const float &fDiam)
 Calculates size effect. More...
 
void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)
 Does any desired setup. More...
 
- Public Member Functions inherited from clSizeEffectBase
virtual void PreCalcs (clTreePopulation *p_oPop)
 Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...
 
virtual ~clSizeEffectBase ()
 Destructor. More...
 

Protected Attributes

short int ** mp_iDataCodes
 Codes for "YearsInfested" data member. More...
 
double * mp_fA
 a in Size Effect equation above for uninfested trees. More...
 
double * mp_fB
 b in Size Effect equation above for uninfested trees. More...
 
double * mp_fC
 c in Size Effect equation above for uninfested trees. More...
 
double * mp_fD
 d in Size Effect equation above for uninfested trees. More...
 
double * mp_fAInf
 a in Size Effect equation above for infested trees. More...
 
double * mp_fBInf
 b in Size Effect equation above for infested trees. More...
 
double * mp_fCInf
 c in Size Effect equation above for infested trees. More...
 
double * mp_fDInf
 d in Size Effect equation above for infested trees. More...
 
short int m_iNumSpecies
 Number of species. More...
 

Detailed Description

Calculates the size effect with a compound exponential function.

This uses two different sets of parameters, depending on whether a tree is infected or not.

Size Effect is calculated as:

SE = (1-a*exp(b*(diam/100)))*exp(c*((diam/100)d))

where diam is the diameter of the target tree, in cm (d10 for seedlings, DBH for everyone else); and a, b, c, and d are parameters.

Insect infestation is determined by the behavior of class clInsectInfestation or clDensDepInfestation. This class expects to find a "YearsInfested" int data member to be present for all trees to which this behavior is applied.

Constructor & Destructor Documentation

◆ clSizeEffectCompoundExpInf()

clSizeEffectCompoundExpInf::clSizeEffectCompoundExpInf ( )

Constructor.

◆ ~clSizeEffectCompoundExpInf()

clSizeEffectCompoundExpInf::~clSizeEffectCompoundExpInf ( )

Destructor.

Member Function Documentation

◆ CalculateSizeEffect()

double clSizeEffectCompoundExpInf::CalculateSizeEffect ( clTree p_oTree,
const float &  fDiam 
)
virtual

Calculates size effect.

This is bounded between 0 and 1.

Parameters
p_oTreeTree for which to calculate size effect.
fDiamDiameter of tree. Diameter at 10 cm for seedlings, DBH for all other types.

Implements clSizeEffectBase.

◆ DoSetup()

void clSizeEffectCompoundExpInf::DoSetup ( clTreePopulation p_oPop,
clBehaviorBase p_oNCI,
xercesc::DOMElement *  p_oElement 
)
virtual

Does any desired setup.

Parameters
p_oPopTree population.
p_oNCINCI behavior object.
p_oElementRoot element of the behavior.

Implements clSizeEffectBase.

Member Data Documentation

◆ m_iNumSpecies

short int clSizeEffectCompoundExpInf::m_iNumSpecies
protected

Number of species.

For destructor.

◆ mp_fA

double* clSizeEffectCompoundExpInf::mp_fA
protected

a in Size Effect equation above for uninfested trees.

Array is sized number of species.

◆ mp_fAInf

double* clSizeEffectCompoundExpInf::mp_fAInf
protected

a in Size Effect equation above for infested trees.

Array is sized number of species.

◆ mp_fB

double* clSizeEffectCompoundExpInf::mp_fB
protected

b in Size Effect equation above for uninfested trees.

Array is sized number of species.

◆ mp_fBInf

double* clSizeEffectCompoundExpInf::mp_fBInf
protected

b in Size Effect equation above for infested trees.

Array is sized number of species.

◆ mp_fC

double* clSizeEffectCompoundExpInf::mp_fC
protected

c in Size Effect equation above for uninfested trees.

Array is sized number of species.

◆ mp_fCInf

double* clSizeEffectCompoundExpInf::mp_fCInf
protected

c in Size Effect equation above for infested trees.

Array is sized number of species.

◆ mp_fD

double* clSizeEffectCompoundExpInf::mp_fD
protected

d in Size Effect equation above for uninfested trees.

Array is sized number of species.

◆ mp_fDInf

double* clSizeEffectCompoundExpInf::mp_fDInf
protected

d in Size Effect equation above for infested trees.

Array is sized number of species.

◆ mp_iDataCodes

short int** clSizeEffectCompoundExpInf::mp_iDataCodes
protected

Codes for "YearsInfested" data member.

Array size is number of species by number of types.


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