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

Density Light - Version 1.0. More...

#include <DensityLight.h>

Inheritance diagram for clDensityLight:
clLightBase clBehaviorBase clWorkerBase

Public Member Functions

 clDensityLight (clSimManager *p_oSimManager)
 Constructor. 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 int &iDensity)
 Calculates the mean GLI for a given density. 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...
 
clLightOrgGetLightOrg ()
 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...
 
clSimManagerGetSimManager ()
 
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 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

clGridmp_oLightGrid
 Grid object which holds the light values. More...
 
double m_fA
 The "a" parameter for the mean light function. More...
 
double m_fB
 The "b" parameter for the mean light function. More...
 
double m_fC
 The "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...
 
int m_iChangeThreshold
 The number by which the density 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. More...
 
short int m_iGridCountCode
 Return code for the "Count" data member. More...
 
bool m_bGridUpdated
 Whether or not the "Density 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...
 
stcSpeciesTypeCombomp_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...
 
clSimManagermp_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 clLightOrgmp_oLightOrg
 clLightOrg object - this pointer is held in common by all shells More...
 

Detailed Description

Density Light - Version 1.0.

This behavior calculates light level as a function of local tree density. The density is 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 density has changed by at least an amount set by the user.

A grid, "Density 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:

GLIm = a / (1 + (den/c) b)

where:

When counting trees for the density, seedlings and snags are never counted. 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)/ 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 "Density Light". There's more on that grid below.

The namestring for this behavior is "densitylightshell"; the parameter file call string is "Density Light".

Copyright 2005 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
December 7, 2005 - Created (LEM)

Constructor & Destructor Documentation

◆ clDensityLight()

clDensityLight::clDensityLight ( clSimManager p_oSimManager)

Constructor.

Sets the namestring.

Parameters
p_oSimManagerSim Manager object.

Member Function Documentation

◆ CalcLightValue()

float clDensityLight::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 "Density Light" grid is returned.

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

Implements clLightBase.

◆ DoShellSetup()

void clDensityLight::DoShellSetup ( xercesc::DOMDocument *  p_oDoc)
virtual

Does setup for this behavior.

This reads parameter file values and sets up the grid.

Parameters
p_oDocDOM tree of parsed input file.
Exceptions
modelErrif:
  • The value for c = 0
  • If the density change threshold < 0
  • If the minimum DBH < 0
  • Grid cell lengths of "Density Light" don't divide evenly by the plot lengths

Reimplemented from clLightBase.

◆ GetMeanGLI()

float clDensityLight::GetMeanGLI ( const int &  iDensity)
inline

Calculates the mean GLI for a given density.

This is a separate function largely for testing purposes.

Parameters
iDensityThe tree density.
Returns
Mean GLI, bounded between 0 and 100.

◆ TimestepCleanup()

void clDensityLight::TimestepCleanup ( )
inlinevirtual

Sets the grid updated flag back to false.

Reimplemented from clWorkerBase.

◆ UpdateGridValues()

void clDensityLight::UpdateGridValues ( clTreePopulation p_oPop)
protected

Performs the grid updating each timestep.

It counts up the trees in each cell of the grid. It then compares them to the previous timestep's density. 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_oPopPointer to the tree population.

Member Data Documentation

◆ m_bGridUpdated

bool clDensityLight::m_bGridUpdated
protected

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

◆ m_fA

double clDensityLight::m_fA
protected

The "a" parameter for the mean light function.

◆ m_fB

double clDensityLight::m_fB
protected

The "b" parameter for the mean light function.

◆ m_fC

double clDensityLight::m_fC
protected

The "c" parameter for the mean light function.

◆ m_fMinDbh

double clDensityLight::m_fMinDbh
protected

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

◆ m_fSigma

double clDensityLight::m_fSigma
protected

The sigma parameter of the lognormal PDF function.

◆ m_iChangeThreshold

int clDensityLight::m_iChangeThreshold
protected

The number by which the density in a cell has to change in order to trigger a new light calculation.

◆ m_iGridCountCode

short int clDensityLight::m_iGridCountCode
protected

Return code for the "Count" data member.

◆ m_iGridLightCode

short int clDensityLight::m_iGridLightCode
protected

Return code for the "Light" data member.

◆ mp_oLightGrid

clGrid* clDensityLight::mp_oLightGrid
protected

Grid object which holds the light values.

The name of this grid is "Density Light". It has one float data member called "Light", and one int data member called "Count", which holds the number of trees (that count towards density) 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: