Basal Area Light - Version 1.0. More...

#include <BasalAreaLight.h>

Inheritance diagram for clBasalAreaLight:

Public Member Functions
	clBasalAreaLight (clSimManager *p_oSimManager)
	Constructor. More...

	~clBasalAreaLight ()
	Destructor. More...

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Does setup for this behavior. More...

void	TimestepCleanup ()
	Sets the grid updated flag back to false. More...

float	CalcLightValue (clTree p_oTree, clTreePopulation p_oPop)
	Gets the light value for a particular tree. More...

float	GetMeanGLI (const float &fConiferBA, const float &fAngiospermBA)
	Calculates the mean GLI for a given pair of basal areas. More...

Public Member Functions inherited from clLightBase
	clLightBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clLightBase ()
	Destructor. More...

void	Action ()
	Performs all light calculations. More...

void	RegisterTreeDataMembers ()
	Performs data member registrations for "Light". More...

clLightOrg *	GetLightOrg ()
	Gets the light org object. More...

float	GetMinSunAngle ()
	Gets the altitude angle below which the sky is assumed to be dark. More...

float	GetNumAziAng ()
	Gets the number of azimuth angles into which the sky hemisphere is divided. More...

float	GetNumAltAng ()
	Gets the number of altitude angles into which the sky hemisphere is divided. More...

float	GetMinAngRow ()
	Gets the row in the brightness array corresponding to the minimum solar angle. More...

float	GetBrightness (int alt, int azi)

Public Member Functions inherited from clBehaviorBase
virtual float	GetBehaviorVersion ()
	Gets the behavior version number. More...

	clBehaviorBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clBehaviorBase ()
	Destructor. More...

virtual short int	ValidateVersionNumber (float fTestVersion)
	Makes sure that the version number of a file passed is between the minimum and current version numbers. More...

virtual void	SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
	Sets the species/type combos for a behavior. More...

virtual void	SetNameData (std::string sNameString)
	Sets the string for the parameter file behavior. More...

virtual short int	GetNewTreeInts ()
	Gets the number of new tree integer data members this behavior wants to register. More...

virtual short int	GetNewTreeFloats ()
	Gets the number of new tree float data members this behavior wants to register. More...

virtual short int	GetNewTreeChars ()
	Gets the number of new tree character data members this behavior wants to register. More...

virtual short int	GetNewTreeBools ()
	Gets the number of new tree bool data members this behavior wants to register. More...

virtual short int	GetNumSpeciesTypeCombos ()
	Gets the number of species/type combos to which this behavior applies. More...

virtual short int	GetNumBehaviorSpecies ()
	Gets the number of unique tree species to which this behavior applies. More...

struct stcSpeciesTypeCombo	GetSpeciesTypeCombo (short int iIndex)
	Gets one of this behavior's type/species combos. More...

virtual short int	GetBehaviorSpecies (short int iIndex)
	Gets one of the behavior's species. More...

short int	GetBehaviorListNumber ()
	Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

void	SetBehaviorListNumber (short int iNumber)
	Sets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

std::string	FormatSpeciesTypeQueryString ()
	Formats the string for species/types query. More...

virtual DOMElement *	GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
	This will get the correct set of parameters for this behavior based on the behavior list position number. More...

Public Member Functions inherited from clWorkerBase
	clWorkerBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clWorkerBase ()
	Destructor. More...

std::string	GetName ()
	Gets the object's namestring. More...

clSimManager *	GetSimManager ()

void	DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
	Triggers the setup process. More...

virtual void	EndOfRunCleanup ()
	Performs any necessary cleanup operations at the end of a run. More...

Protected Types
enum	iTreeType { angiosperm, conifer }
	Species type status. More...

Protected Member Functions
void	UpdateGridValues (clTreePopulation *p_oPop)
	Performs the grid updating each timestep. More...

Protected Member Functions inherited from clLightBase
void	GetData (xercesc::DOMDocument *p_oDoc)
	Triggers all light setup. More...

void	PopulateGLIBrightnessArray ()
	Populates the GLI brightness array. More...

void	PopulateSailLightBrightnessArray ()
	Populates the sail brightness array. More...

float	GetDayAngle (int iJulianDay)
	Computes day angle. More...

float	GetDeclination (float &fDayAngle)
	Computes solar declination. More...

float	GetEccentricity (float &fDayAngle)
	Computes solar eccentricity. More...

float	GetSunrise (float &fLatInRadians, float &fDeclination)
	Computes sunrise. More...

float	GetCosineOfZenithAngle (float &fDeclination, float &fLatInRadians, float &fTimeNow)
	Computes cosine of the zenith angle of the sun at a given time. More...

float	GetAltitudeAngle (float &fCosZenAng)
	Computes altitude angle of the sun at a given time in radians. More...

float	GetAzimuthAngle (float &fDeclination, float &fLatInRadians, float &fAltInRad, float &fTimeNow)
	Computes azimuth angle of the sun at a given time in radians in SORTIE azimuth coordinates. More...

float	GetAirmassEffect (float &fAltInDeg, float &fCosZenAng)
	Computes the airmass effect for a given altitude angle. More...

float	GetBeamRadiation (float &fClearSkyTransCoeff, float &fAirmass, float &fEccentricity, float &fCosZenAng)
	Computes beam radiation strength. More...

virtual float	GetLightExtinctionCoefficient (clTree *p_oTree)
	Gets the light extinction coefficent. More...

Protected Member Functions inherited from clWorkerBase
void	AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
	Creates the proper identifying filecode for an XML file. More...

Protected Attributes
clGrid *	mp_oLightGrid
	Grid object which holds the light values. More...

enum clBasalAreaLight::iTreeType *	mp_iSpeciesTypes
	What type each species is. More...

float *	mp_fStatus
	The status of each species, as angiosperm or conifer. More...

double	m_fA
	The "a" parameter for the mean light function. More...

double	m_fConiferB
	The conifer "b" parameter for the mean light function. More...

double	m_fAngiospermB
	The angiosperm "b" parameter for the mean light function. More...

double	m_fConiferC
	The conifer "c" parameter for the mean light function. More...

double	m_fAngiospermC
	The angiosperm "c" parameter for the mean light function. More...

double	m_fSigma
	The sigma parameter of the lognormal PDF function. More...

double	m_fMinDbh
	The minimum DBH for trees to count towards density in a cell. More...

double	m_fRadius
	The search radius for trees. More...

double	m_fChangeThreshold
	The amount by which total basal area in a cell has to change in order to trigger a new light calculation. More...

short int	m_iGridLightCode
	Return code for the "Light" data member of the "Basal Area Light" grid. More...

short int	m_iGridConBACode
	Return code for the "Con BA" data member of the "Basal Area Light" grid. More...

short int	m_iGridAngBACode
	Return code for the "Ang BA" data member of the "Basal Area Light" grid. More...

bool	m_bGridUpdated
	Whether or not the "Basal Area Light" grid has been updated this timestep. More...

Protected Attributes inherited from clLightBase
bool	m_bHooked
	Whether or not this shell object is hooked to clLightOrg. More...

bool	m_bNeedsCommonParameters
	Whether or not this shell object requires the common light parameters held in clLightOrg such as clLightOrg::m_iLastJulDay. More...

float **	mp_fBrightness
	Sky brightness array. More...

float **	mp_fPhoto
	Simulated fisheye photo array. More...

double	m_fMinSunAngle
	The altitude angle below which the sky is assumed to be dark. More...

double	m_fAzimuthOfNorth
	The azimuth angle of north. More...

int	m_iNumAziAng
	Number of azimuth angles into which the sky hemisphere is divided. More...

int	m_iNumAltAng
	Number of altitude angles into which the sky hemisphere is divided. More...

int	m_iMinAngRow
	Row in the brightness array corresponding to the minimum solar angle. More...

Protected Attributes inherited from clBehaviorBase
short int	m_iNumSpeciesTypeCombos
	How many type/species combos a behavior will act on. More...

short int	m_iNumBehaviorSpecies
	How many distinct species are in the combo list - important for filling species-specific values from parameter file. More...

short int *	mp_iWhatSpecies
	List of distinct species - for filling species-specific values from parameter file. More...

stcSpeciesTypeCombo *	mp_whatSpeciesTypeCombos
	Array of species/type combos that the behavior will act on. More...

short int	m_iNewTreeInts
	The number of new tree integer data members this behavior wants to add. More...

short int	m_iNewTreeFloats
	The number of new tree float data members this behavior wants to add. More...

short int	m_iNewTreeChars
	The number of new tree character data members this behavior wants to add. More...

short int	m_iNewTreeBools
	The number of new tree boolean data members this behavior wants to add. More...

short int	m_iBehaviorListNumber
	The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. More...

float	m_fVersionNumber
	Version number - this will be rounded to 2 digits after the decimal place. More...

std::string	m_sXMLRoot
	XML root that encloses the parameters for this behavior. More...

float	m_fMinimumVersionNumber
	Minimum version number - this behavior will run parameter data for a file marked between this number and the current version number, inclusive. More...

Protected Attributes inherited from clWorkerBase
std::string	m_sNameString
	If a behavior has registered a command line command with the sim manager, this allows it to be called. More...

clSimManager *	mp_oSimManager
	Pointer to the simulation manager object. More...

int *	mp_iAllowedFileTypes
	List of the input file types this object can handle. More...

int	m_iNumAllowedTypes
	Number of input file types this object can handle. More...

Additional Inherited Members
Static Protected Attributes inherited from clLightBase
static clLightOrg *	mp_oLightOrg
	clLightOrg object - this pointer is held in common by all shells More...

Detailed Description

Basal Area Light - Version 1.0.

This behavior calculates light level as a function of local tree basal area. Basal area is split between conifers and angiosperms. The two basal area totals are used to calculate a mean light level, which is used to choose a random value from a lognormal probability distribution. In order to ensure some level of continuity through time, a grid cell's light level is not recalculated unless the local tree basal area has changed by more than a threshold set by the user.

A grid, "Basal Area Light", is used to store light values. Trees get the light levels of their grid cell.

The mean light level for a grid cell is calculated as follows:

GLI_m = a / (1 + (BA_a/c_a) ^b_a + (1 + (BA_c/c_c) ^b_c)

where:

GLI_m is the mean light level, as a value between 0 and 100
BA_a is angiosperm basal area, in square meters, within the user-specified radius of the "Basal Area Light" cell's center
BA_c is conifer basal area, in square meters, within the user-specified radius of the "Basal Area Light" cell's center
a is a parameter
b_a and c_a are parameters for angiosperms
b_c and c_c are parameters for conifers

For purposes of basal area calculation, each species is assigned to "conifer" or "angiosperm" status. Seedlings and snags are never counted in basal area. Other trees only count if they have a DBH above a user-set minimum.

After the mean light level is calculated, it is turned into a "location parameter" (mu) for the lognormal PDF as follows:

μ = ln(mean) - (σ ²)/ 2

The mu value is used as the zeta value in a lognormal random draw.

Note that this behavior is dependent on the size of grid cells for its behavior.

This behavior creates a new grid called "Basal Area Light". There's more on that grid below.

The namestring for this behavior is "basalarealightshell"; the parameter file call string is "BasalAreaLight".

Author: Lora E. Murphy

Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)

Member Enumeration Documentation

◆ iTreeType

enum clBasalAreaLight::iTreeType

protected

Species type status.

Enumerator
angiosperm	Angiosperm.
conifer	Conifer.

Constructor & Destructor Documentation

◆ clBasalAreaLight()

clBasalAreaLight::clBasalAreaLight ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

Parameters

p_oSimManager Sim Manager object.

◆ ~clBasalAreaLight()

clBasalAreaLight::~clBasalAreaLight ( )

Destructor.

Frees memory.

Member Function Documentation

◆ CalcLightValue()

float clBasalAreaLight::CalcLightValue	(	clTree *	p_oTree,
		clTreePopulation *	p_oPop
	)

virtual

Gets the light value for a particular tree.

First, it checks to see if the grid has been updated this timestep. If not, then UpdateGridValues() is called. Then the value in the tree's grid cell of the "Basal Area Light" grid is returned.

Returns: GLI value, as recorded in the tree's "Density Light" grid cell.

Implements clLightBase.

◆ DoShellSetup()

void clBasalAreaLight::DoShellSetup ( xercesc::DOMDocument * p_oDoc )

virtual

Does setup for this behavior.

This reads parameter file values and sets up the grid.

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr

if:

The value for either c = 0
If the density change threshold < 0
If the minimum DBH < 0
If the neighbor search radius < 0

Reimplemented from clLightBase.

◆ GetMeanGLI()

float clBasalAreaLight::GetMeanGLI	(	const float &	fConiferBA,
		const float &	fAngiospermBA
	)

inline

Calculates the mean GLI for a given pair of basal areas.

This is a separate function largely for testing purposes.

Parameters

fConiferBA	The conifer basal area, in square meters.
fAngiospermBA	The angiosperm basal area, in square meters.

Returns: Mean GLI, bounded between 0 and 100.

◆ TimestepCleanup()

void clBasalAreaLight::TimestepCleanup ( )

inlinevirtual

Sets the grid updated flag back to false.

Reimplemented from clWorkerBase.

◆ UpdateGridValues()

void clBasalAreaLight::UpdateGridValues ( clTreePopulation * p_oPop )

protected

Performs the grid updating each timestep.

It totals up angiosperm and conifer basal area within the search radius for each grid cell. It then compares them to the previous timestep's total. For any cell that has changed by more than the change threshold, a new light level is calculated. At the end, this sets m_bGridUpdated to true.

Parameters

p_oPop Pointer to the tree population.

Member Data Documentation

◆ m_bGridUpdated

bool clBasalAreaLight::m_bGridUpdated

protected

Whether or not the "Basal Area Light" grid has been updated this timestep.

◆ m_fA

double clBasalAreaLight::m_fA

protected

The "a" parameter for the mean light function.

◆ m_fAngiospermB

double clBasalAreaLight::m_fAngiospermB

protected

The angiosperm "b" parameter for the mean light function.

◆ m_fAngiospermC

double clBasalAreaLight::m_fAngiospermC

protected

The angiosperm "c" parameter for the mean light function.

◆ m_fChangeThreshold

double clBasalAreaLight::m_fChangeThreshold

protected

The amount by which total basal area in a cell has to change in order to trigger a new light calculation.

◆ m_fConiferB

double clBasalAreaLight::m_fConiferB

protected

The conifer "b" parameter for the mean light function.

◆ m_fConiferC

double clBasalAreaLight::m_fConiferC

protected

The conifer "c" parameter for the mean light function.

◆ m_fMinDbh

double clBasalAreaLight::m_fMinDbh

protected

The minimum DBH for trees to count towards density in a cell.

◆ m_fRadius

double clBasalAreaLight::m_fRadius

protected

The search radius for trees.

◆ m_fSigma

double clBasalAreaLight::m_fSigma

protected

The sigma parameter of the lognormal PDF function.

◆ m_iGridAngBACode

short int clBasalAreaLight::m_iGridAngBACode

protected

Return code for the "Ang BA" data member of the "Basal Area Light" grid.

◆ m_iGridConBACode

short int clBasalAreaLight::m_iGridConBACode

protected

Return code for the "Con BA" data member of the "Basal Area Light" grid.

◆ m_iGridLightCode

short int clBasalAreaLight::m_iGridLightCode

protected

Return code for the "Light" data member of the "Basal Area Light" grid.

◆ mp_fStatus

float* clBasalAreaLight::mp_fStatus

protected

The status of each species, as angiosperm or conifer.

◆ mp_iSpeciesTypes

enum clBasalAreaLight::iTreeType * clBasalAreaLight::mp_iSpeciesTypes

protected

What type each species is.

◆ mp_oLightGrid

clGrid* clBasalAreaLight::mp_oLightGrid

protected

Grid object which holds the light values.

The name of this grid is "Basal Area Light". It has one float data member called "Light", and two float data members called "Con BA" and "Ang BA", which hold the basal area of conifers and angiosperms, respectively, in the cell. It uses the default grid cell resolution unless otherwise instructed in the parameter file. A map of this grid in the parameter file will be honored.

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

BasalAreaLight.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ iTreeType

Constructor & Destructor Documentation

◆ clBasalAreaLight()

◆ ~clBasalAreaLight()

Member Function Documentation

◆ CalcLightValue()

◆ DoShellSetup()

◆ GetMeanGLI()

◆ TimestepCleanup()

◆ UpdateGridValues()

Member Data Documentation

◆ m_bGridUpdated

◆ m_fA

◆ m_fAngiospermB

◆ m_fAngiospermC

◆ m_fChangeThreshold

◆ m_fConiferB

◆ m_fConiferC

◆ m_fMinDbh

◆ m_fRadius

◆ m_fSigma

◆ m_iGridAngBACode

◆ m_iGridConBACode

◆ m_iGridLightCode

◆ mp_fStatus

◆ mp_iSpeciesTypes

◆ mp_oLightGrid