clPowerHeightGrowth Class Reference

Increments height growth according to a power equation. More...

#include <PowerHeightGrowth.h>

Inheritance diagram for clPowerHeightGrowth:

clGrowthBase clBehaviorBase clWorkerBase

List of all members.

Public Member Functions

 clPowerHeightGrowth (clSimManager *p_oSimManager)
 Constructor.
 ~clPowerHeightGrowth ()
 Destructor.
float CalcHeightGrowthValue (clTree *p_oTree, clTreePopulation *p_oPop, float fDiameterGrowth)
 Calculates the amount of height growth increase for a particular tree using the power growth equation.
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Does the setup for this behavior.

Protected Attributes

float * mp_fN
 n - sized number of species
float * mp_fB
 b - sized number of species
float m_fNumberYearsPerTimestep
 Number of years per timestep - from sim manager.


Detailed Description

Increments height growth according to a power equation.

The equation used in this behavior is:

Y = n * Hb
where

This is looped over the number of years per timestep, allowing H to increment at each intermediate year.

The name string is "powergrowthshell". In the parameter file, call "power growth height only".

Copyright 2009 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 7, 2009 - Created (LEM)

Constructor & Destructor Documentation

clPowerHeightGrowth::clPowerHeightGrowth ( clSimManager p_oSimManager  ) 

Constructor.

Sets the namestring.

clPowerHeightGrowth::~clPowerHeightGrowth (  ) 

Destructor.

Frees memory.


Member Function Documentation

float clPowerHeightGrowth::CalcHeightGrowthValue ( clTree p_oTree,
clTreePopulation p_oPop,
float  fDiameterGrowth 
) [virtual]

Calculates the amount of height growth increase for a particular tree using the power growth equation.

Parameters:
p_oTree Tree for which to calculate growth.
p_oPop Tree population object, just in case it's needed.
fDiameterGrowth Amount of diameter growth for this tree, in cm.
Returns:
Amount, in m, by which to increase the tree's height.

Reimplemented from clGrowthBase.

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

Does the setup for this behavior.

This reads in the parameters from the parameter file.

Parameters:
p_oDoc Parsed parameter file.

Reimplemented from clGrowthBase.


Member Data Documentation

float* clPowerHeightGrowth::mp_fN [protected]

n - sized number of species

float* clPowerHeightGrowth::mp_fB [protected]

b - sized number of species

Number of years per timestep - from sim manager.


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

Generated on Wed Oct 28 13:58:48 2009 for SORTIE Core C++ Documentation by  doxygen 1.5.6