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

Average Light - Version 1.0. More...

#include <AverageLight.h>

Inheritance diagram for clAverageLight:
clLightBase clBehaviorBase clWorkerBase

Public Member Functions

 clAverageLight (clSimManager *p_oSimManager)
 Constructor. More...
 
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Does setup for this behavior. More...
 
void TimestepCleanup ()
 Sets the "average calculated" flag back to false. More...
 
float CalcLightValue (clTree *p_oTree, clTreePopulation *p_oPop)
 Gets the light value for a particular tree. 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 CalculateAverage (clTreePopulation *p_oPop)
 Calculates the average light value 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_oGLIMapGrid
 Grid object which holds the GLI light values to average. More...
 
clGridmp_oAvgLightGrid
 Grid object which holds the averaged light values. More...
 
short int m_iMapLightCode
 Return code for the "GLI" data member of the "GLI Map" grid. More...
 
short int m_iAvgLightCode
 Return code for the "GLI" data member of the "Average Light" grid. More...
 
bool m_bAvgCalculated
 Whether or not the average GLI value has been calculated 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

Average Light - Version 1.0.

This behavior averages light values taken over a finer scale to a coarser resolution. It gets the light levels for averaging from the GLI Map Creator's grid (class clGLIMap). This grid is called "GLI Map X" where X is the position in the behavior list. This will average the first GLI Map X grid that it finds. Putting multiple copies of the GLI Map Creator in a run would be a problem: because of the clLightOrg hooking process, it is impossible to guarantee that all copies of GLI Map Creator will run before Average Light.

The Average Light behavior produces one grid, called "Average Light". The user sets the grid resolution on this grid to control the area over which light is averaged, up to the whole plot.

If the grid cell area of Average Light is not an exact multiple of the GLI Map grid cell area, then the averaging will be over all the cells touched by the Average Light grid, with no weighting for partial cells (see the clGrid::GetAverageFloatValue method).

The namestring for this behavior is "averagelightshell"; the parameter file call string is "AverageLight".

Copyright 2011 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)
May 18, 20145 - Added support for multiple GLI Map grids (LEM)

Constructor & Destructor Documentation

◆ clAverageLight()

clAverageLight::clAverageLight ( clSimManager p_oSimManager)

Constructor.

Sets the namestring.

Parameters
p_oSimManagerSim Manager object.

Member Function Documentation

◆ CalcLightValue()

float clAverageLight::CalcLightValue ( clTree p_oTree,
clTreePopulation p_oPop 
)
virtual

Gets the light value for a particular tree.

First, it checks to see if the average has been calculated this timestep. If not, then CalculateAverage() is called. Then the average value is returned.

Parameters
p_oTreeTree for which to get light.
p_oPopTree population.
Returns
Average GLI value.

Implements clLightBase.

◆ CalculateAverage()

void clAverageLight::CalculateAverage ( clTreePopulation p_oPop)
protected

Calculates the average light value each timestep.

For each cell in the "Average Light" grid, it calculates an average of the grid cells in "GLI Map" that fall within its values using clGrid::GetAverageFloatValue. At the end, this sets m_bAvgCalculated to true.

Parameters
p_oPopTree population object

◆ DoShellSetup()

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

Does setup for this behavior.

This grabs a pointer to the "GLI Map" grid and either grabs the "Average Light" grid or sets it up if it doesn't exist yet.

Parameters
p_oDocDOM tree of parsed input file.
Exceptions
modelErrif the "GLI Map" grid is not present.

Reimplemented from clLightBase.

◆ TimestepCleanup()

void clAverageLight::TimestepCleanup ( )
inlinevirtual

Sets the "average calculated" flag back to false.

Reimplemented from clWorkerBase.

Member Data Documentation

◆ m_bAvgCalculated

bool clAverageLight::m_bAvgCalculated
protected

Whether or not the average GLI value has been calculated this timestep.

◆ m_iAvgLightCode

short int clAverageLight::m_iAvgLightCode
protected

Return code for the "GLI" data member of the "Average Light" grid.

◆ m_iMapLightCode

short int clAverageLight::m_iMapLightCode
protected

Return code for the "GLI" data member of the "GLI Map" grid.

◆ mp_oAvgLightGrid

clGrid* clAverageLight::mp_oAvgLightGrid
protected

Grid object which holds the averaged light values.

This grid is created by this class. Its name is "Average Light" and it has one float data member, "GLI".

◆ mp_oGLIMapGrid

clGrid* clAverageLight::mp_oGLIMapGrid
protected

Grid object which holds the GLI light values to average.

This grid is not created by this class, but by the clGLIMap class.


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