This returns the precipitation effect using a Weibull function. More...
#include <PrecipitationEffectWeibull.h>
Public Member Functions | |
| clPrecipitationEffectWeibull () | |
| Constructor. More... | |
| ~clPrecipitationEffectWeibull () | |
| Destructor. More... | |
| double | CalculatePrecipitationEffect (clPlot *p_oPlot, int iSpecies) |
| Calculates precipitation effect for a particular species. More... | |
| void | DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement) |
| Does any desired setup. More... | |
 Public Member Functions inherited from clPrecipitationEffectBase | |
| clPrecipitationEffectBase () | |
| Constructor. More... | |
| virtual | ~clPrecipitationEffectBase () |
| Destructor. More... | |
| bool | DoesRequireTargetDiam () |
Protected Types | |
| typedef double(clPlot::* | Ptr2Precip) () |
| Define a type for pointers to plot functions for getting precipitation. More... | |
Protected Attributes | |
| Ptr2Precip | m_precip |
| Pointer for the appropriate function for getting precip. More... | |
| double * | mp_fPrecipA |
| Precipitation effect A. More... | |
| double * | mp_fPrecipB |
| Precipitation effect B. More... | |
| double * | mp_fPrecipC |
| Precipitation effect C. More... | |
| Protected Attributes inherited from clPrecipitationEffectBase | |
| bool | bRequiresTargetDiam |
| Whether or not this effect depends on a target diameter being available. More... | |
Additional Inherited Members | |
| Public Types inherited from clPrecipitationEffectBase | |
| enum | precipType { mean_precip, seasonal_precip, water_deficit } |
| Precipitation type. More... | |
Detailed Description
This returns the precipitation effect using a Weibull function.
Three possible precipitation values can be used: mean annual precipitation, seasonal precipitation, or annual water deficit. The function is:
Precipitation Effect = exp(-0.5*(abs(ppt - C)/A)B)
where:
- ppt is the value for the desired form of precipitation, from the plot object
- A, B, and C are parameters
Copyright 2013 Charles D. Canham.
Edit history:
--------------—
June 13, 2013 - Created for transferal of Weibull Climate Growth to the NCI framework (LEM)
October 31, 2013 - Added options for water deficit and seasonal precipitation (LEM)
Member Typedef Documentation
◆ Ptr2Precip
|
protected |
Define a type for pointers to plot functions for getting precipitation.
Constructor & Destructor Documentation
◆ clPrecipitationEffectWeibull()
| clPrecipitationEffectWeibull::clPrecipitationEffectWeibull | ( | ) |
Constructor.
◆ ~clPrecipitationEffectWeibull()
| clPrecipitationEffectWeibull::~clPrecipitationEffectWeibull | ( | ) |
Destructor.
Member Function Documentation
◆ CalculatePrecipitationEffect()
|
virtual |
Calculates precipitation effect for a particular species.
- Parameters
-
p_oPlot Plot object for querying for precipitation values. iSpecies Species for which to calculate precipitation effect.
Implements clPrecipitationEffectBase.
◆ 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 clPrecipitationEffectBase.
Member Data Documentation
◆ m_precip
|
protected |
Pointer for the appropriate function for getting precip.
◆ mp_fPrecipA
|
protected |
Precipitation effect A.
Array is sized number of species.
◆ mp_fPrecipB
|
protected |
Precipitation effect B.
Array is sized number of species.
◆ mp_fPrecipC
|
protected |
Precipitation effect C.
Array is sized number of species.
The documentation for this class was generated from the following file:
