#include <PartitionedBiomass.h>
Public Member Functions | |
clPartitionedBiomass (clSimManager *p_oSimManager) | |
Constructor. | |
~clPartitionedBiomass () | |
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 | GetAppliesTo () |
Sets up the mp_bWhichAppliesTo array with the flags for each species and tree type and whether this behavior applies to it. | |
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 () |
Sets up the "Partitioned Biomass" grid. | |
Protected Attributes | |
clGridBase * | mp_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. | |
bool ** | mp_bAppliesTo |
Whether this behavior applies to each kind of tree. | |
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 "Partitioned Biomass" grid. | |
short int * | mp_iBoleCodes |
Holds data member codes for the "bole_x" data members of the "Partitioned Biomass" grid. | |
short int * | mp_iHLeafCodes |
Holds data member codes for the "hleaf_x" data members of the "Partitioned Biomass" grid. | |
short int * | mp_iHBoleCodes |
Holds data member codes for the "hbole_x" data members of the "Partitioned Biomass" grid. | |
short int | m_iNumTotalSpecies |
Total number of species. | |
bool | m_bIsDbh |
If true, this is DBH-based biomass. |
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:
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 "Partitioned Biomass." If using with DBH, the parameter file call string is "Partitioned DBH Biomass". If using with Height, the parameter file call string is "Partitioned Height Biomass".
This behavior may not be applied to seedlings.
Edit history:
-----------------
November 3, 2006 - Created (LEM)
clPartitionedBiomass::clPartitionedBiomass | ( | clSimManager * | p_oSimManager | ) |
clPartitionedBiomass::~clPartitionedBiomass | ( | ) |
Destructor.
Deletes arrays.
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.
void clPartitionedBiomass::GetData | ( | xercesc::DOMDocument * | p_oDoc | ) | [virtual] |
Does setup for this behavior.
Calls:
p_oDoc | DOM tree of parsed input file. |
modelErr | if this behavior has been applied to seedlings. |
Implements clWorkerBase.
void clPartitionedBiomass::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.
cNameString | Behavior's namestring. |
modelErr | if the namestring is not recognized. |
Reimplemented from clBehaviorBase.
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.
void clPartitionedBiomass::GetTreeCodes | ( | clTreePopulation * | p_oPop | ) | [protected] |
Sets up the mp_iDbhCodes or mp_iHeightCodes, depending on the type of biomass this is.
p_oPop | Tree population object |
void clPartitionedBiomass::GetParameterFileData | ( | xercesc::DOMDocument * | p_oDoc, | |
clTreePopulation * | p_oPop | |||
) | [protected] |
Reads values from the parameter file.
p_oDoc | DOM tree of parsed input file. | |
p_oPop | Tree population object. |
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.
p_oPop | Tree population object. |
void clPartitionedBiomass::SetupGrid | ( | ) | [protected] |
Sets up the "Partitioned Biomass" grid.
This ignores any maps.
clGridBase* clPartitionedBiomass::mp_oGrid [protected] |
Grid holding total values for each species.
The grid name is "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", and "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.
float* clPartitionedBiomass::mp_fDBHLeafA [protected] |
"a" for the DBH-based leaf biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fDBHLeafB [protected] |
"b" for the DBH-based leaf biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fDBHBranchA [protected] |
"a" for the DBH-based branch biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fDBHBranchB [protected] |
"b" for the DBH-based branch biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fDBHBoleA [protected] |
"a" for the DBH-based bole biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fDBHBoleB [protected] |
"b" for the DBH-based bole biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fHeightLeafA [protected] |
"a" for the height-based leaf biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fHeightLeafB [protected] |
"b" for the height-based leaf biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fHeightBoleA [protected] |
"a" for the height-based bole biomass.
Array size is # total species.
float* clPartitionedBiomass::mp_fHeightBoleB [protected] |
"b" for the height-based bole biomass.
Array size is # total species.
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.
short int** clPartitionedBiomass::mp_iDbhCodes [protected] |
Holds codes for DBH data member.
First array index is total # species, second is number types (3 - sapling, adult, snag).
short int** clPartitionedBiomass::mp_iHeightCodes [protected] |
Holds codes for Height data member.
First array index is total # species, second is number types (3 - sapling, adult, snag).
short int** clPartitionedBiomass::mp_iXCodes [protected] |
Holds codes for X data member.
First array index is total # species, second is number types (3 - sapling, adult, snag).
short int** clPartitionedBiomass::mp_iYCodes [protected] |
Holds codes for Y data member.
First array index is total # species, second is number types (3 - sapling, adult, snag).
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).
short int* clPartitionedBiomass::mp_iLeafCodes [protected] |
Holds data member codes for the "leaf_x" data members of the "Partitioned Biomass" grid.
Array size is total # species.
short int* clPartitionedBiomass::mp_iBranchCodes [protected] |
Holds data member codes for the "branch_x" data members of the "Partitioned Biomass" grid.
Array size is total # species.
short int* clPartitionedBiomass::mp_iBoleCodes [protected] |
Holds data member codes for the "bole_x" data members of the "Partitioned Biomass" grid.
Array size is total # species.
short int* clPartitionedBiomass::mp_iHLeafCodes [protected] |
Holds data member codes for the "hleaf_x" data members of the "Partitioned Biomass" grid.
Array size is total # species.
short int* clPartitionedBiomass::mp_iHBoleCodes [protected] |
Holds data member codes for the "hbole_x" data members of the "Partitioned Biomass" grid.
Array size is total # species.
short int clPartitionedBiomass::m_iNumTotalSpecies [protected] |
Total number of species.
For the destructor.
bool clPartitionedBiomass::m_bIsDbh [protected] |
If true, this is DBH-based biomass.
If false, height-based.