This is the class used to model the predation that is due to the action of a fleet in the Gadget model. More...

#include <fleet.h>

Inheritance diagram for Fleet:

Collaboration diagram for Fleet:

Public Member Functions
	Fleet (CommentStream &infile, const char givenname, const AreaClass const Area, const TimeClass const TimeInfo, Keeper const keeper, FleetType ftype)
	This is the Fleet constructor. More...

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

void	Print (ofstream &outfile) const
	This function will print the model population. More...

virtual void	calcEat (int area, const AreaClass const Area, const TimeClass const TimeInfo)
	This function will calculate the modelled consumption for an area in the model. More...

virtual void	checkEat (int area, const TimeClass *const TimeInfo)
	This function will check the modelled consumption for an area in the model. More...

virtual void	adjustEat (int area, const TimeClass *const TimeInfo)
	This function will adjust the modelled consumption for an area in the model. More...

virtual void	reducePop (int area, const TimeClass *const TimeInfo)
	This function will reduce the model population for an area in the model. More...

virtual void	Grow (int area, const AreaClass const Area, const TimeClass const TimeInfo)
	This function will calculate the growth of the model population for an area in the model. More...

virtual void	updateAgePart1 (int area, const TimeClass *const TimeInfo)
	This function will calculate any transition of the model population for an area in the model. More...

virtual void	updateAgePart2 (int area, const TimeClass *const TimeInfo)
	This function will calculate the age increase of the model population for an area in the model. More...

virtual void	updateAgePart3 (int area, const TimeClass *const TimeInfo)
	This function will implement the transiton of the model population for an area in the model. More...

virtual void	updatePopulationPart1 (int area, const TimeClass *const TimeInfo)
	This function will calculate the spawning of the model population for an area in the model. More...

virtual void	updatePopulationPart2 (int area, const TimeClass *const TimeInfo)
	This function will calculate add the newly matured stock into the model population for an area in the model. More...

virtual void	updatePopulationPart3 (int area, const TimeClass *const TimeInfo)
	This function will calculate add the new recruits into the model population for an area in the model. More...

virtual void	updatePopulationPart4 (int area, const TimeClass *const TimeInfo)
	This function will calculate calculate the straying of the model population for an area in the model. More...

virtual void	updatePopulationPart5 (int area, const TimeClass *const TimeInfo)
	This function will calculate add the strayed stock into the model population for an area in the model. More...

virtual void	calcNumbers (int area, const TimeClass *const TimeInfo)
	This function will update the model population for an area in the model. More...

virtual void	Migrate (const TimeClass *const TimeInfo)
	This function will implement the migration of the model population for the model. More...

virtual void	Reset (const TimeClass *const TimeInfo)
	This function will reset the model population. More...

LengthPredator *	getPredator () const
	This will return the fleet, as a predator type, for use in other functions. More...

int	isFleetStepArea (int area, const TimeClass *const TimeInfo)
	This will check if the fleet will operate on the current timestep. More...

FleetType	getType () const
	This will return the type of fleet class. More...

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

	BaseClass (const char *givenname)
	This is the BaseClass constructor for an object with a name. More...

	BaseClass (const char *givenname, const IntVector &Areas)
	This is the BaseClass constructor for an object with a name and an area. More...

virtual	~BaseClass ()
	This is the default BaseClass destructor. 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
LengthPredator *	predator
	This is the fleet, as a predator in the current model. More...

FormulaMatrix	amount
	This is the amount of the preys that the fleet has consumed. More...

PopInfoMatrix	tmpPopulation
	This is the PopInfoMatrix used to temporarily store the amount consumed. 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 the predation that is due to the action of a fleet in the Gadget model.

This class calculates the catch of the fleets that are to be modelled within the simulation. The fleets are treated as (non-dynamic) predators that ''eat'' the stock that is defined as the prey of the fleet. The amount of the stock that is eaten is calculated by the predator that is associated with the fleet. There are 5 types of fleet, each with a different predator class to calculate the level of predation. A fleet that has been declared as a TOTALFLEET uses the TotalPredator class to calculate the predation, a LINEARFLEET uses the LinearPredator class to calculate the predation, a NUMBERFLEET uses the NumberPredator class to calculate the predation by number, a EFFORTFLEET uses the EffortPredator class to calculate the predation based on effort data and a QUOTAFLEET uses the QuotaPredator class to calculate the fishing quota based on the biomass of stock available, and then uses this calculated fishing level to calculate the predation of the stock.

Constructor & Destructor Documentation

◆ Fleet()

Fleet::Fleet	(	CommentStream &	infile,
		const char *	givenname,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper,
		FleetType	ftype
	)

This is the Fleet constructor.

Parameters

infile	is the CommentStream to read the fleet parameters from
givenname	is the name of the fleet
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model
keeper	is the Keeper for the current model
ftype	is the FleetType of the fleet

◆ ~Fleet()

Fleet::~Fleet ( )

virtual

This is the default Fleet destructor.

Member Function Documentation

◆ adjustEat()

void Fleet::adjustEat	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will adjust the modelled consumption for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ calcEat()

void Fleet::calcEat	(	int	area,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate the modelled consumption for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ calcNumbers()

void Fleet::calcNumbers	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will update the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ checkEat()

virtual void Fleet::checkEat	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will check the modelled consumption for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ getPredator()

LengthPredator* Fleet::getPredator ( ) const

inline

This will return the fleet, as a predator type, for use in other functions.

Returns: predator

◆ getType()

FleetType Fleet::getType ( ) const

inline

This will return the type of fleet class.

Returns: type

◆ Grow()

virtual void Fleet::Grow	(	int	area,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate the growth of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ isFleetStepArea()

int Fleet::isFleetStepArea	(	int	area,
		const TimeClass *const	TimeInfo
	)

This will check if the fleet will operate on the current timestep.

Parameters

area	is the area that the fleet will operate on
TimeInfo	is the TimeClass for the current model

Returns: 1 if the fleet will operate, 0 otherwise

◆ Migrate()

virtual void Fleet::Migrate ( const TimeClass *const TimeInfo )

inlinevirtual

This function will implement the migration of the model population for the model.

Parameters

TimeInfo is the TimeClass for the current model

Implements BaseClass.

◆ Print()

void Fleet::Print ( ofstream & outfile ) const

virtual

This function will print the model population.

Parameters

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

Implements BaseClass.

◆ reducePop()

virtual void Fleet::reducePop	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will reduce the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ Reset()

void Fleet::Reset ( const TimeClass *const TimeInfo )

virtual

This function will reset the model population.

Parameters

TimeInfo is the TimeClass for the current model

Implements BaseClass.

◆ updateAgePart1()

virtual void Fleet::updateAgePart1	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate any transition of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updateAgePart2()

virtual void Fleet::updateAgePart2	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate the age increase of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updateAgePart3()

virtual void Fleet::updateAgePart3	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will implement the transiton of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart1()

virtual void Fleet::updatePopulationPart1	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate the spawning of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart2()

virtual void Fleet::updatePopulationPart2	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate add the newly matured stock into the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart3()

virtual void Fleet::updatePopulationPart3	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate add the new recruits into the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart4()

virtual void Fleet::updatePopulationPart4	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate calculate the straying of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart5()

virtual void Fleet::updatePopulationPart5	(	int	area,
		const TimeClass *const	TimeInfo
	)

inlinevirtual

This function will calculate add the strayed stock into the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

Member Data Documentation

◆ amount

FormulaMatrix Fleet::amount

protected

This is the amount of the preys that the fleet has consumed.

◆ predator

LengthPredator* Fleet::predator

protected

This is the fleet, as a predator in the current model.

◆ tmpPopulation

PopInfoMatrix Fleet::tmpPopulation

protected

This is the PopInfoMatrix used to temporarily store the amount consumed.

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

src/include/fleet.h
src/fleet.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Fleet()

◆ ~Fleet()

Member Function Documentation

◆ adjustEat()

◆ calcEat()

◆ calcNumbers()

◆ checkEat()

◆ getPredator()

◆ getType()

◆ Grow()

◆ isFleetStepArea()

◆ Migrate()

◆ Print()

◆ reducePop()

◆ Reset()

◆ updateAgePart1()

◆ updateAgePart2()

◆ updateAgePart3()

◆ updatePopulationPart1()

◆ updatePopulationPart2()

◆ updatePopulationPart3()

◆ updatePopulationPart4()

◆ updatePopulationPart5()

Member Data Documentation

◆ amount

◆ predator

◆ tmpPopulation