Partitioned Biomass Calculator Version 1.0. More...

#include <PartitionedBiomass.h>

Inheritance diagram for clPartitionedBiomass:

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

	~clPartitionedBiomass ()
	Destructor. More...

void	Action ()
	Makes value calculations. More...

void	GetData (xercesc::DOMDocument *p_oDoc)
	Does setup for this behavior. 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 Member Functions
void	GetAppliesTo ()
	Sets up the mp_bWhichAppliesTo array with the flags for each species and tree type and whether this behavior applies to it. More...

void	GetTreeCodes (clTreePopulation *p_oPop)
	Sets up the mp_iDbhCodes or mp_iHeightCodes, depending on the type of biomass this is. More...

void	GetParameterFileData (xercesc::DOMDocument p_oDoc, clTreePopulation p_oPop)
	Reads values from the parameter file. More...

void	FormatQueryString (clTreePopulation *p_oPop)
	Formats the string in m_cQuery. More...

void	SetupGrid ()
	Sets up the "Partitioned Biomass" grid. 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
clGrid *	mp_oGrid
	Grid holding total values for each species. More...

double *	mp_fDBHLeafA
	"a" for the DBH-based leaf biomass. More...

double *	mp_fDBHLeafB
	"b" for the DBH-based leaf biomass. More...

double *	mp_fDBHBranchA
	"a" for the DBH-based branch biomass. More...

double *	mp_fDBHBranchB
	"b" for the DBH-based branch biomass. More...

double *	mp_fDBHBoleA
	"a" for the DBH-based bole biomass. More...

double *	mp_fDBHBoleB
	"b" for the DBH-based bole biomass. More...

double *	mp_fHeightLeafA
	"a" for the height-based leaf biomass. More...

double *	mp_fHeightLeafB
	"b" for the height-based leaf biomass. More...

double *	mp_fHeightBoleA
	"a" for the height-based bole biomass. More...

double *	mp_fHeightBoleB
	"b" for the height-based bole biomass. More...

char *	m_cQuery
	String to pass to clTreePopulation::Find() in order to get the trees for which to calculate volume. More...

short int **	mp_iDbhCodes
	Holds codes for DBH data member. More...

short int **	mp_iHeightCodes
	Holds codes for Height data member. More...

short int **	mp_iXCodes
	Holds codes for X data member. More...

short int **	mp_iYCodes
	Holds codes for Y data member. More...

bool **	mp_bAppliesTo
	Whether this behavior applies to each kind of tree. More...

short int *	mp_iLeafCodes
	Holds data member codes for the "leaf_x" data members of the "Partitioned Biomass" grid. More...

short int *	mp_iBranchCodes
	Holds data member codes for the "branch_x" data members of the "Partitioned Biomass" grid. More...

short int *	mp_iBoleCodes
	Holds data member codes for the "bole_x" data members of the "Partitioned Biomass" grid. More...

short int *	mp_iHLeafCodes
	Holds data member codes for the "hleaf_x" data members of the "Partitioned Biomass" grid. More...

short int *	mp_iHBoleCodes
	Holds data member codes for the "hbole_x" data members of the "Partitioned Biomass" grid. More...

short int	m_iNumTotalSpecies
	Total number of species. More...

bool	m_bIsDbh
	If true, this is DBH-based biomass. 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

Partitioned Biomass Calculator Version 1.0.

This behavior calculates biomass, partitioned by tree part. This has two possible equations for calculating biomass: one as a linear function of DBH, and one as a linear function of height. If the DBH equation is used, then biomass is partitioned into branches, leaf, and bole. If the height equation is used, it is partitioned into leaf and bole only (as for palms).

The equations are:

Bio_i = a_i * DBH + b_i Bio_i = a_i * DBH + b_i

for the ith component (leaf, branch, etc). Biomass values are not allowed to be 0. Any negative values are set to zero.

The values are collected into a grid called "Partitioned Biomass".

This class's namestring is "PartitionedBiomass." If using with DBH, the parameter file call string is "PartitionedDBHBiomass". If using with Height, the parameter file call string is "PartitionedHeightBiomass".

This behavior may not be applied to seedlings.

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

Constructor & Destructor Documentation

◆ clPartitionedBiomass()

clPartitionedBiomass::clPartitionedBiomass ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager clSimManager object.

◆ ~clPartitionedBiomass()

clPartitionedBiomass::~clPartitionedBiomass ( )

Destructor.

Deletes arrays.

Member Function Documentation

◆ Action()

void clPartitionedBiomass::Action ( )

virtual

Makes value calculations.

First, the values in the "Partitioned Biomass" grid are cleared. Then a query is sent to the tree population to get all trees to which this behavior is applied. For each, the amount of biomass (in metric tons) is calculated, and the species values are totaled and placed in the "Partitioned Biomass" grid.

Reimplemented from clBehaviorBase.

◆ FormatQueryString()

void clPartitionedBiomass::FormatQueryString ( clTreePopulation * p_oPop )

protected

Formats the string in m_cQuery.

This value will be used in Action() to pass to clTreePopulation::Find() in order to get the trees to act on.

Parameters

p_oPop Tree population object.

◆ GetAppliesTo()

void clPartitionedBiomass::GetAppliesTo ( )

protected

Sets up the mp_bWhichAppliesTo array with the flags for each species and tree type and whether this behavior applies to it.

◆ GetData()

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

virtual

Does setup for this behavior.

Calls:

GetAppliesTo()
GetParameterFileData()
FormatQueryString()
SetupGrid()
Action() so that the initial conditions value will be added

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if this behavior has been applied to seedlings.

Implements clWorkerBase.

◆ GetParameterFileData()

void clPartitionedBiomass::GetParameterFileData	(	xercesc::DOMDocument *	p_oDoc,
		clTreePopulation *	p_oPop
	)

protected

Reads values from the parameter file.

Parameters

p_oDoc	DOM tree of parsed input file.
p_oPop	Tree population object.

◆ GetTreeCodes()

void clPartitionedBiomass::GetTreeCodes ( clTreePopulation * p_oPop )

protected

Sets up the mp_iDbhCodes or mp_iHeightCodes, depending on the type of biomass this is.

Parameters

p_oPop Tree population object

◆ SetNameData()

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

virtual

Captures the namestring passed to this behavior.

If the namestring is "PartitionedDBHBiomass", this sets m_bIsDbh to true. If the namestring is "PartitionedHeightBiomass", this sets m_bIsDbh to false.

Parameters

sNameString Behavior's namestring.

Exceptions

modelErr if the namestring is not recognized.

Reimplemented from clBehaviorBase.

◆ SetupGrid()

void clPartitionedBiomass::SetupGrid ( )

protected

Sets up the "Partitioned Biomass" grid.

This ignores any maps.

Member Data Documentation

◆ m_bIsDbh

bool clPartitionedBiomass::m_bIsDbh

protected

If true, this is DBH-based biomass.

If false, height-based.

◆ m_cQuery

char* clPartitionedBiomass::m_cQuery

protected

String to pass to clTreePopulation::Find() in order to get the trees for which to calculate volume.

This will instigate a species/type search for all the species and types to which this behavior applies.

◆ m_iNumTotalSpecies

short int clPartitionedBiomass::m_iNumTotalSpecies

protected

Total number of species.

For the destructor.

◆ mp_bAppliesTo

bool** clPartitionedBiomass::mp_bAppliesTo

protected

Whether this behavior applies to each kind of tree.

First array index is total # species, second is number types (3 - sapling, adult, snag).