clNCITermBARatio Class Reference

This calculates a basal area ratio for a tree. More...

#include <NCITermBARatio.h>

Inheritance diagram for clNCITermBARatio:

Public Member Functions
	clNCITermBARatio ()
	Constructor. More...
	~clNCITermBARatio ()
	Destructor. More...
ncivals	CalculateNCITerm (clTree *p_oTree, clTreePopulation *p_oPop, clPlot *p_oPlot, const float &fX, const float &fY, const int &iSpecies)
	Calculates NCI according to above equation. More...
void	DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)
	Does setup. More...
Public Member Functions inherited from clNCITermBase
	clNCITermBase ()
	Constructor. More...
int	GetNumberNCIs ()
virtual void	PreCalcs (clTreePopulation *p_oPop)
	Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...
virtual	~clNCITermBase ()
	Destructor. More...
bool	DoesRequireTargetDiam ()

Protected Attributes
double *	mp_fMaxCrowdingRadius
	Maximum search radius, in meters, in which to look for neighbors. More...
double *	mp_fMaxAdultRadius
	Maximum search radius, in meters, in which to look for crowding adult neighbors. More...
double *	mp_fMaxSaplingRadius
	Maximum search radius, in meters, in which to look for crowding sapling neighbors. More...
float	m_fMinSaplingHeight
	Minimum sapling height. More...
Protected Attributes inherited from clNCITermBase
bool	bRequiresTargetDiam
	Whether or not this effect depends on a target diameter being available. More...
int	iNumNCIs
	Number of NCI values calculated and populated into ncivals. More...

Detailed Description

This calculates a basal area ratio for a tree.

This returns two terms: term #1 is the ratio of mean basal area of neighbors to target basal area; and term #2 is the total basal area of neighbors.

NCI ignores neighbors with disturbance and harvest death codes. Natural deaths are NOT ignored, because it presumes that those deaths occurred in the current timestep and they should still be considered as live neighbors.

This behavior uses two different distances to look for neighbors. One is for saplings, and one is for adults.

Constructor & Destructor Documentation

clNCITermBARatio()

clNCITermBARatio::clNCITermBARatio

(

)

Constructor.

~clNCITermBARatio()

clNCITermBARatio::~clNCITermBARatio

(

)

Destructor.

Member Function Documentation

CalculateNCITerm()

ncivals clNCITermBARatio::CalculateNCITerm ( clTree *  p_oTree, clTreePopulation *  p_oPop, clPlot *  p_oPlot, const float &  fX, const float &  fY, const int &  iSpecies  )

virtual

Calculates NCI according to above equation.

Parameters

p_oTree	Tree for which to calculate NCI.
p_oPop	Tree population.
p_oPlot	Plot object.
fX	X coordinate for which to calculate NCI.
fY	Y coordinate for which to calculate NCI.
iSpecies	Species for which to calculate NCI.

Implements clNCITermBase.

DoSetup()

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

virtual

Does setup.

Parameters

p_oPop	Tree population.
p_oNCI	NCI behavior object.
p_oElement	Root element of the behavior.

Exceptions

ModelException

if the max radius of neighbor effects is < 0.

Implements clNCITermBase.

Member Data Documentation

m_fMinSaplingHeight

float clNCITermBARatio::m_fMinSaplingHeight

protected

Minimum sapling height.

For doing neighbor searches.

mp_fMaxAdultRadius

double* clNCITermBARatio::mp_fMaxAdultRadius

protected

Maximum search radius, in meters, in which to look for crowding adult neighbors.

Array is sized number of species.

mp_fMaxCrowdingRadius

double* clNCITermBARatio::mp_fMaxCrowdingRadius

protected

Maximum search radius, in meters, in which to look for neighbors.

Array is sized number of species.

mp_fMaxSaplingRadius

double* clNCITermBARatio::mp_fMaxSaplingRadius

protected

Maximum search radius, in meters, in which to look for crowding sapling neighbors.

Array is sized number of species.

---

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

• NCITermBARatio.h