Calculates a crowding effect which is a slight variation on the one in clDefaultCrowdingEffect. More...
#include <CrowdingEffect2.h>
Public Member Functions | |
| clCrowdingEffectTwo () | |
| Constructor. More... | |
| ~clCrowdingEffectTwo () | |
| Destructor. More... | |
| double | CalculateCrowdingEffect (clTree *p_oTree, const float &fDiam, const clNCITermBase::ncivals nci, const int &iSpecies) |
| Calculates crowding effect. More... | |
| void | DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, clNCIBehaviorBase *p_oNCIBase, xercesc::DOMElement *p_oElement) |
| Does setup. More... | |
 Public Member Functions inherited from clCrowdingEffectBase | |
| clCrowdingEffectBase () | |
| Constructor. More... | |
| virtual | ~clCrowdingEffectBase () |
| Destructor. More... | |
| virtual void | PreCalcs (clTreePopulation *p_oPop) |
| Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More... | |
| bool | DoesRequireTargetDiam () |
Protected Attributes | |
| double * | mp_fC |
| Crowding effect slope. More... | |
| double * | mp_fD |
| Crowding effect steepness. More... | |
| double * | mp_fGamma |
| Size sensitivity to NCI parameter. More... | |
| Protected Attributes inherited from clCrowdingEffectBase | |
| bool | m_bRequiresTargetDiam |
| Whether or not this effect depends on a target diameter being available. More... | |
| bool | m_b2ValNCI |
| Whether it's a two-value NCI. More... | |
Detailed Description
Calculates a crowding effect which is a slight variation on the one in clDefaultCrowdingEffect.
This class calculates a crowding effect according to the term:
where:
- CE = crowding effect
- C, D, and γ are parameters
- diam is diameter of the target tree, in cm (d10 for seedlings, DBH for everyone else)
- NCI is this tree's NCI value
This is originally from the BA NCI behavior.
I'm calling this "Crowding effect 2" because it's just a slight variation on the default and I didn't know what else to call it.
Alternately, this can use NCI behaviors returning 2 values, in which case the format is
Constructor & Destructor Documentation
◆ clCrowdingEffectTwo()
| clCrowdingEffectTwo::clCrowdingEffectTwo | ( | ) |
Constructor.
◆ ~clCrowdingEffectTwo()
| clCrowdingEffectTwo::~clCrowdingEffectTwo | ( | ) |
Destructor.
Member Function Documentation
◆ CalculateCrowdingEffect()
|
virtual |
Calculates crowding effect.
- Parameters
-
p_oTree Tree for which to calculate crowding effect. fDiam Diameter of tree. nci NCI term. iSpecies Species for which to calculate effect.
Implements clCrowdingEffectBase.
◆ DoSetup()
|
virtual |
Does setup.
- Parameters
-
p_oPop Tree population. p_oNCI NCI behavior object. p_oNCIBase NCI parent behavior object. p_oElement Root element of the behavior.
Implements clCrowdingEffectBase.
Member Data Documentation
◆ mp_fC
|
protected |
Crowding effect slope.
C in Crowding Effect equation above. Array sized number of species.
◆ mp_fD
|
protected |
Crowding effect steepness.
D in Crowding Effect equation above. Array sized number of species.
◆ mp_fGamma
|
protected |
Size sensitivity to NCI parameter.
γ in Crowding Effect equation above. Array sized number of species.
The documentation for this class was generated from the following file:
