clShadingEffectDefault Class Reference

This implements the default shading effect. More...

#include <ShadingEffectDefault.h>

Inheritance diagram for clShadingEffectDefault:

Public Member Functions
	clShadingEffectDefault ()
	Constructor. More...
	~clShadingEffectDefault ()
	Destructor. More...
double	CalculateShadingEffect (clTree *p_oTree)
	Calculates shading effect. More...
void	DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)
	Does any desired setup. More...
Public Member Functions inherited from clShadingEffectBase
virtual	~clShadingEffectBase ()
	Destructor. More...
virtual void	PreCalcs (clTreePopulation *p_oPop)
	Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...

Protected Attributes
short int **	mp_iLightCodes
	Holds return data codes for the "Light" tree data member. More...
double *	mp_fShadingCoefficient
	Shading coefficient in Shading Effect equation. More...
double *	mp_fShadingExponent
	Shading exponent in Shading Effect equation. More...
int	m_iNumberTotalSpecies
	Number of total species. More...

Detailed Description

This implements the default shading effect.

Shading effect is calculated as follows:

SE = exp(-m * Sⁿ)

where:

• SE = Shading Effect
• m = shading coefficient
• S = light level
• n = shading exponent

Constructor & Destructor Documentation

clShadingEffectDefault()

clShadingEffectDefault::clShadingEffectDefault

(

)

Constructor.

~clShadingEffectDefault()

clShadingEffectDefault::~clShadingEffectDefault

(

)

Destructor.

Member Function Documentation

CalculateShadingEffect()

double clShadingEffectDefault::CalculateShadingEffect ( clTree *  p_oTree )

virtual

Calculates shading effect.

Parameters

p_oTree

Tree for which to calculate shading effect.

Implements clShadingEffectBase.

DoSetup()

void clShadingEffectDefault::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 any species does not have a light behavior assigned (has data member "Light" registered).

Implements clShadingEffectBase.

Member Data Documentation

m_iNumberTotalSpecies

int clShadingEffectDefault::m_iNumberTotalSpecies

protected

Number of total species.

For the destructor.

mp_fShadingCoefficient

double* clShadingEffectDefault::mp_fShadingCoefficient

protected

Shading coefficient in Shading Effect equation.

Array is sized number of species.

mp_fShadingExponent

double* clShadingEffectDefault::mp_fShadingExponent

protected

Shading exponent in Shading Effect equation.

Array is sized number of species.

mp_iLightCodes

short int** clShadingEffectDefault::mp_iLightCodes

protected

Holds return data codes for the "Light" tree data member.

Array size is number of species by number of types.

---

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

• ShadingEffectDefault.h