Light base - Version 1.1. More...

#include <LightBase.h>

Inheritance diagram for clLightBase:

Public Member Functions
	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...

virtual float	CalcLightValue (clTree p_oTree, clTreePopulation p_oPop)=0
	Calculates the light value for a particular tree. 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	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
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...

Static Protected Attributes
static clLightOrg *	mp_oLightOrg
	clLightOrg object - this pointer is held in common by all shells More...

Friends
class	clLightOrg

class	clGliLight

class	clQuadratGLILight

class	clGLIMap

class	clGLIPoints

Detailed Description

Light base - Version 1.1.

This is the base class for light behavior shell classes. These shells implement a common set of functions in different ways which are specific to the way light is calculated according to their method.

The bulk of the organizational work is done by the class clLightOrg, which calls the needed shell functions for each tree. The clLightOrg object hooks into one particular light shell object, which calls clLightOrg when it is triggered by the behavior manager. It does not particularly matter which shell object is hooked; the first one will suffice. Any non-hooked shells do nothing when their Action() and other functions are called. The hooked shell also tells this object that it's time to register tree data members.

Every object made from this class or a descendent class must have the string "lightshell" in its namestring somewhere. The base class also declares a new tree float data member on behalf of each child shell object; the light org object then registers it. The descendents don't need to do anything. The new data member is called "Light", and will store the amount of light calculated.

Author: Lora E. Murphy

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

August 19, 2015 - Added sky rotation (LEM)

Constructor & Destructor Documentation

◆ clLightBase()

clLightBase::clLightBase ( clSimManager * p_oSimManager )

Constructor.

Checks to see if the light org object has been created - if not, it creates it. Sets m_bNeedsCommonParameters to true, its default.

Parameters

p_oSimManager Sim Manager object.

◆ ~clLightBase()

virtual clLightBase::~clLightBase ( )

virtual

Destructor.

Deletes the light org object if it was the hooked object.

Member Function Documentation

◆ Action()

void clLightBase::Action ( )

virtual

Performs all light calculations.

This will be the same for all descendent classes - they do not need to override. If a particular object is hooked, it calls the light org object's DoLightAssignments. Otherwise it does nothing.

Reimplemented from clBehaviorBase.

Reimplemented in clLightDepSeedSurvival, and clQuadratGLILight.

◆ CalcLightValue()

virtual float clLightBase::CalcLightValue	(	clTree *	p_oTree,
		clTreePopulation *	p_oPop
	)

pure virtual

Calculates the light value for a particular tree.

This must be overridden by all child classes.

The reason that the function does not just assign the value to the tree is because the data codes are managed by the light org object.

Parameters

p_oTree	Tree for which to calculate light level.
p_oPop	Tree population object.

Returns: Light level, in whatever format is appropriate to the light object that calculated it.

Implemented in clLightDepSeedSurvival, clBasalAreaLight, clEpiphyticEstablishment, clDensityLight, clGLIMap, clGLIPoints, clAverageLight, clQuadratGLILight, clGapLight, clGliLight, clSailLight, and clConstantGLI.

◆ DoShellSetup()

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

inlineprotectedvirtual

If a descendent class has specific setup needs, it can overload this function.

Parameters

p_oDoc DOM tree of parsed input file.

Reimplemented in clBasalAreaLight, clDensityLight, clAverageLight, clQuadratGLILight, clGapLight, clConstantGLI, clGliLight, and clSailLight.

◆ GetAirmassEffect()

float clLightBase::GetAirmassEffect	(	float &	fAltInDeg,
		float &	fCosZenAng
	)

inlineprotected

Computes the airmass effect for a given altitude angle.

Parameters

fAltInDeg	Altitude angle, in degrees
fCosZenAng	Cosine of solar zenith angle

Returns: Airmass effect

◆ GetAltitudeAngle()

float clLightBase::GetAltitudeAngle ( float & fCosZenAng )

inlineprotected

Computes altitude angle of the sun at a given time in radians.

Parameters

fCosZenAng Cosine of the sun's zenith angle

◆ GetAzimuthAngle()

float clLightBase::GetAzimuthAngle	(	float &	fDeclination,
		float &	fLatInRadians,
		float &	fAltInRad,
		float &	fTimeNow
	)

inlineprotected

Computes azimuth angle of the sun at a given time in radians in SORTIE azimuth coordinates.

Parameters

fDeclination	Solar declination, in radians
fLatInRadians	Location latitude in radians
fAltInRad	Sun's current altitude position, in radians
fTimeNow	Current solar time

Returns: Azimuth angle of sun

◆ GetBeamRadiation()

float clLightBase::GetBeamRadiation	(	float &	fClearSkyTransCoeff,
		float &	fAirmass,
		float &	fEccentricity,
		float &	fCosZenAng
	)

inlineprotected

Computes beam radiation strength.

Parameters

fClearSkyTransCoeff	Clear sky transmission coefficient
fAirmass	Airmass effect
fEccentricity	Solar eccentricity
fCosZenAng	Cosine of solar zenith angle

◆ GetBrightness()

float clLightBase::GetBrightness	(	int	alt,
		int	azi
	)

inline

◆ GetCosineOfZenithAngle()

float clLightBase::GetCosineOfZenithAngle	(	float &	fDeclination,
		float &	fLatInRadians,
		float &	fTimeNow
	)

inlineprotected

Computes cosine of the zenith angle of the sun at a given time.

This is needed in other calculations.

Parameters

fDeclination	Solar declination, in radians
fLatInRadians	Location latitude in radians
fTimeNow	Current time in solar time

Returns: Cosine of zenith angle of the sun

◆ GetData()

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

protectedvirtual

Triggers all light setup.

This will be the same for all descendent classes. If a particular object is hooked, it calls the light org object's DoSetup() function. Then it calls the function DoShellSetup() - if a descendent class has specific setup needs, it can overload that function.

Parameters

p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

Reimplemented in clLightDepSeedSurvival.

◆ GetDayAngle()

float clLightBase::GetDayAngle ( int iJulianDay )

inlineprotected

Computes day angle.

Parameters

iJulianDay Julian day for which to compute a day angle

Returns: Day angle, in radians.

◆ GetDeclination()

float clLightBase::GetDeclination ( float & fDayAngle )

inlineprotected

Computes solar declination.

Parameters

fDayAngle Day angle, in radians, for which to compute declination.

Returns: Solar declination, in radians.

◆ GetEccentricity()

float clLightBase::GetEccentricity ( float & fDayAngle )

inlineprotected

Computes solar eccentricity.

Parameters

fDayAngle Day angle, in radians, for which to compute eccentricity.

Returns: Solar eccentricity, in radians.

◆ GetLightExtinctionCoefficient()

virtual float clLightBase::GetLightExtinctionCoefficient ( clTree * p_oTree )

protectedvirtual

Gets the light extinction coefficent.

This passes this through to clLightOrg::GetLightExtCoeff(). This structure allows for overriding by child classes if necessary.

Parameters

p_oTree Tree for which to obtain the light extinction coefficient.

Returns: The light extinction coefficient, as the proportion of light transmitted by the tree, as a value between 0 and 1.

Reimplemented in clLightDepSeedSurvival.

◆ GetLightOrg()

clLightOrg* clLightBase::GetLightOrg ( )

inline

Gets the light org object.

Returns: The light org object.

◆ GetMinAngRow()

float clLightBase::GetMinAngRow ( )

inline

Gets the row in the brightness array corresponding to the minimum solar angle.

Returns: Row in the brightness array corresponding to the minimum solar angle.

◆ GetMinSunAngle()

float clLightBase::GetMinSunAngle ( )

inline

Gets the altitude angle below which the sky is assumed to be dark.

Returns: Minimum sun angle.

◆ GetNumAltAng()

float clLightBase::GetNumAltAng ( )

inline

Gets the number of altitude angles into which the sky hemisphere is divided.

Returns: Number of altitude angles into which the sky hemisphere is divided.

◆ GetNumAziAng()

float clLightBase::GetNumAziAng ( )

inline

Gets the number of azimuth angles into which the sky hemisphere is divided.

Returns: Number of azimuth angles into which the sky hemisphere is divided.

◆ GetSunrise()

float clLightBase::GetSunrise	(	float &	fLatInRadians,
		float &	fDeclination
	)

inlineprotected

Computes sunrise.

Parameters

fLatInRadians	Latitude, in radians
fDeclination	Solar declination on a given day, in radians

Returns: Sunrise, in solar time

◆ PopulateGLIBrightnessArray()

void clLightBase::PopulateGLIBrightnessArray ( )

protected

Populates the GLI brightness array.

Yes, yes, this isn't strictly a function common to all light shells, but it's common to more than one. Plus it's really similar to the sail light brightness array calculator and I may merge them at some point.

This assumes that the brightness array has already been allocated.

◆ PopulateSailLightBrightnessArray()

void clLightBase::PopulateSailLightBrightnessArray ( )

protected

Populates the sail brightness array.

This is so similar to the GLI brightness array function that I wanted them together so I could consider merging them later. But right now it's too much, what with one doing all calcs in radians and one in degrees. If that seems trivial to you, you're welcome to do it yourself.

This assumes that the brightness array has already been allocated.

◆ RegisterTreeDataMembers()

void clLightBase::RegisterTreeDataMembers ( )

virtual

Performs data member registrations for "Light".

This will be the same for all descendent classes - they do not need to override. If a particular object is hooked, it calls the light org object's DoTreeDataMemberRegistrations(). Otherwise it does nothing.

Reimplemented from clBehaviorBase.

Reimplemented in clLightDepSeedSurvival.

Friends And Related Function Documentation

◆ clGliLight

friend class clGliLight

friend

◆ clGLIMap

friend class clGLIMap

friend

◆ clGLIPoints

friend class clGLIPoints

friend

◆ clLightOrg

friend class clLightOrg

friend

◆ clQuadratGLILight

friend class clQuadratGLILight

friend

Member Data Documentation

◆ m_bHooked

bool clLightBase::m_bHooked

protected

Whether or not this shell object is hooked to clLightOrg.

clLightOrg will set this flag.

◆ m_bNeedsCommonParameters

bool clLightBase::m_bNeedsCommonParameters

protected

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

mp_oLightOrg will check this flag to see whether it should fill these values.

◆ m_fAzimuthOfNorth

double clLightBase::m_fAzimuthOfNorth

protected

The azimuth angle of north.

Not required; will default to 0. Setting this to non-zero allows the user to rotate the sky relative to the plot.

◆ m_fMinSunAngle

double clLightBase::m_fMinSunAngle

protected

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

Could be in degrees or radians, depending on what the child object is working in. Each child object needs its own copy of this.

◆ m_iMinAngRow

int clLightBase::m_iMinAngRow

protected

Row in the brightness array corresponding to the minimum solar angle.

Used to compare calculated object positions. Each child object needs its own copy of this.

◆ m_iNumAltAng

int clLightBase::m_iNumAltAng

protected

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

Each child object needs its own copy of this.

◆ m_iNumAziAng

int clLightBase::m_iNumAziAng

protected

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

Each child object needs its own copy of this.

◆ mp_fBrightness

float** clLightBase::mp_fBrightness

protected

Sky brightness array.

Array size is # altitude angles by # azimuth angles. The altitude index increases from horizon to zenith, and the azimuth index increases from north clockwise. Each child object needs its own copy of this.

◆ mp_fPhoto

float** clLightBase::mp_fPhoto

protected

Simulated fisheye photo array.

Array size is # altitude angles by # azimuth angles. The altitude index increases from horizon to zenith, and the azimuth index increases from 0 to 2PI. Each child object needs its own copy of this.

◆ mp_oLightOrg

clLightOrg* clLightBase::mp_oLightOrg

staticprotected

clLightOrg object - this pointer is held in common by all shells

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

LightBase.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ clLightBase()

◆ ~clLightBase()

Member Function Documentation

◆ Action()

◆ CalcLightValue()

◆ DoShellSetup()

◆ GetAirmassEffect()

◆ GetAltitudeAngle()

◆ GetAzimuthAngle()

◆ GetBeamRadiation()

◆ GetBrightness()

◆ GetCosineOfZenithAngle()

◆ GetData()

◆ GetDayAngle()

◆ GetDeclination()

◆ GetEccentricity()

◆ GetLightExtinctionCoefficient()

◆ GetLightOrg()

◆ GetMinAngRow()

◆ GetMinSunAngle()

◆ GetNumAltAng()

◆ GetNumAziAng()

◆ GetSunrise()

◆ PopulateGLIBrightnessArray()

◆ PopulateSailLightBrightnessArray()

◆ RegisterTreeDataMembers()

Friends And Related Function Documentation

◆ clGliLight

◆ clGLIMap

◆ clGLIPoints

◆ clLightOrg

◆ clQuadratGLILight

Member Data Documentation

◆ m_bHooked

◆ m_bNeedsCommonParameters

◆ m_fAzimuthOfNorth

◆ m_fMinSunAngle

◆ m_iMinAngRow

◆ m_iNumAltAng

◆ m_iNumAziAng

◆ mp_fBrightness

◆ mp_fPhoto

◆ mp_oLightOrg