clSizeEffectShiftedLognormal Class Reference

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

#include <SizeEffectShiftedLognormal.h>

Inheritance diagram for clSizeEffectShiftedLognormal:

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+X_p)/X₀)/X_b)²)

where:

• diam is the diameter of the target tree, in cm (d10 for seedlings, DBH for everyone else)
• X₀ is the size effect mode, in cm
• X_b is the size effect variance, in cm
• X_p is the size effect shift, in cm

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_oTree	Tree for which to calculate size effect.
fDiam	Diameter 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_oPop	Tree population.
p_oNCI	NCI behavior object.
p_oElement	Root element of the behavior.

Exceptions

ModelException

if 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.

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

mp_fXb

double* clSizeEffectShiftedLognormal::mp_fXb

protected

Size effect variance parameter.

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

mp_fXp

double* clSizeEffectShiftedLognormal::mp_fXp

protected

Size effect shift parameter.

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

---

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

• SizeEffectShiftedLognormal.h