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

This returns the temperature effect using a double logistic function. More...

#include <TemperatureEffectDoubleLogistic.h>

Inheritance diagram for clTemperatureEffectDoubleLogistic:
clTemperatureEffectBase

Public Member Functions

 clTemperatureEffectDoubleLogistic ()
 Constructor. More...
 
 ~clTemperatureEffectDoubleLogistic ()
 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_fAl
 Temperature effect al. More...
 
double * mp_fBl
 Temperature effect bl. More...
 
double * mp_fCl
 Temperature effect cl. More...
 
double * mp_fAh
 Temperature effect ah. More...
 
double * mp_fBh
 Temperature effect bh. More...
 
double * mp_fCh
 Temperature effect ch. 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 double logistic function.

The function is:

Temperature Effect = (al + ((1-al)/(1+(bl/ppt)^cl))) * (ah + ((1-ah)/(1+(ppt/bh)^ch)))

where:

Copyright 2013 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
December 20, 2013 - Created (LEM)

Constructor & Destructor Documentation

◆ clTemperatureEffectDoubleLogistic()

clTemperatureEffectDoubleLogistic::clTemperatureEffectDoubleLogistic ( )

Constructor.

◆ ~clTemperatureEffectDoubleLogistic()

clTemperatureEffectDoubleLogistic::~clTemperatureEffectDoubleLogistic ( )

Destructor.

Member Function Documentation

◆ CalculateTemperatureEffect()

double clTemperatureEffectDoubleLogistic::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 clTemperatureEffectDoubleLogistic::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_fAh

double* clTemperatureEffectDoubleLogistic::mp_fAh
protected

Temperature effect ah.

Array is sized number of species.

◆ mp_fAl

double* clTemperatureEffectDoubleLogistic::mp_fAl
protected

Temperature effect al.

Array is sized number of species.

◆ mp_fBh

double* clTemperatureEffectDoubleLogistic::mp_fBh
protected

Temperature effect bh.

Array is sized number of species.

◆ mp_fBl

double* clTemperatureEffectDoubleLogistic::mp_fBl
protected

Temperature effect bl.

Array is sized number of species.

◆ mp_fCh

double* clTemperatureEffectDoubleLogistic::mp_fCh
protected

Temperature effect ch.

Array is sized number of species.

◆ mp_fCl

double* clTemperatureEffectDoubleLogistic::mp_fCl
protected

Temperature effect cl.

Array is sized number of species.


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