Calculates the default size effect. More...

#include <SizeEffectDefault.h>

Inheritance diagram for clSizeEffectDefault:

Public Member Functions
	clSizeEffectDefault ()
	Constructor. More...

	~clSizeEffectDefault ()
	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...

Detailed Description

Calculates the default size effect.

Size Effect is calculated as:

SE = exp(-0.5(ln(diam/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

Constructor & Destructor Documentation

◆ clSizeEffectDefault()

clSizeEffectDefault::clSizeEffectDefault ( )

Constructor.

◆ ~clSizeEffectDefault()

clSizeEffectDefault::~clSizeEffectDefault ( )

Destructor.

Member Function Documentation

◆ CalculateSizeEffect()

double clSizeEffectDefault::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 clSizeEffectDefault::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_fX0

double* clSizeEffectDefault::mp_fX0

protected

Size effect mode parameter.

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

◆ mp_fXb

double* clSizeEffectDefault::mp_fXb

protected

Size effect variance parameter.

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

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

SizeEffectDefault.h

Public Member Functions

Protected Attributes