This is the base class used to calculate the growth of a stock within the model. More...

#include <growthcalc.h>

Inheritance diagram for GrowthCalcBase:

Collaboration diagram for GrowthCalcBase:

Public Member Functions
	GrowthCalcBase (const IntVector &Areas)
	This is the default GrowthCalcBase constructor. More...

	~GrowthCalcBase ()
	This is the default GrowthCalcBase destructor. More...

virtual void	calcGrowth (int area, DoubleVector &Lgrowth, DoubleVector &Wgrowth, const PopInfoVector &numGrow, const AreaClass const Area, const TimeClass const TimeInfo, const DoubleVector &Fphi, const DoubleVector &MaxCon, const LengthGroupDivision *const LgrpDiv)=0
	This is the function that calculates the growth. More...

virtual double	getPower ()
	This will return the power term of the length - weight relationship. More...

virtual double	getMult ()
	This will return the multiplier of the length - weight relationship. More...

Additional Inherited Members
Protected Member Functions inherited from LivesOnAreas
void	storeAreas (const IntVector &Areas)
	This function will store the internal areas to be used. More...

	LivesOnAreas ()
	This is the default LivesOnAreas constructor. More...

virtual	~LivesOnAreas ()
	This is the default LivesOnAreas destructor. More...

	LivesOnAreas (const IntVector &Areas)
	This is the LivesOnAreas constructor for a specified vector of areas. More...

int	isInArea (int area) const
	This function will check whether the object is defined on a specified area. More...

IntVector &	getAreas ()
	This function will return the internal areas that the object is defined on. More...

int	areaNum (int area) const
	This function will return the area associated with an internal area. More...

Protected Attributes inherited from LivesOnAreas
IntVector	areas
	This is the IntVector of internal areas that the object is defined on. More...

Detailed Description

This is the base class used to calculate the growth of a stock within the model.

Note: This will always be overridden by the derived classes that actually calculate the growth

Constructor & Destructor Documentation

GrowthCalcBase::GrowthCalcBase ( const IntVector & Areas )

This is the default GrowthCalcBase constructor.

Parameters

Areas is the IntVector of areas that the growth calculation can take place on

GrowthCalcBase::~GrowthCalcBase ( )

inline

This is the default GrowthCalcBase destructor.

virtual void GrowthCalcBase::calcGrowth	(	int	area,
		DoubleVector &	Lgrowth,
		DoubleVector &	Wgrowth,
		const PopInfoVector &	numGrow,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo,
		const DoubleVector &	Fphi,
		const DoubleVector &	MaxCon,
		const LengthGroupDivision *const	LgrpDiv
	)

pure virtual

This is the function that calculates the growth.

Parameters

area	is the area that the growth is being calculated on
Lgrowth	is the DoubleVector of the mean length increase for each length group of the stock
Wgrowth	is the DoubleVector of the mean weight increase for each length group of the stock
numGrow	is the PopInfoVector of the current population of the stock
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model
Fphi	is the DoubleVector of the feeding level of the stock
MaxCon	is the DoubleVector of the maximum consumption of the stock
LgrpDiv	is the LengthGroupDivision of the stock