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

Calculates a size effect based on a shifted lognormal function. More...

#include <SizeEffectShiftedLognormal.h>

Inheritance diagram for clSizeEffectShiftedLognormal:
clSizeEffectBase

Public Member Functions

 clSizeEffectShiftedLognormal ()
 Constructor. More...
 
 ~clSizeEffectShiftedLognormal ()
 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

double * mp_fXb
 Size effect variance parameter. More...
 
double * mp_fX0
 Size effect mode parameter. More...
 
double * mp_fXp
 Size effect shift parameter. More...
 
double * mp_fMinDiam
 Size effect minimum diameter. More...
 

Detailed Description

Calculates a size effect based on a shifted lognormal function.

Size Effect is calculated as:

SE = exp(-0.5(ln((diam+Xp)/X0)/Xb)2)

where:

Constructor & Destructor Documentation

◆ clSizeEffectShiftedLognormal()

clSizeEffectShiftedLognormal::clSizeEffectShiftedLognormal ( )

Constructor.

◆ ~clSizeEffectShiftedLognormal()

clSizeEffectShiftedLognormal::~clSizeEffectShiftedLognormal ( )

Destructor.

Member Function Documentation

◆ CalculateSizeEffect()

double clSizeEffectShiftedLognormal::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 clSizeEffectShiftedLognormal::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.
Exceptions
ModelExceptionif X0 is < 0 or Xb = 0.

Implements clSizeEffectBase.

Member Data Documentation

◆ mp_fMinDiam

double* clSizeEffectShiftedLognormal::mp_fMinDiam
protected

Size effect minimum diameter.

Array is sized number of species.

◆ mp_fX0

double* clSizeEffectShiftedLognormal::mp_fX0
protected

Size effect mode parameter.

X0 in Size Effect equation above. Array is sized number of species.

◆ mp_fXb

double* clSizeEffectShiftedLognormal::mp_fXb
protected

Size effect variance parameter.

Xb in Size Effect equation above. Array is sized number of species.

◆ mp_fXp

double* clSizeEffectShiftedLognormal::mp_fXp
protected

Size effect shift parameter.

Xp in Size Effect equation above. Array is sized number of species.


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