clConstantRadialGrowth Class Reference

Constant radial growth - Version 1.0. More...

#include <ConstantRadialGrowth.h>

Inheritance diagram for clConstantRadialGrowth:

clMichMenBase clGrowthBase clBehaviorBase clWorkerBase List of all members.

Public Member Functions

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

Detailed Description

Constant radial growth - Version 1.0.

This is a growth shell object which applies a constant radial growth to all trees which use it. The radial growth increment, which should have been converted to diameter increment in cm/timestep, is returned directly.

This class's namestring is "constradgrowthshell". The parameter file call string is "constradialgrowth", for diameter growth with auto-height updating, or "constradialgrowth diam only" for diameter-only growth.

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

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


Constructor & Destructor Documentation

clConstantRadialGrowth::clConstantRadialGrowth clSimManager p_oSimManager  ) 
 

Constructor.

The constructor sets the namestring.

Parameters:
p_oSimManager Sim Manager object.


Member Function Documentation

float clConstantRadialGrowth::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 clConstantRadialGrowth::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.

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


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 12:51:10 2006 for SORTIE Core C++ Documentation by  doxygen 1.4.6-NO