clStormKilledPartitionedBiomass Class Reference

Storm Killed Partitioned Biomass Calculator Version 1.0. More...

#include <StormKilledPartitionedBiomass.h>

Inheritance diagram for clStormKilledPartitionedBiomass:

clBehaviorBase clWorkerBase

List of all members.

Public Member Functions

 clStormKilledPartitionedBiomass (clSimManager *p_oSimManager)
 Constructor.
 ~clStormKilledPartitionedBiomass ()
 Destructor.
void Action ()
 Makes value calculations.
void GetData (xercesc::DOMDocument *p_oDoc)
 Does setup for this behavior.
void SetNameData (char *cNameString)
 Captures the namestring passed to this behavior.

Protected Member Functions

void GetTreeCodes (clTreePopulation *p_oPop)
 Sets up the mp_iDbhCodes or mp_iHeightCodes, depending on the type of biomass this is.
void GetParameterFileData (xercesc::DOMDocument *p_oDoc, clTreePopulation *p_oPop)
 Reads values from the parameter file.
void FormatQueryString (clTreePopulation *p_oPop)
 Formats the string in m_cQuery.
void SetupGrid (clTreePopulation *p_oPop)
 Sets up the "Storm Killed Paritioned Biomass" grid.

Protected Attributes

clGridBasemp_oGrid
 Grid holding total values for each species.
float * mp_fDBHLeafA
 "a" for the DBH-based leaf biomass.
float * mp_fDBHLeafB
 "b" for the DBH-based leaf biomass.
float * mp_fDBHBranchA
 "a" for the DBH-based branch biomass.
float * mp_fDBHBranchB
 "b" for the DBH-based branch biomass.
float * mp_fDBHBoleA
 "a" for the DBH-based bole biomass.
float * mp_fDBHBoleB
 "b" for the DBH-based bole biomass.
float * mp_fHeightLeafA
 "a" for the height-based leaf biomass.
float * mp_fHeightLeafB
 "b" for the height-based leaf biomass.
float * mp_fHeightBoleA
 "a" for the height-based bole biomass.
float * mp_fHeightBoleB
 "b" for the height-based bole biomass.
char * m_cQuery
 String to pass to clTreePopulation::Find() in order to get the trees for which to calculate volume.
short int * mp_iDbhCodes
 Holds codes for DBH data member.
short int * mp_iHeightCodes
 Holds codes for Height data member.
short int * mp_iXCodes
 Holds codes for X data member.
short int * mp_iYCodes
 Holds codes for Y data member.
short int * mp_iStmDmgCodes
 Holds codes for stm_dmg data member.
short int * mp_iLeafCodes
 Holds data member codes for the "leaf_x" data members of the "Partitioned Biomass" grid.
short int * mp_iBranchCodes
 Holds data member codes for the "branch_x" data members of the "Storm Killed Partitioned Biomass" grid.
short int * mp_iBoleCodes
 Holds data member codes for the "bole_x" data members of the "Storm Killed Partitioned Biomass" grid.
short int * mp_iHLeafCodes
 Holds data member codes for the "hleaf_x" data members of the "Storm Killed Partitioned Biomass" grid.
short int * mp_iHBoleCodes
 Holds data member codes for the "hbole_x" data members of the "Storm Killed Partitioned Biomass" grid.
bool m_bIsDbh
 If true, this is DBH-based biomass.


Detailed Description

Storm Killed Partitioned Biomass Calculator Version 1.0.

This behavior calculates biomass killed in storms, 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.

The equations are:

Bioi = ai * DBH + bi
Bioi = ai * DBH + bi

for the ith type, leaf, branch (if applicable), and bole. Biomass values are not allowed to be 0. Any negative values are set to zero.

Trees eligible are snags with stm_dmg int data members.

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

This class's namestring is "Storm Killed Partitioned Biomass." If using with DBH, the parameter file call string is "Storm Killed Partitioned DBH Biomass". If using with Height, the parameter file call string is "Storm Killed Partitioned Height Biomass".

This behavior may only be applied to snags.


Edit history:
-----------------
April 25, 2007 - Created (LEM)


Constructor & Destructor Documentation

clStormKilledPartitionedBiomass::clStormKilledPartitionedBiomass ( clSimManager p_oSimManager  ) 

Constructor.

Parameters:
p_oSimManager clSimManager object.

clStormKilledPartitionedBiomass::~clStormKilledPartitionedBiomass (  ) 

Destructor.

Deletes arrays.


Member Function Documentation

void clStormKilledPartitionedBiomass::Action (  )  [virtual]

Makes value calculations.

First, the values in the "Storm Killed 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 "Storm Killed Partitioned Biomass" grid.

Reimplemented from clBehaviorBase.

void clStormKilledPartitionedBiomass::GetData ( xercesc::DOMDocument *  p_oDoc  )  [virtual]

Does setup for this behavior.

Calls:

  1. GetAppliesTo()
  2. GetParameterFileData()
  3. FormatQueryString()
  4. SetupGrid()
  5. 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.

void clStormKilledPartitionedBiomass::SetNameData ( char *  cNameString  )  [virtual]

Captures the namestring passed to this behavior.

If the namestring is "Partitioned DBH Biomass", this sets m_bIsDbh to true. If the namestring is "Partitioned Height Biomass", this sets m_bIsDbh to false.

Parameters:
cNameString Behavior's namestring.
Exceptions:
modelErr if the namestring is not recognized.

Reimplemented from clBehaviorBase.

void clStormKilledPartitionedBiomass::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

void clStormKilledPartitionedBiomass::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.

void clStormKilledPartitionedBiomass::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.

void clStormKilledPartitionedBiomass::SetupGrid ( clTreePopulation p_oPop  )  [protected]

Sets up the "Storm Killed Paritioned Biomass" grid.

This ignores any maps.

Parameters:
p_oPop Tree population object.


Member Data Documentation

Grid holding total values for each species.

The grid name is "Storm Killed Partitioned Biomass". It has 5 times X float data members, where X = the total number of species. The data member names are "leaf_x", "branch_x", "bole_x" for the DBH biomass, where "x" is the species number, and "hleaf_x" and "hbole_x" for the height biomass, where "x" is the species number.

"a" for the DBH-based leaf biomass.

Array size is # total species.

"b" for the DBH-based leaf biomass.

Array size is # total species.

"a" for the DBH-based branch biomass.

Array size is # total species.

"b" for the DBH-based branch biomass.

Array size is # total species.

"a" for the DBH-based bole biomass.

Array size is # total species.

"b" for the DBH-based bole biomass.

Array size is # total species.

"a" for the height-based leaf biomass.

Array size is # total species.

"b" for the height-based leaf biomass.

Array size is # total species.

"a" for the height-based bole biomass.

Array size is # total species.

"b" for the height-based bole biomass.

Array size is # total species.

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.

Holds codes for DBH data member.

Array size is total # species.

Holds codes for Height data member.

Array size is total # species.

Holds codes for X data member.

Array size is total # species.

Holds codes for Y data member.

Array size is total # species.

Holds codes for stm_dmg data member.

Array size is total # species.

Holds data member codes for the "leaf_x" data members of the "Partitioned Biomass" grid.

Array size is total # species.

Holds data member codes for the "branch_x" data members of the "Storm Killed Partitioned Biomass" grid.

Array size is total # species.

Holds data member codes for the "bole_x" data members of the "Storm Killed Partitioned Biomass" grid.

Array size is total # species.

Holds data member codes for the "hleaf_x" data members of the "Storm Killed Partitioned Biomass" grid.

Array size is total # species.

Holds data member codes for the "hbole_x" data members of the "Storm Killed Partitioned Biomass" grid.

Array size is total # species.

If true, this is DBH-based biomass.

If false, height-based.


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

Generated on Tue Apr 19 13:56:17 2011 for SORTIE Core C++ Documentation by  doxygen 1.5.6