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

This returns the temperature effect using a Weibull function. More...

#include <TemperatureEffectWeibull.h>

Inheritance diagram for clTemperatureEffectWeibull:
clTemperatureEffectBase

Public Member Functions

 clTemperatureEffectWeibull ()
 Constructor. More...
 
 ~clTemperatureEffectWeibull ()
 Destructor. More...
 
double CalculateTemperatureEffect (clPlot *p_oPlot, int iSpecies)
 Calculates temperature 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 clTemperatureEffectBase
 clTemperatureEffectBase ()
 Constructor. More...
 
virtual ~clTemperatureEffectBase ()
 Destructor. More...
 
bool DoesRequireTargetDiam ()
 

Protected Attributes

double * mp_fTempA
 Temperature effect A. More...
 
double * mp_fTempB
 Temperature effect B. More...
 
double * mp_fTempC
 Temperature effect C. More...
 
- Protected Attributes inherited from clTemperatureEffectBase
bool bRequiresTargetDiam
 Whether or not this effect depends on a target diameter being available. More...
 

Detailed Description

This returns the temperature effect using a Weibull function.

The function is:
Temperature Effect = exp(-0.5*(abs(temp - C)/A)B) where:

Copyright 2013 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
June 13, 2013 - Created for transferal of Weibull Climate Growth to the NCI framework (LEM)

Constructor & Destructor Documentation

◆ clTemperatureEffectWeibull()

clTemperatureEffectWeibull::clTemperatureEffectWeibull ( )

Constructor.

◆ ~clTemperatureEffectWeibull()

clTemperatureEffectWeibull::~clTemperatureEffectWeibull ( )

Destructor.

Member Function Documentation

◆ CalculateTemperatureEffect()

double clTemperatureEffectWeibull::CalculateTemperatureEffect ( clPlot p_oPlot,
int  iSpecies 
)
virtual

Calculates temperature effect for a particular species.

Parameters
p_oPlotPlot object for querying for temperature values.
iSpeciesSpecies for which to calculate temperature effect.

Implements clTemperatureEffectBase.

◆ DoSetup()

void clTemperatureEffectWeibull::DoSetup ( clTreePopulation p_oPop,
clBehaviorBase p_oNCI,
xercesc::DOMElement *  p_oElement 
)
virtual

Does any desired setup.

Parameters
p_oPopTree population.
p_oNCINCI behavior object.
p_oElementRoot element of the behavior.
Exceptions
ModelExceptionif Storm Effect parameters are not between 0 and 1.

Implements clTemperatureEffectBase.

Member Data Documentation

◆ mp_fTempA

double* clTemperatureEffectWeibull::mp_fTempA
protected

Temperature effect A.

Array is sized number of species.

◆ mp_fTempB

double* clTemperatureEffectWeibull::mp_fTempB
protected

Temperature effect B.

Array is sized number of species.

◆ mp_fTempC

double* clTemperatureEffectWeibull::mp_fTempC
protected

Temperature effect C.

Array is sized number of species.


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