clSizeEffectCompoundExponential Class Reference

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

#include <SizeEffectCompoundExponential.h>

Inheritance diagram for clSizeEffectCompoundExponential:

Public Member Functions
	clSizeEffectCompoundExponential ()
	Constructor. More...
	~clSizeEffectCompoundExponential ()
	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_fA
	a in Size Effect equation above. More...
double *	mp_fB
	b in Size Effect equation above. More...
double *	mp_fC
	c in Size Effect equation above. More...
double *	mp_fD
	d in Size Effect equation above. More...

Detailed Description

Calculates the size effect with a compound exponential function.

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.

Constructor & Destructor Documentation

clSizeEffectCompoundExponential()

clSizeEffectCompoundExponential::clSizeEffectCompoundExponential

(

)

Constructor.

~clSizeEffectCompoundExponential()

clSizeEffectCompoundExponential::~clSizeEffectCompoundExponential

(

)

Destructor.

Member Function Documentation

CalculateSizeEffect()

double clSizeEffectCompoundExponential::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 clSizeEffectCompoundExponential::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.

Implements clSizeEffectBase.

Member Data Documentation

mp_fA

double* clSizeEffectCompoundExponential::mp_fA

protected

a in Size Effect equation above.

Array is sized number of species.

mp_fB

double* clSizeEffectCompoundExponential::mp_fB

protected

b in Size Effect equation above.

Array is sized number of species.

mp_fC

double* clSizeEffectCompoundExponential::mp_fC

protected

c in Size Effect equation above.

Array is sized number of species.

mp_fD

double* clSizeEffectCompoundExponential::mp_fD

protected

d in Size Effect equation above.

Array is sized number of species.

---

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

• SizeEffectCompoundExponential.h