GLIMapCreator - Version 1.0. More...

#include <GLIMap.h>

Inheritance diagram for clGLIMap:

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

void	GetData (xercesc::DOMDocument *p_oDoc)
	Does setup for this object. More...

void	Action ()
	Creates the GLI map. More...

float	CalcLightValue (clTree p_oTree, clTreePopulation p_oPop)
	Required overridden function - doesn't do anything. More...

float	GetLightHeight ()
	Gets the height above the ground, in m, at which the quadrat light values are calculated. More...

float	GetMaxSearchDistance ()
	Gets the maximum search distance for shading neighbors. More...

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

virtual	~clGLIBase ()
	Destructor. More...

float	GetSinMinSunAng ()
	Gets the sine of the minimum sun angle. More...

float	GetAziChunkConverter ()
	Gets the reciprocal of the size of a single azimuth sky grid division, in degrees. More...

float	GetRcpTanMinAng ()
	Gets the reciprocal of the tangent of the minimum sun angle. 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	TimestepCleanup ()
	Performs any necessary cleanup operations at the end of a timestep. More...

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

Protected Member Functions
void	ReadParameterFileData (xercesc::DOMDocument *p_oDoc)
	Reads in needed parameter file data. More...

void	SetUpBrightnessArray ()
	Sets up the light brightness array. More...

void	DoSetupCalculations ()
	Performs setup calculations. More...

void	SetUpGrid ()
	Sets up the "GLI Map" grid. More...

Protected Member Functions inherited from clGLIBase
void	AddTreeToGliFishEye (const float &fTargetX, const float &fTargetY, const float &fTargetHeight, clTree p_oNeighbor, clPlot p_oPlot, clTreePopulation p_oPop, clAllometry p_oAllom)
	Adds one shading neighbor to the fisheye photo array for a GLI calculation. More...

void	GLIFisheyeNoCanopyIntersect (const float &fTargetX, const float &fTargetY, const float &fNeighX, const float &fNeighY, const float &fNeighCanrad, const float &fNeighHeight, const short int &iNeighSpecies, const float &fTargetHeight, const float &fDistToNearEdge, clTree p_oNeighbor, clPlot p_oPlot, clAllometry *p_oAllom)
	Adds one shading neighbor to the fisheye photo array for a GLI calculation when the canopies of the two trees do not overlap. More...

void	GLIFisheyeCanopyIntersect (const float &fTargetX, const float &fTargetY, const float &fNeighX, const float &fNeighY, const float &fNeighCanrad, const float &fNeighHeight, const short int &iNeighSpecies, const float &fTargetHeight, clTree p_oNeighbor, clPlot p_oPlot, clAllometry *p_oAllom)
	Adds one shading neighbor to the fisheye photo array for a GLI calculation when the canopies of the two trees overlap. More...

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

virtual void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	If a descendent class has specific setup needs, it can overload this function. 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_oMapGrid
	Grid object which holds the GLI values. More...

double	m_fLightHeight
	The height above the ground, in m, at which the quadrat light values are calculated. More...

float	m_fMaxSearchDistance
	Maximum search distance for shading neighbors. More...

short int	m_iGridGliCode
	Return code for the "GLI Map" grid to get and set GLI in the cells. More...

Protected Attributes inherited from clGLIBase
float	m_fSinMinSunAng
	Sin of the min sun angle. More...

float	m_fAziChunkConverter
	Reciprocal of the size of a single azimuth sky grid division, in degrees. More...

float	m_fRcpTanMinAng
	1/tan (m_fMinSunAngle). More...

float *	mp_fAziSlope
	For each azimuth chunk of sky, this holds the slope of the line to the middle of the chunk. 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...

Friends
class	clTestGLIMap
	To ease testing of parameter setup. 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

GLIMapCreator - Version 1.0.

This behavior creates a map of GLI values in a grid. The user sets the height of the point at which to calculate GLI, and then this behavior calculates the GLI at that height in the center of each cell. (This behavior is almost identical to clQuadratGliLight, except it doesn't apply light to trees and calculates a GLI for every grid cell no matter what.) This behavior does not need to be applied to any trees.

Nothing else is done with the GLI values. This is an analysis behavior that prepares some calculations; the user can output the GLI map grid and then use the values however they see fit.

The namestring and parameter file call string for this behavior is "GLIMapCreator". This class is descended from clGLIBase so it can use its light calculation methods, but since the string "lightshell" is ommitted from this class's namestring, it should not be treated as a light behavior.

The sky brightness array used by this behavior is potentially identical to that for other GLI light behaviors. Before committing to the calculation of a brightness array, this behavior will ask those behaviors if their settings are identical. If they are, and that class has already calculated the brightness array, this behavior can just copy.

Author: Lora E. Murphy

Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)
May 14, 2015 - Made it so multiple copies of this behavior will each have their own grid map (LEM)

Constructor & Destructor Documentation

◆ clGLIMap()

clGLIMap::clGLIMap ( clSimManager * p_oSimManager )

Constructor.

Sets the namestring.

Parameters

p_oSimManager Sim Manager object.

Member Function Documentation

◆ Action()

void clGLIMap::Action ( )

virtual

Creates the GLI map.

Each cell in the "GLI Map" grid, below, gets its GLI calculated at the height value in m_fLightHeight in the center of the cell.

Reimplemented from clBehaviorBase.

◆ CalcLightValue()

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

inlinevirtual

Required overridden function - doesn't do anything.

Parameters

p_oTree	Ignored.
p_oPop	Ignored.

Returns: 0.

Implements clLightBase.

◆ DoSetupCalculations()

void clGLIMap::DoSetupCalculations ( )

protected

Performs setup calculations.

This calculates the values for m_fAziChunkConverter, m_fRcpTanMinAng, mp_fAziSlope, and m_fMaxSearchDistance.

◆ GetData()

void clGLIMap::GetData ( xercesc::DOMDocument * p_oDoc )

virtual

Does setup for this object.

Calls the following functions:

clLightBase::GetData(), to make sure mp_oLightOrg gets set up if this is the "hooked" light object
ReadParameterFileData
SetUpBrightnessArray
DoSetupCalculations
SetUpGrid

Parameters

p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

◆ GetLightHeight()

float clGLIMap::GetLightHeight ( )

inline

Gets the height above the ground, in m, at which the quadrat light values are calculated.

Returns: Light height.

◆ GetMaxSearchDistance()

float clGLIMap::GetMaxSearchDistance ( )

inline

Gets the maximum search distance for shading neighbors.

Returns: Maximum search distance for shading neighbors.

◆ ReadParameterFileData()

void clGLIMap::ReadParameterFileData ( xercesc::DOMDocument * p_oDoc )

protected

Reads in needed parameter file data.

First this looks for the "gliMap" tag and tries to read in all its data from that (in case the user has provided different sky grid settings to different light objects). If there's no sky grid data in the "gliMap" tag, then this will get what it needs from the first tag it finds with these values. (The "gliMap" tag, no matter what, must have the height of photo.)

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr

if:

The tag "gliMap" or its required data is not present
Number of azimuth sky divisions is less than or equal to 0
Number of altitude sky divisions is less than or equal to 0
Height of GLI point is less than 0

◆ SetUpBrightnessArray()

void clGLIMap::SetUpBrightnessArray ( )

protected

Sets up the light brightness array.

This will check to see if it can share the brightness array with clGliLight or clQuadratGliLight, and if not, it creates the sky brightness array.

◆ SetUpGrid()

void clGLIMap::SetUpGrid ( )

protected

Sets up the "GLI Map" grid.

The parameter file is allowed to set grid cell resolution; map values will be ignored.

Friends And Related Function Documentation

◆ clTestGLIMap

friend class clTestGLIMap

friend

To ease testing of parameter setup.

Member Data Documentation

◆ m_fLightHeight

double clGLIMap::m_fLightHeight

protected

The height above the ground, in m, at which the quadrat light values are calculated.

◆ m_fMaxSearchDistance

float clGLIMap::m_fMaxSearchDistance

protected

Maximum search distance for shading neighbors.

◆ m_iGridGliCode

short int clGLIMap::m_iGridGliCode

protected

Return code for the "GLI Map" grid to get and set GLI in the cells.

◆ mp_oMapGrid

clGrid* clGLIMap::mp_oMapGrid

protected

Grid object which holds the GLI values.

The name of the grid is "GLI Map X", where X is the behavior order number. There is one float data member ("GLI") for holding GLI as a value from 0 to 100. Grid data in the parameter file can only set cell resolution; any map values will be ignored.

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

GLIMap.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clGLIMap()

Member Function Documentation

◆ Action()

◆ CalcLightValue()

◆ DoSetupCalculations()

◆ GetData()

◆ GetLightHeight()

◆ GetMaxSearchDistance()

◆ ReadParameterFileData()

◆ SetUpBrightnessArray()

◆ SetUpGrid()

Friends And Related Function Documentation

◆ clTestGLIMap

Member Data Documentation

◆ m_fLightHeight

◆ m_fMaxSearchDistance

◆ m_iGridGliCode

◆ mp_oMapGrid