Seasonal Water Deficit - version 1.0. More...

#include <ClimateImporter.h>

Inheritance diagram for clClimateImporter:

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

	~clClimateImporter ()
	Destructor. More...

void	GetData (xercesc::DOMDocument *p_oDoc)
	Reads in values from the parameter file. More...

void	Action ()
	Updates the plot seasonal water deficit. 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 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 (DOMElement p_oElement, double p_fPpt, double p_fTemp, double p_fRad)
	Read parameter file data. More...

void	ReadMonthlyData (xercesc::DOMElement p_oParent, std::string sParentTag, std::string sSubTag, double p_fVal)
	Does the heavy lifting to extract XML values. 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
double *	mp_fPpt
	Annual precipitation. More...

double *	mp_fTemp
	Annual mean temperature. More...

double *	mp_fSeasonalPpt
	Seasonal precipitation. More...

double *	mp_fWD
	Water deficit. 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...

Detailed Description

Seasonal Water Deficit - version 1.0.

This calculates timestep climate variables based on imported climate data. It will calculate all values ahead of time and its only job each timestep will be to set the correct values.

Annual precipitation is summed from monthly precipitation for the timestep.

Mean annual temperature is calculated by averaging monthly temperatures for the timestep.

Water deficit is calculated as in the water deficit behavior.

Seasonal precipitation is soil water storage, plus growing season precip, plus non-growing-season PET. The growing season is months where PET >= PPT.

All values are then stored in clPlot.

This class's namestring is "ClimateImporter". The parameter file call string is "ClimateImporter".

Author: Lora E. Murphy

Edit history:
--------------—
January 19, 2017 - Created (LEM)

Constructor & Destructor Documentation

◆ clClimateImporter()

clClimateImporter::clClimateImporter ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim Manager object.

◆ ~clClimateImporter()

clClimateImporter::~clClimateImporter ( )

Destructor.

Member Function Documentation

◆ Action()

void clClimateImporter::Action ( )

virtual

Updates the plot seasonal water deficit.

Reimplemented from clBehaviorBase.

◆ GetData()

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

virtual

Reads in values from the parameter file.

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if proportion of rain values don't add up to 1.

Implements clWorkerBase.

◆ ReadMonthlyData()

void clClimateImporter::ReadMonthlyData	(	xercesc::DOMElement *	p_oParent,
		std::string	sParentTag,
		std::string	sSubTag,
		double *	p_fVal
	)

protected

Does the heavy lifting to extract XML values.

Parameters

p_oParent	Parent tag to look in.
sParentTag	Tag of parent element.
sSubTag	Tag of children of parent.
p_fVal	Array to read into.

◆ ReadParameterFileData()

void clClimateImporter::ReadParameterFileData	(	DOMElement *	p_oElement,
		double **	p_fPpt,
		double **	p_fTemp,
		double *	p_fRad
	)

protected

Read parameter file data.

Parameters

p_oElement	Parent element to read from.
p_fPpt	Array in which to read monthly precipitation data.
p_fTemp	Array in which to read monthly temperature data.
p_fRad	Array in which to read monthly radiation data.

Member Data Documentation

◆ mp_fPpt

double* clClimateImporter::mp_fPpt

protected

Annual precipitation.

Array length is # timesteps.

◆ mp_fSeasonalPpt

double* clClimateImporter::mp_fSeasonalPpt

protected

Seasonal precipitation.

Array length is # timesteps.

◆ mp_fTemp

double* clClimateImporter::mp_fTemp

protected

Annual mean temperature.

Array length is # timesteps.

◆ mp_fWD

double* clClimateImporter::mp_fWD

protected

Water deficit.

Array length is # timesteps.

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

ClimateImporter.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ clClimateImporter()

◆ ~clClimateImporter()

Member Function Documentation

◆ Action()

◆ GetData()

◆ ReadMonthlyData()

◆ ReadParameterFileData()

Member Data Documentation

◆ mp_fPpt

◆ mp_fSeasonalPpt

◆ mp_fTemp

◆ mp_fWD