This is the class used to model a dynamic prey based on a modelled stock. More...

#include <stockprey.h>

Inheritance diagram for StockPrey:

Collaboration diagram for StockPrey:

Public Member Functions
	StockPrey (CommentStream &infile, const IntVector &Areas, const char givenname, int minage, int numage, const TimeClass const TimeInfo, Keeper *const keeper)
	This is the StockPrey constructor. More...

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

virtual void	Sum (const AgeBandMatrix &stockAlkeys, int area)
	This will calculate the amount of prey that is consumed for a given area and timestep. More...

virtual void	Print (ofstream &outfile) const
	This function will print the prey information. More...

int	minAge () const
	This will return the minimum age of the prey. More...

int	maxAge () const
	This will return the maximum age of the prey. More...

AgeBandMatrix &	getConsumptionALK (int area)
	This function will return the amount of prey on the area before consumption. More...

Public Member Functions inherited from Prey
	Prey (CommentStream &infile, const IntVector &areas, const char givenname, const TimeClass const TimeInfo, Keeper *const keeper)
	This is the Prey constructor to create a prey by reading data from a file. More...

	Prey (CommentStream &infile, const char givenname, const IntVector &areas, const TimeClass const TimeInfo, Keeper *const keeper)
	This is the Prey constructor for a prey with a given length group. More...

virtual	~Prey ()=0
	This is the default Prey destructor. More...

virtual void	Sum (const PopInfoVector &NumberInArea, int area)
	This will calculate the amount of prey that is consumed for a given area and timestep. More...

virtual void	Reset (const TimeClass *const TimeInfo)
	This will reset the consumption information for the current model run. More...

virtual void	setCI (const LengthGroupDivision *const GivenLDiv)
	This will set the ConversionIndex required for to calculate the consumption. More...

virtual void	Subtract (AgeBandMatrix &Alkeys, int area)
	This function will subtract the prey that is consumed from the stock. More...

void	addBiomassConsumption (int area, const DoubleVector &predcons)
	This function will add predation (by biomass) to the amount of the prey that is consumed. More...

void	addNumbersConsumption (int area, const DoubleVector &predcons)
	This function will add predation (by numbers) to the amount of the prey that is consumed. More...

virtual void	checkConsumption (int area, const TimeClass *const TimeInfo)
	This function will check for overconsumption of the prey. More...

double	getBiomass (int area, int length) const
	This will return the biomass of prey that is available for consumption by predators. More...

double	getNumber (int area, int length) const
	This will return the number of prey that is available for consumption by predators. More...

double	getTotalBiomass (int area) const
	This will return the total biomass of prey that is available for consumption. More...

int	isOverConsumption (int area)
	This will return the flag that denotes if the prey has been overconsumed on a given area. More...

const DoubleVector &	getRatio (int area) const
	This will return the ratio of the prey that has been consumed on a given area. More...

const DoubleVector &	getUseRatio (int area) const
	This will return the ratio of the prey that has been consumed on a given area. More...

const DoubleVector &	getConsumption (int area) const
	This will return the amount of the prey that has been consumed on a given area. More...

const DoubleVector &	getOverConsumption (int area) const
	This will return the amount of the prey that has been overconsumed on a given area. More...

double	getTotalOverConsumption (int area) const
	This will return the total amount of the prey that has been overconsumed on a given area. More...

const LengthGroupDivision *	getLengthGroupDiv () const
	This will return the length group information for the prey. More...

const PopInfoVector &	getConsumptionPopInfo (int area) const
	This will return the amount of prey on a given area prior to any consumption by the predators. More...

double	getEnergy () const
	This will return the energy content of the prey. More...

int	isPreyArea (int area)
	This will check if there is any prey to consume on a given area. More...

PreyType	getType () const
	This will return the type of prey class. More...

Public Member Functions inherited from HasName
	HasName ()
	This is the default HasName constructor. More...

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

	HasName (const char *givenname)
	This is the HasName constructor for a specified name. More...

const char *	getName () const
	This will return a null terminated text string containing the name of the object. More...

Public Member Functions inherited from LivesOnAreas
	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
AgeBandMatrixPtrVector	preyAlkeys
	This is the AgeBandMatrixPtrVector used to store the amount of the prey on each area. More...

Protected Attributes inherited from Prey
ConversionIndex *	CI
	This is the ConversionIndex used to convert from the stock LengthGroupDivision to the LengthGroupDivision used for the consumption calculation. More...

LengthGroupDivision *	LgrpDiv
	This is the LengthGroupDivision used to store length information. More...

PopInfoMatrix	preynumber
	This is the PopInfoMatrix used to store information on the number of preys for the current timestep. More...

ModelVariable	energy
	This is the ModelVariable used to store the energy content of the prey (in kilojoules per kilogramme) More...

DoubleMatrix	biomass
	This is the DoubleMatrix used to store information on the biomass of the prey that is available for the predators to consume on the current timestep. More...

DoubleVector	total
	This is the DoubleVector used to store information on the total biomass of the prey that is available for the predators to consume on the current timestep. More...

DoubleMatrix	ratio
	This is the DoubleMatrix used to store information on the ratio of the available biomass of the prey that is available for the predators to consume has been consumed on the current timestep. More...

DoubleMatrix	useratio
	This is the DoubleMatrix used to store information on the ratio of the available biomass of the prey that is available for the predators to consume has been consumed on the current timestep, adjusted to MaxRatio whenever overconsumption has occured. More...

DoubleMatrix	consumption
	This is the DoubleMatrix used to store information on the consumption of the prey on the current timestep. More...

DoubleMatrix	cons
	This is the DoubleMatrix used to store information on the consumption of the prey on the current substep of the current timestep. More...

DoubleMatrix	overconsumption
	This is the DoubleMatrix used to store information on the overconsumption of the prey on the current timestep. More...

IntVector	isoverconsumption
	This is the IntVector used to store information on whether any overconsumption has occured on the current timestep. More...

DoubleMatrix	consratio
	This is the DoubleMatrix used to store information on the ratio of the prey to subtract on the current timestep. More...

PreyType	type
	This denotes what type of prey class has been created. 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...

Detailed Description

This is the class used to model a dynamic prey based on a modelled stock.

Constructor & Destructor Documentation

◆ StockPrey()

StockPrey::StockPrey	(	CommentStream &	infile,
		const IntVector &	Areas,
		const char *	givenname,
		int	minage,
		int	numage,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper
	)

This is the StockPrey constructor.

Parameters

infile	is the CommentStream to read the prey parameters from
Areas	is the IntVector of areas that the prey lives on
givenname	is the name of the prey
minage	is the minimum age of the prey
numage	is the number of age groups for the prey
TimeInfo	is the TimeClass for the current model
keeper	is the Keeper for the current model

◆ ~StockPrey()

virtual StockPrey::~StockPrey ( )

inlinevirtual

This is the default StockPrey destructor.

Member Function Documentation

◆ getConsumptionALK()

AgeBandMatrix& StockPrey::getConsumptionALK ( int area )

inline

This function will return the amount of prey on the area before consumption.

Parameters

area	is the area that the prey consumption is being calculated on

Returns: preyAlkeys, the population of the prey for the area before consumption

◆ maxAge()

int StockPrey::maxAge ( ) const

inline

This will return the maximum age of the prey.

Returns: maximum age

◆ minAge()

int StockPrey::minAge ( ) const

inline

This will return the minimum age of the prey.

Returns: minimum age

◆ Print()

void StockPrey::Print ( ofstream & outfile ) const

virtual

This function will print the prey information.

Parameters

outfile is the ofstream that all the model information gets sent to

Reimplemented from Prey.

◆ Sum()

void StockPrey::Sum	(	const AgeBandMatrix &	stockAlkeys,
		int	area
	)

virtual

This will calculate the amount of prey that is consumed for a given area and timestep.

Parameters

stockAlkeys	is the AgeBandMatrix giving the amount of prey in the area
area	is the area that the prey consumption is being calculated on

Reimplemented from Prey.

Member Data Documentation

◆ preyAlkeys

AgeBandMatrixPtrVector StockPrey::preyAlkeys

protected

This is the AgeBandMatrixPtrVector used to store the amount of the prey on each area.

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

src/include/stockprey.h
src/stockprey.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StockPrey()

◆ ~StockPrey()

Member Function Documentation

◆ getConsumptionALK()

◆ maxAge()

◆ minAge()

◆ Print()

◆ Sum()

Member Data Documentation

◆ preyAlkeys