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

This returns the infection effect using the function:
Infection Effect = [a * ln(T) + b] * exp(-0.5*[( ((DBH-Xp)/X0) / Xb)^2] where: More...

#include <InfectionEffectSizeDependent.h>

Inheritance diagram for clInfectionEffectSizeDependent:
clInfectionEffectBase

Public Member Functions

 clInfectionEffectSizeDependent ()
 Constructor. More...
 
 ~clInfectionEffectSizeDependent ()
 Destructor. More...
 
double CalculateInfectionEffect (clTree *p_oTree)
 Calculates infection 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 clInfectionEffectBase
 clInfectionEffectBase ()
 Constructor. More...
 
virtual ~clInfectionEffectBase ()
 Destructor. More...
 
bool DoesRequireTargetDiam ()
 
virtual void PreCalcs (clTreePopulation *p_oPop)
 Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...
 

Protected Attributes

short int ** mp_iYearsInfestedCodes
 Return codes for the "YearsInfested" int tree data member. More...
 
short int ** mp_iDiamCodes
 Return codes for diameter. More...
 
double * mp_fA
 Infection effect a. More...
 
double * mp_fB
 Infection effect b. More...
 
double * mp_fX0
 Infection effect X0. More...
 
double * mp_fXb
 Infection effect Xb. More...
 
double * mp_fXp
 Infection effect Xp. More...
 
int m_iTotalNumSpecies
 Total number of species. More...
 
- Protected Attributes inherited from clInfectionEffectBase
bool bRequiresTargetDiam
 Whether or not this effect depends on a target diameter being available. More...
 

Detailed Description

This returns the infection effect using the function:
Infection Effect = [a * ln(T) + b] * exp(-0.5*[( ((DBH-Xp)/X0) / Xb)^2] where:

Copyright 2014 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
June 9, 201 - Created (LEM)

Constructor & Destructor Documentation

◆ clInfectionEffectSizeDependent()

clInfectionEffectSizeDependent::clInfectionEffectSizeDependent ( )

Constructor.

◆ ~clInfectionEffectSizeDependent()

clInfectionEffectSizeDependent::~clInfectionEffectSizeDependent ( )

Destructor.

Member Function Documentation

◆ CalculateInfectionEffect()

double clInfectionEffectSizeDependent::CalculateInfectionEffect ( clTree p_oTree)
virtual

Calculates infection effect for a particular species.

Parameters
p_oTreeTree for which to calculate infection effect.

Implements clInfectionEffectBase.

◆ DoSetup()

void clInfectionEffectSizeDependent::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.
Exceptions
ModelExceptionif there is a tree to which this behavior applies that does not have a "YearsInfested" code.

Implements clInfectionEffectBase.

Member Data Documentation

◆ m_iTotalNumSpecies

int clInfectionEffectSizeDependent::m_iTotalNumSpecies
protected

Total number of species.

Primarily for the destructor.

◆ mp_fA

double* clInfectionEffectSizeDependent::mp_fA
protected

Infection effect a.

Array is sized number of species.

◆ mp_fB

double* clInfectionEffectSizeDependent::mp_fB
protected

Infection effect b.

Array is sized number of species.

◆ mp_fX0

double* clInfectionEffectSizeDependent::mp_fX0
protected

Infection effect X0.

Array is sized number of species.

◆ mp_fXb

double* clInfectionEffectSizeDependent::mp_fXb
protected

Infection effect Xb.

Array is sized number of species.

◆ mp_fXp

double* clInfectionEffectSizeDependent::mp_fXp
protected

Infection effect Xp.

Array is sized number of species.

◆ mp_iDiamCodes

short int** clInfectionEffectSizeDependent::mp_iDiamCodes
protected

Return codes for diameter.

Array index one is sized m_iTotalNumSpecies; array index two is sized number of total types.

◆ mp_iYearsInfestedCodes

short int** clInfectionEffectSizeDependent::mp_iYearsInfestedCodes
protected

Return codes for the "YearsInfested" int tree data member.

Array index one is sized m_iTotalNumSpecies; array index two is sized number of total types.


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