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

This returns the nitrogen effect using a gaussian function. More...

#include <NitrogenEffectGaussian.h>

Inheritance diagram for clNitrogenEffectGaussian:
clNitrogenEffectBase

Public Member Functions

 clNitrogenEffectGaussian ()
 Constructor. More...
 
 ~clNitrogenEffectGaussian ()
 Destructor. More...
 
double CalculateNitrogenEffect (clPlot *p_oPlot, int iSpecies)
 Calculates nitrogen effect for a particular species. More...
 
void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)
 Does setup. More...
 
- Public Member Functions inherited from clNitrogenEffectBase
 clNitrogenEffectBase ()
 Constructor. More...
 
virtual ~clNitrogenEffectBase ()
 Destructor. More...
 
bool DoesRequireTargetDiam ()
 

Protected Attributes

double * mp_fX0
 Nitrogen effect X0. More...
 
double * mp_fXb
 Nitrogen effect Xb. More...
 
- Protected Attributes inherited from clNitrogenEffectBase
bool bRequiresTargetDiam
 Whether or not this effect depends on a target diameter being available. More...
 

Detailed Description

This returns the nitrogen effect using a gaussian function.

The function is:
Nitrogen Effect = exp(-0.5*((NDEP - X0) / Xb)2) where:

Copyright 2013 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
June 27, 2013 - Created (LEM)

Constructor & Destructor Documentation

◆ clNitrogenEffectGaussian()

clNitrogenEffectGaussian::clNitrogenEffectGaussian ( )

Constructor.

◆ ~clNitrogenEffectGaussian()

clNitrogenEffectGaussian::~clNitrogenEffectGaussian ( )

Destructor.

Member Function Documentation

◆ CalculateNitrogenEffect()

double clNitrogenEffectGaussian::CalculateNitrogenEffect ( clPlot p_oPlot,
int  iSpecies 
)
virtual

Calculates nitrogen effect for a particular species.

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

Implements clNitrogenEffectBase.

◆ DoSetup()

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

Does setup.

Parameters
p_oPopTree population.
p_oNCINCI behavior object.
p_oElementRoot element of the behavior.

Implements clNitrogenEffectBase.

Member Data Documentation

◆ mp_fX0

double* clNitrogenEffectGaussian::mp_fX0
protected

Nitrogen effect X0.

Array is sized number of species.

◆ mp_fXb

double* clNitrogenEffectGaussian::mp_fXb
protected

Nitrogen effect Xb.

Array is sized number of species.


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