clConstantBAGrowth Class Reference

Constant basal area growth - Version 1.0. More...

#include <ConstantBAGrowth.h>

Inheritance diagram for clConstantBAGrowth:

clMichMenBase clGrowthBase clBehaviorBase clWorkerBase List of all members.

Public Member Functions

 clConstantBAGrowth (clSimManager *p_oSimManager)
 Constructor.
void SetNameData (char *cNameString)
 Captures the namestring passed to this behavior.
float CalcDiameterGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fHeightGrowth)
 This applies the growth.
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Reads in values from the parameter file.

Detailed Description

Constant basal area growth - Version 1.0.

This is a growth shell object which applies a constant basal area growth to all trees which use it. The constant basal increment is found by dividing the annual area increment by the diameter of the tree (recall that the increment is in squared units). The area increment is already in units per timestep.

This class's namestring is "constbagrowthshell". Call it in the parameter file with the string "constbagrowth", or "constbagrowth diam only" for diameter-only updating.

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta (LEM)


Constructor & Destructor Documentation

clConstantBAGrowth::clConstantBAGrowth ( clSimManager p_oSimManager  ) 

Constructor.

The constructor sets the namestring.

Parameters:
p_oSimManager Sim Manager object.


Member Function Documentation

void clConstantBAGrowth::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:
cNameString Behavior's namestring.

Reimplemented from clBehaviorBase.

float clConstantBAGrowth::CalcDiameterGrowthValue ( clTree p_oTree,
clTreePopulation p_oPop,
float  fHeightGrowth 
) [virtual]

This applies the growth.

Parameters:
p_oTree Tree to which to calculate growth.
p_oPop Tree population object.
fHeightGrowth Amount of height growth, in m (ignored).
Returns:
Amount of diameter increase, in cm.

Reimplemented from clGrowthBase.

void clConstantBAGrowth::DoShellSetup ( xercesc::DOMDocument *  p_oDoc  )  [virtual]

Reads in values from the parameter file.

Parameters:
p_oDoc DOM tree from parsed parameter file.

Reimplemented from clGrowthBase.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:30:42 2007 for SORTIE Core C++ Documentation by  doxygen 1.5.2