Gap Light - Version 1.0. More...

#include <GapLight.h>

Inheritance diagram for clGapLight:

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

void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	Sets up the "Gap light" grid. More...

float	CalcLightValue (clTree p_oTree, clTreePopulation p_oPop)
	Provides a GLI value for a tree. More...

void	TimestepCleanup ()
	Sets m_bCalcedGaps = false. 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 Member Functions
void	CalculateGapStatus (clTreePopulation *p_oPop)
	Updates the gap status of the "Gap Light" grid. 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_oGapGrid
	Grid object which holds the gap values, called "Gap Light". More...

short int	m_iGapCode
	Return code for the "Is Gap" member of the "Gap Light" grid to get and set GLI in the cells. More...

bool	m_bCalcedGaps
	Whether or not the gap status has been calculated for 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

Gap Light - Version 1.0.

This behavior simplifies GLI calculations by treating GLI as binary: either an area is in gap, and GLI = 100% (full sun), or an area is not in gap, and GLI = 0% (no sun).

This behavior uses a grid object, called "Gap Light", to help it assign GLI values to the trees to which it is assigned. The presence of an adult tree in a cell of "Gap Light" causes that cell's status to be non-gap. The absence of any adult trees in a cell causes it to be gap. For all trees to which this behavior is assigned, if they are in a gap cell, their GLI is set to 100%; otherwise it is 0%.

The namestring is "gaplightshell". The parameter file call string is "GapLight".

Author: Lora E. Murphy

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

Constructor & Destructor Documentation

◆ clGapLight()

clGapLight::clGapLight ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

Parameters

p_oSimManager Sim Manager object.

Member Function Documentation

◆ CalcLightValue()

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

virtual

Provides a GLI value for a tree.

This starts by determining if the gap status has been updated for the timestep (is m_bCalcedGaps = false); if not, then it calls CalculateGapStatus. If the tree is in a gap cell with no adult trees present, the value is 100; otherwise it is 0.

Parameters

p_oTree	Tree for which to get GLI.
p_oPop	Tree population object.

Returns: GLI as a percentage of full sun, either 0 and 100.

Implements clLightBase.

◆ CalculateGapStatus()

void clGapLight::CalculateGapStatus ( clTreePopulation * p_oPop )

protected

Updates the gap status of the "Gap Light" grid.

It asks the tree population for all parent trees; for each tree, the grid cell in which it is is set to gap.

Parameters

p_oPop Tree population object.

◆ DoShellSetup()

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

virtual

Sets up the "Gap light" grid.

Parameters

p_oDoc DOM tree of parsed input file (not used).

Exceptions

modelErr if the grid is incorrectly set up in the parameter file.

Reimplemented from clLightBase.

◆ TimestepCleanup()

void clGapLight::TimestepCleanup ( )

inlinevirtual

Sets m_bCalcedGaps = false.

Reimplemented from clWorkerBase.

Member Data Documentation

◆ m_bCalcedGaps

bool clGapLight::m_bCalcedGaps

protected

Whether or not the gap status has been calculated for this timestep.

◆ m_iGapCode

short int clGapLight::m_iGapCode

protected

Return code for the "Is Gap" member of the "Gap Light" grid to get and set GLI in the cells.

◆ mp_oGapGrid

clGrid* clGapLight::mp_oGapGrid

protected

Grid object which holds the gap values, called "Gap Light".

It has one bool data member called "Is Gap" for holding the gap status, either TRUE (if there are adults in that cell) or FALSE (if there are not).

A map in the parameter file can only set cell resolution; any values in the map will be ignored.

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

GapLight.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clGapLight()

Member Function Documentation

◆ CalcLightValue()

◆ CalculateGapStatus()

◆ DoShellSetup()

◆ TimestepCleanup()

Member Data Documentation

◆ m_bCalcedGaps

◆ m_iGapCode

◆ mp_oGapGrid