Calculates a crowding effect with no size term. More...
#include <CrowdingEffectNoSize.h>
Inheritance diagram for clCrowdingEffectNoSize:
Public Member Functions | |
| clCrowdingEffectNoSize () | |
| Constructor. More... | |
| ~clCrowdingEffectNoSize () | |
| 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... | |
| 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 with no size term.
This class calculates a crowding effect according to the term:
where:
- CE = crowding effect
- C and D are parameters
If this is used with an NCI behavior returning 2 values, the format is
Constructor & Destructor Documentation
◆ clCrowdingEffectNoSize()
| clCrowdingEffectNoSize::clCrowdingEffectNoSize | ( | ) |
Constructor.
◆ ~clCrowdingEffectNoSize()
| clCrowdingEffectNoSize::~clCrowdingEffectNoSize | ( | ) |
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.
The documentation for this class was generated from the following file:
