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

Climate Change - version 1.0. More...

#include <ClimateChange.h>

Inheritance diagram for clClimateChange:
clBehaviorBase clWorkerBase

Public Member Functions

 clClimateChange (clSimManager *p_oSimManager)
 Constructor.
 
void GetData (xercesc::DOMDocument *p_oDoc)
 Destructor - not needed.
 
void Action ()
 Updates the plot temperature or precipitation according to the function above.
 
void SetNameData (char *cNameString)
 Captures the namestring passed to this behavior.
 
- Public Member Functions inherited from clBehaviorBase
virtual float GetBehaviorVersion ()
 Gets the behavior version number.
 
 clBehaviorBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clBehaviorBase ()
 Destructor.
 
virtual short int ValidateVersionNumber (float fTestVersion)
 Makes sure that the version number of a file passed is between the minimum and current version numbers.
 
virtual void RegisterTreeDataMembers ()
 Registers tree data members.
 
virtual void SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
 Sets the species/type combos for a behavior.
 
virtual short int GetNewTreeInts ()
 Gets the number of new tree integer data members this behavior wants to register.
 
virtual short int GetNewTreeFloats ()
 Gets the number of new tree float data members this behavior wants to register.
 
virtual short int GetNewTreeChars ()
 Gets the number of new tree character data members this behavior wants to register.
 
virtual short int GetNewTreeBools ()
 Gets the number of new tree bool data members this behavior wants to register.
 
virtual short int GetNumSpeciesTypeCombos ()
 Gets the number of species/type combos to which this behavior applies.
 
virtual short int GetNumBehaviorSpecies ()
 Gets the number of unique tree species to which this behavior applies.
 
struct stcSpeciesTypeCombo GetSpeciesTypeCombo (short int iIndex)
 Gets one of this behavior's type/species combos.
 
virtual short int GetBehaviorSpecies (short int iIndex)
 Gets one of the behavior's species.
 
short int GetBehaviorListNumber ()
 Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list.
 
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.
 
virtual DOMElement * GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
 Formats the string for species/types query.
 
- Public Member Functions inherited from clWorkerBase
 clWorkerBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clWorkerBase ()
 Destructor.
 
char * GetName ()
 Gets the object's namestring.
 
void DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
 Triggers the setup process.
 
virtual void TimestepCleanup ()
 Performs any necessary cleanup operations at the end of a timestep.
 
virtual void EndOfRunCleanup ()
 Performs any necessary cleanup operations at the end of a run.
 
virtual void DoCommand (char *cCommand, char *cArguments)
 If a behavior has registered a command line command with the sim manager, this allows it to be called.
 

Protected Attributes

float m_fTimeElapsed
 Time, in years, elapsed since the beginning of the run.
 
float m_fTimestepLength
 Length of timestep, in years.
 
float m_fB
 B parameter.
 
float m_fC
 C parameter.
 
float m_fStartingValue
 Starting value, either temperature or precipitation.
 
float m_fMin
 Lower bound.
 
float m_fMax
 Upper bound.
 
bool m_bIsTemp
 Whether this is for temperature (True) or precipitation (False).
 
- Protected Attributes inherited from clBehaviorBase
short int m_iNumSpeciesTypeCombos
 How many type/species combos a behavior will act on.
 
short int m_iNumBehaviorSpecies
 How many distinct species are in the combo list - important for filling species-specific values from parameter file.
 
short int * mp_iWhatSpecies
 List of distinct species - for filling species-specific values from parameter file.
 
stcSpeciesTypeCombomp_whatSpeciesTypeCombos
 Array of species/type combos that the behavior will act on.
 
short int m_iNewTreeInts
 The number of new tree integer data members this behavior wants to add.
 
short int m_iNewTreeFloats
 The number of new tree float data members this behavior wants to add.
 
short int m_iNewTreeChars
 The number of new tree character data members this behavior wants to add.
 
short int m_iNewTreeBools
 The number of new tree boolean data members this behavior wants to add.
 
short int m_iBehaviorListNumber
 The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior.
 
float m_fVersionNumber
 Version number - this will be rounded to 2 digits after the decimal place.
 
std::string m_sXMLRoot
 XML root that encloses the parameters for this behavior.
 
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.
 
- Protected Attributes inherited from clWorkerBase
char m_cNameString [MAX_NAMESTRING_SIZE]
 Object's identifying namestring.
 
int * mp_iAllowedFileTypes
 List of the input file types this object can handle.
 
int m_iNumAllowedTypes
 Number of input file types this object can handle.
 

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.
 
- Static Protected Attributes inherited from clWorkerBase
static clSimManagermp_oSimManager
 Pointer to the simulation manager object.
 

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.

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

Copyright 2011 Charles D. Canham.

Author
Lora E. Murphy


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

Constructor & Destructor Documentation

clClimateChange::clClimateChange ( clSimManager p_oSimManager)

Constructor.

Parameters
p_oSimManagerSim Manager object.

Member Function Documentation

void clClimateChange::Action ( )
virtual

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

Reimplemented from clBehaviorBase.

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

Destructor - not needed.

Reads in values from the parameter file.

Parameters
p_oDocDOM tree of parsed input file.

Implements clWorkerBase.

void clClimateChange::SetNameData ( char *  cNameString)
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
cNameStringBehavior's namestring.

Reimplemented from clBehaviorBase.

Member Data Documentation

bool clClimateChange::m_bIsTemp
protected

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

float clClimateChange::m_fB
protected

B parameter.

float clClimateChange::m_fC
protected

C parameter.

float clClimateChange::m_fMax
protected

Upper bound.

float clClimateChange::m_fMin
protected

Lower bound.

float clClimateChange::m_fStartingValue
protected

Starting value, either temperature or precipitation.

float clClimateChange::m_fTimeElapsed
protected

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

float clClimateChange::m_fTimestepLength
protected

Length of timestep, in years.


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