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

Calculates a crowding effect with no size term. More...

#include <CrowdingEffectNoSize.h>

Inheritance diagram for clCrowdingEffectNoSize:
clCrowdingEffectBase

Public Member Functions

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

float * mp_fC
 Crowding effect slope.
 
float * mp_fD
 Crowding effect steepness.
 
- 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

Calculates a crowding effect with no size term.

This class calculates a crowding effect according to the term:

CE = exp(-C * NCID)

where:

If this is used with an NCI behavior returning 2 values, the format is

CE = exp(-C * nci2D)

Constructor & Destructor Documentation

clCrowdingEffectNoSize::clCrowdingEffectNoSize ( )

Constructor.

clCrowdingEffectNoSize::~clCrowdingEffectNoSize ( )

Destructor.

Member Function Documentation

float clCrowdingEffectNoSize::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.
nciNCI term.
iSpeciesSpecies for which to calculate effect.

Implements clCrowdingEffectBase.

void clCrowdingEffectNoSize::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_oNCIBaseNCI parent behavior object.
p_oElementRoot element of the behavior.

Implements clCrowdingEffectBase.

Member Data Documentation

float* clCrowdingEffectNoSize::mp_fC
protected

Crowding effect slope.

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

float* clCrowdingEffectNoSize::mp_fD
protected

Crowding effect steepness.

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


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