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

This class calculates a crowding effect using the function: More...

#include <CrowdingEffectTempDep.h>

Inheritance diagram for clCrowdingEffectTempDep:
clCrowdingEffectBase

Public Member Functions

 clCrowdingEffectTempDep ()
 Constructor.
 
 ~clCrowdingEffectTempDep ()
 Destructor.
 
float CalculateCrowdingEffect (clTree *p_oTree, const float &fDiam, const clNCITermBase::ncivals nci, const int &iSpecies)
 Calculates crowding effect.
 
void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, clNCIBehaviorBase *p_oNCIBase, xercesc::DOMElement *p_oElement)
 Does setup.
 
- Public Member Functions inherited from clCrowdingEffectBase
 clCrowdingEffectBase ()
 Constructor.
 
virtual ~clCrowdingEffectBase ()
 Destructor.
 
virtual void PreCalcs (clTreePopulation *p_oPop)
 Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs.
 
bool DoesRequireTargetDiam ()
 

Protected Attributes

clPlotmp_oPlot
 Pointer to the plot object, so we can get the temperature.
 
float * mp_fC
 Crowding effect slope.
 
float * mp_fD
 Crowding effect steepness.
 
float * mp_fX0
 X0 in Crowding Effect equation above.
 
float * mp_fXb
 Xb in Crowding Effect equation above.
 
float * mp_fGamma
 Size sensitivity to NCI parameter.
 
- Protected Attributes inherited from clCrowdingEffectBase
bool m_bRequiresTargetDiam
 Whether or not this effect depends on a target diameter being available.
 
bool m_b2ValNCI
 Whether it's a two-value NCI.
 

Detailed Description

This class calculates a crowding effect using the function:

CE = exp(-CT * diam γ * nciD)

where:

CT = C * (1-exp(-0.5 * ((T-X0)/Xb)^2))

where:

Constructor & Destructor Documentation

clCrowdingEffectTempDep::clCrowdingEffectTempDep ( )

Constructor.

clCrowdingEffectTempDep::~clCrowdingEffectTempDep ( )

Destructor.

Member Function Documentation

float clCrowdingEffectTempDep::CalculateCrowdingEffect ( clTree p_oTree,
const float &  fDiam,
const clNCITermBase::ncivals  nci,
const int &  iSpecies 
)
virtual

Calculates crowding effect.

Parameters
p_oTreeTree for which to calculate crowding effect.
fDiamDiameter of tree.
fNCINCI term.
iSpeciesSpecies for which to calculate effect.

Implements clCrowdingEffectBase.

void clCrowdingEffectTempDep::DoSetup ( clTreePopulation p_oPop,
clBehaviorBase p_oNCI,
clNCIBehaviorBase p_oNCIBase,
xercesc::DOMElement *  p_oElement 
)
virtual

Does setup.

Parameters
p_oPopTree population.
p_oNCINCI behavior object.
p_oElementRoot element of the behavior.

Implements clCrowdingEffectBase.

Member Data Documentation

float* clCrowdingEffectTempDep::mp_fC
protected

Crowding effect slope.

C in Crowding Effect equation above. Array sized number of species.

float* clCrowdingEffectTempDep::mp_fD
protected

Crowding effect steepness.

D in Crowding Effect equation above. Array sized number of species.

float* clCrowdingEffectTempDep::mp_fGamma
protected

Size sensitivity to NCI parameter.

γ in Crowding Effect equation above. Array sized number of species.

float* clCrowdingEffectTempDep::mp_fX0
protected

X0 in Crowding Effect equation above.

Array sized number of species.

float* clCrowdingEffectTempDep::mp_fXb
protected

Xb in Crowding Effect equation above.

Array sized number of species.

clPlot* clCrowdingEffectTempDep::mp_oPlot
protected

Pointer to the plot object, so we can get the temperature.


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