Climate Change - version 1.0. More...

#include <ClimateChange.h>

Inheritance diagram for clClimateChange:

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

void	GetData (xercesc::DOMDocument *p_oDoc)
	Destructor - not needed. More...

void	Action ()
	Updates the plot temperature or precipitation according to the function above. More...

void	SetNameData (std::string sNameString)
	Captures the namestring passed to this behavior. More...

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	RegisterTreeDataMembers ()
	Registers tree data members. More...

virtual void	SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
	Sets the species/type combos for a 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 Attributes
long	m_iTimeElapsed
	Time, in years, elapsed since the beginning of the run. More...

int	m_iTimestepLength
	Length of timestep, in years. More...

double	m_fB
	B parameter. More...

double	m_fC
	C parameter. More...

double	m_fStartingValue
	Starting value, either temperature or precipitation. More...

double	m_fMin
	Lower bound. More...

double	m_fMax
	Upper bound. More...

bool	m_bIsTemp
	Whether this is for temperature (True) or precipitation (False). More...

bool	m_bUpdateAllPrecip
	Whether to update the other precip variables. 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
Protected Member Functions inherited from clWorkerBase
void	AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
	Creates the proper identifying filecode for an XML file. More...

Detailed Description

Climate Change - version 1.0.

This changes plot temperature or precipitation over time. There can be two versions of this behavior, one doing temperature and one doing precipitation, in the same run.

Temperature or precipitation at time t is: P = P1 + b * t^c where P1 is the starting value, c and b are parameters, and t is time elapsed, in years, since the beginning of the run.

The user can set upper and lower bounds on the climate variable.

If this is updating precipitation, the user has the option to update the seasonal precipitation by the same proportion of change.

This class's namestring is "climate change". The parameter file call string for the temperature version is "TemperatureClimateChange". For precipitation, it's "PrecipitationClimateChange".

Author: Lora E. Murphy

Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)
November 11, 2013 - Added updating of other precip variables (LEM)

Constructor & Destructor Documentation

◆ clClimateChange()

clClimateChange::clClimateChange ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim Manager object.

Member Function Documentation

◆ Action()

void clClimateChange::Action ( )

virtual

Updates the plot temperature or precipitation according to the function above.

Reimplemented from clBehaviorBase.

◆ GetData()

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

virtual

Destructor - not needed.

Reads in values from the parameter file.

Parameters

p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

◆ SetNameData()

void clClimateChange::SetNameData ( std::string sNameString )

virtual

Captures the namestring passed to this behavior.

This is overridden from clBehaviorBase so we can capture the namestring passed. Since this class can create multiple kinds of behaviors that function differently, this will capture what kind of behavior this is supposed to be.

Parameters

sNameString Behavior's namestring.

Reimplemented from clBehaviorBase.

Member Data Documentation

◆ m_bIsTemp

bool clClimateChange::m_bIsTemp

protected

Whether this is for temperature (True) or precipitation (False).

◆ m_bUpdateAllPrecip

bool clClimateChange::m_bUpdateAllPrecip

protected

Whether to update the other precip variables.

◆ m_fB

double clClimateChange::m_fB

protected

B parameter.

◆ m_fC

double clClimateChange::m_fC

protected

C parameter.

◆ m_fMax

double clClimateChange::m_fMax

protected

Upper bound.

◆ m_fMin

double clClimateChange::m_fMin

protected

Lower bound.

◆ m_fStartingValue

double clClimateChange::m_fStartingValue

protected

Starting value, either temperature or precipitation.

◆ m_iTimeElapsed

long clClimateChange::m_iTimeElapsed

protected

Time, in years, elapsed since the beginning of the run.

◆ m_iTimestepLength

int clClimateChange::m_iTimestepLength

protected

Length of timestep, in years.

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

ClimateChange.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clClimateChange()

Member Function Documentation

◆ Action()

◆ GetData()

◆ SetNameData()

Member Data Documentation

◆ m_bIsTemp

◆ m_bUpdateAllPrecip

◆ m_fB

◆ m_fC

◆ m_fMax

◆ m_fMin

◆ m_fStartingValue

◆ m_iTimeElapsed

◆ m_iTimestepLength