This is the class used to calculate the growth of a stock using a simple length based Gompertz function. More...

#include <growthcalc.h>

Inheritance diagram for GrowthCalcK:

Collaboration diagram for GrowthCalcK:

Public Member Functions
	GrowthCalcK (CommentStream &infile, const IntVector &Areas, const TimeClass const TimeInfo, Keeper const keeper)
	This is the default GrowthCalcK constructor. More...

	~GrowthCalcK ()
	This is the default GrowthCalcK 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 simple length based Gompertz function. 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...

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...

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

ModelVariableVector	growthPar
	This is the ModelVariableVector of growth parameters. 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 simple length based Gompertz function.

Constructor & Destructor Documentation

◆ GrowthCalcK()

GrowthCalcK::GrowthCalcK	(	CommentStream &	infile,
		const IntVector &	Areas,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper
	)

This is the default GrowthCalcK 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

◆ ~GrowthCalcK()

GrowthCalcK::~GrowthCalcK ( )

inline

This is the default GrowthCalcK destructor.

Member Function Documentation

◆ calcGrowth()

void GrowthCalcK::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 simple length based Gompertz 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 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

Implements GrowthCalcBase.

◆ getMult()

virtual double GrowthCalcK::getMult ( )

inlinevirtual

This will return the multiplier of the length - weight relationship.

Returns: growthPar[3]

Reimplemented from GrowthCalcBase.

◆ getPower()

virtual double GrowthCalcK::getPower ( )

inlinevirtual

This will return the power term of the length - weight relationship.

Returns: growthPar[4]

Reimplemented from GrowthCalcBase.

Member Data Documentation

◆ growthPar

ModelVariableVector GrowthCalcK::growthPar

protected

This is the ModelVariableVector of growth parameters.

◆ numGrowthConstants

int GrowthCalcK::numGrowthConstants