This is the class used to calculate the growth of a stock using a power growth function. More...

#include <growthcalc.h>

Inheritance diagram for GrowthCalcG:

Collaboration diagram for GrowthCalcG:

Public Member Functions
	GrowthCalcG (CommentStream &infile, const IntVector &Areas, const TimeClass const TimeInfo, Keeper const keeper, const AreaClass *const Area, const CharPtrVector &lenindex)
	This is the default GrowthCalcG constructor. More...

	~GrowthCalcG ()
	This is the default GrowthCalcG 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)
	This is the function that calculates the growth using a power growth function. More...

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

	~GrowthCalcBase ()
	This is the default GrowthCalcBase destructor. 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...

Protected Attributes
int	numGrowthConstants
	This is the number of growth parameters (set to 2) More...

ModelVariableVector	growthPar
	This is the ModelVariableVector of growth parameters. More...

FormulaMatrixPtrVector	wgrowth
	This is the FormulaMatrixPtrVector of increase in weight for each length group. More...

Protected Attributes inherited from LivesOnAreas
IntVector	areas
	This is the IntVector of internal areas that the object is defined on. 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...

Detailed Description

This is the class used to calculate the growth of a stock using a power growth function.

Constructor & Destructor Documentation

◆ GrowthCalcG()

GrowthCalcG::GrowthCalcG	(	CommentStream &	infile,
		const IntVector &	Areas,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper,
		const AreaClass *const	Area,
		const CharPtrVector &	lenindex
	)

This is the default GrowthCalcG constructor.

Parameters

infile	is the CommentStream to read the growth parameters from
Areas	is the IntVector of areas that the growth calculation can take place on
TimeInfo	is the TimeClass for the current model
keeper	is the Keeper for the current model
Area	is the AreaClass for the current model
lenindex	is the CharPtrVector of the lengths used for the growth of the stock

◆ ~GrowthCalcG()

GrowthCalcG::~GrowthCalcG ( )

This is the default GrowthCalcG destructor.

Member Function Documentation

◆ calcGrowth()

void GrowthCalcG::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
	)

virtual

This is the function that calculates the growth using a power growth function.

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 PopInfoVector of the 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

Implements GrowthCalcBase.

Member Data Documentation

◆ growthPar

ModelVariableVector GrowthCalcG::growthPar

protected

This is the ModelVariableVector of growth parameters.

◆ numGrowthConstants

int GrowthCalcG::numGrowthConstants

protected

This is the number of growth parameters (set to 2)

◆ wgrowth

FormulaMatrixPtrVector GrowthCalcG::wgrowth

protected

This is the FormulaMatrixPtrVector of increase in weight for each length group.

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

src/include/growthcalc.h
src/growthcalc.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GrowthCalcG()

◆ ~GrowthCalcG()

Member Function Documentation

◆ calcGrowth()

Member Data Documentation

◆ growthPar

◆ numGrowthConstants

◆ wgrowth