This returns the damage effect due to storms. More...
#include <DamageEffectDefault.h>
Public Member Functions | |
| clDamageEffectDefault () | |
| Constructor. More... | |
| ~clDamageEffectDefault () | |
| Destructor. More... | |
| double | CalculateDamageEffect (clTree *p_oTree) |
| Calculates damage effect. More... | |
| void | DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement) |
| Does any desired setup. More... | |
 Public Member Functions inherited from clDamageEffectBase | |
| virtual void | PreCalcs (clTreePopulation *p_oPop) |
| Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More... | |
| virtual | ~clDamageEffectBase () |
| Destructor. More... | |
Protected Attributes | |
| short int ** | mp_iDamageCodes |
| Holds return data codes for the "stm_dmg" tree data member. More... | |
| double * | mp_fMedDamageStormEff |
| Damage Effect parameter for target trees with medium damage. More... | |
| double * | mp_fFullDamageStormEff |
| Damage Effect parameter for target trees with full damage. More... | |
| int | m_iNumberTotalSpecies |
| Number of total species. More... | |
Detailed Description
This returns the damage effect due to storms.
Storm Effect is an input parameter. There is one for trees with medium damage and one for trees with full damage. Each is a value between 0 and 1. If the damage counter of the target tree = 0 (tree is undamaged), Storm Effect equals 1.
Constructor & Destructor Documentation
◆ clDamageEffectDefault()
| clDamageEffectDefault::clDamageEffectDefault | ( | ) |
Constructor.
◆ ~clDamageEffectDefault()
| clDamageEffectDefault::~clDamageEffectDefault | ( | ) |
Destructor.
Member Function Documentation
◆ CalculateDamageEffect()
|
virtual |
Calculates damage effect.
- Parameters
-
p_oTree Tree for which to calculate damage effect.
Implements clDamageEffectBase.
◆ DoSetup()
|
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 Storm Effect parameters are not between 0 and 1.
Implements clDamageEffectBase.
Member Data Documentation
◆ m_iNumberTotalSpecies
|
protected |
Number of total species.
For the destructor.
◆ mp_fFullDamageStormEff
|
protected |
Damage Effect parameter for target trees with full damage.
Array is sized number of species.
◆ mp_fMedDamageStormEff
|
protected |
Damage Effect parameter for target trees with medium damage.
Array is sized number of species.
◆ mp_iDamageCodes
|
protected |
Holds return data codes for the "stm_dmg" tree data member.
Array size is number of total species by number of types.
The documentation for this class was generated from the following file:
