This is the class used to calculate the growth of a stock using an extended form of the Von Bertalanffy function. More...

#include <growthcalc.h>

Inheritance diagram for GrowthCalcE:

Collaboration diagram for GrowthCalcE:

Public Member Functions
	GrowthCalcE (CommentStream &infile, const IntVector &Areas, const TimeClass const TimeInfo, const LengthGroupDivision const LgrpDiv, Keeper const keeper, const char refWeightFile)
	This is the default GrowthCalcE constructor. More...

	~GrowthCalcE ()
	This is the default GrowthCalcE 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 an extended Von Bertalanffy growth 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	numWeightGrowthConstants
	This is the number of weight growth parameters (set to 6) More...

int	numLengthGrowthConstants
	This is the number of length growth parameters (set to 9) More...

ModelVariableVector	wgrowthPar
	This is the ModelVariableVector of weight growth parameters. More...

ModelVariableVector	lgrowthPar
	This is the ModelVariableVector of length growth parameters. More...

DoubleVector	refWeight
	This is the DoubleVector of the reference weight values. More...

FormulaVector	yearEffect
	This is the FormulaVector of parameters for the year effect. More...

FormulaVector	stepEffect
	This is the FormulaVector of parameters for the step effect. More...

FormulaVector	areaEffect
	This is the FormulaVector of parameters for the area effect. 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 an extended form of the Von Bertalanffy function.

Constructor & Destructor Documentation

◆ GrowthCalcE()

GrowthCalcE::GrowthCalcE	(	CommentStream &	infile,
		const IntVector &	Areas,
		const TimeClass *const	TimeInfo,
		const LengthGroupDivision *const	LgrpDiv,
		Keeper *const	keeper,
		const char *	refWeightFile
	)

This is the default GrowthCalcE 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
LgrpDiv	is the LengthGroupDivision of the stock
keeper	is the Keeper for the current model
refWeightFile	is the name of the file containing the reference weight information for the stock

◆ ~GrowthCalcE()

GrowthCalcE::~GrowthCalcE ( )

inline

This is the default GrowthCalcE destructor.

Member Function Documentation

◆ calcGrowth()

void GrowthCalcE::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 an extended Von Bertalanffy 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 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 GrowthCalcE::getMult ( )

inlinevirtual

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

Returns: lgrowthPar[6]

Reimplemented from GrowthCalcBase.

◆ getPower()

virtual double GrowthCalcE::getPower ( )

inlinevirtual

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

Returns: lgrowthPar[7]

Reimplemented from GrowthCalcBase.

Member Data Documentation

◆ areaEffect

FormulaVector GrowthCalcE::areaEffect

protected

This is the FormulaVector of parameters for the area effect.

◆ lgrowthPar

ModelVariableVector GrowthCalcE::lgrowthPar

protected

This is the ModelVariableVector of length growth parameters.

◆ numLengthGrowthConstants

int GrowthCalcE::numLengthGrowthConstants

protected

This is the number of length growth parameters (set to 9)

◆ numWeightGrowthConstants

int GrowthCalcE::numWeightGrowthConstants

protected

This is the number of weight growth parameters (set to 6)

◆ refWeight

DoubleVector GrowthCalcE::refWeight

protected

This is the DoubleVector of the reference weight values.

◆ stepEffect

FormulaVector GrowthCalcE::stepEffect

protected

This is the FormulaVector of parameters for the step effect.

◆ wgrowthPar

ModelVariableVector GrowthCalcE::wgrowthPar

protected

This is the ModelVariableVector of weight growth parameters.

◆ yearEffect

FormulaVector GrowthCalcE::yearEffect

protected

This is the FormulaVector of parameters for the year effect.

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

◆ GrowthCalcE()

◆ ~GrowthCalcE()

Member Function Documentation

◆ calcGrowth()

◆ getMult()

◆ getPower()

Member Data Documentation

◆ areaEffect

◆ lgrowthPar

◆ numLengthGrowthConstants

◆ numWeightGrowthConstants

◆ refWeight

◆ stepEffect

◆ wgrowthPar

◆ yearEffect