gadget2/reference/fleet_8h_source.html

 #ifndef fleet_h

 #define fleet_h


 #include "base.h"

 #include "formulamatrix.h"

 #include "lengthpredator.h"

 #include "keeper.h"


 enum FleetType { TOTALFLEET = 1, LINEARFLEET, NUMBERFLEET, EFFORTFLEET, QUOTAFLEET };


 class Fleet : public BaseClass {

 public:

   Fleet(CommentStream& infile, const char* givenname, const AreaClass* const Area,

      const TimeClass* const TimeInfo, Keeper* const keeper, FleetType ftype);

   virtual ~Fleet();

   void Print(ofstream& outfile) const;

   virtual void calcEat(int area, const AreaClass* const Area, const TimeClass* const TimeInfo);

   virtual void checkEat(int area, const TimeClass* const TimeInfo) {};

   virtual void adjustEat(int area, const TimeClass* const TimeInfo);

   virtual void reducePop(int area, const TimeClass* const TimeInfo) {};

   virtual void Grow(int area, const AreaClass* const Area, const TimeClass* const TimeInfo) {};

   virtual void updateAgePart1(int area, const TimeClass* const TimeInfo) {};

   virtual void updateAgePart2(int area, const TimeClass* const TimeInfo) {};

   virtual void updateAgePart3(int area, const TimeClass* const TimeInfo) {};

   virtual void updatePopulationPart1(int area, const TimeClass* const TimeInfo) {};

   virtual void updatePopulationPart2(int area, const TimeClass* const TimeInfo) {};

   virtual void updatePopulationPart3(int area, const TimeClass* const TimeInfo) {};

   virtual void updatePopulationPart4(int area, const TimeClass* const TimeInfo) {};

   virtual void updatePopulationPart5(int area, const TimeClass* const TimeInfo) {};

   virtual void calcNumbers(int area, const TimeClass* const TimeInfo);

   virtual void Migrate(const TimeClass* const TimeInfo) {};

   virtual void Reset(const TimeClass* const TimeInfo);

   LengthPredator* getPredator() const { return predator; };

   int isFleetStepArea(int area, const TimeClass* const TimeInfo);

   FleetType getType() const { return type; };

 protected:

   LengthPredator* predator;

   FormulaMatrix amount;

   PopInfoMatrix tmpPopulation;

 private:

   FleetType type;

 };


 #endif

base.h

AreaClass
This is the class used to store information about the areas used for the current model.
Definition: areatime.h:18

BaseClass
This is the base class for any object that can be dynamically modelled within Gadget.
Definition: base.h:13

CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40

Fleet
This is the class used to model the predation that is due to the action of a fleet in the Gadget mode...
Definition: fleet.h:17

Fleet::predator
LengthPredator * predator
This is the fleet, as a predator in the current model.
Definition: fleet.h:151

Fleet::calcNumbers
virtual void calcNumbers(int area, const TimeClass *const TimeInfo)
This function will update the model population for an area in the model.
Definition: fleet.cc:115

Fleet::amount
FormulaMatrix amount
This is the amount of the preys that the fleet has consumed.
Definition: fleet.h:160

Fleet::~Fleet
virtual ~Fleet()
This is the default Fleet destructor.
Definition: fleet.cc:99

Fleet::Print
void Print(ofstream &outfile) const
This function will print the model population.
Definition: fleet.cc:128

Fleet::updateAgePart1
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.
Definition: fleet.h:76

Fleet::checkEat
virtual void checkEat(int area, const TimeClass *const TimeInfo)
This function will check the modelled consumption for an area in the model.
Definition: fleet.h:51

Fleet::isFleetStepArea
int isFleetStepArea(int area, const TimeClass *const TimeInfo)
This will check if the fleet will operate on the current timestep.
Definition: fleet.cc:133

Fleet::Grow
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.
Definition: fleet.h:70

Fleet::reducePop
virtual void reducePop(int area, const TimeClass *const TimeInfo)
This function will reduce the model population for an area in the model.
Definition: fleet.h:63

Fleet::adjustEat
virtual void adjustEat(int area, const TimeClass *const TimeInfo)
This function will adjust the modelled consumption for an area in the model.
Definition: fleet.cc:110

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.
Definition: fleet.cc:15

Fleet::calcEat
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.
Definition: fleet.cc:103

Fleet::tmpPopulation
PopInfoMatrix tmpPopulation
This is the PopInfoMatrix used to temporarily store the amount consumed.
Definition: fleet.h:164

Fleet::updatePopulationPart5
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...
Definition: fleet.h:118

Fleet::updatePopulationPart2
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...
Definition: fleet.h:100

Fleet::updatePopulationPart4
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.
Definition: fleet.h:112

Fleet::getPredator
LengthPredator * getPredator() const
This will return the fleet, as a predator type, for use in other functions.
Definition: fleet.h:139

Fleet::Migrate
virtual void Migrate(const TimeClass *const TimeInfo)
This function will implement the migration of the model population for the model.
Definition: fleet.h:129

Fleet::updatePopulationPart3
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.
Definition: fleet.h:106

Fleet::getType
FleetType getType() const
This will return the type of fleet class.
Definition: fleet.h:151

Fleet::updatePopulationPart1
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.
Definition: fleet.h:94

Fleet::updateAgePart2
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.
Definition: fleet.h:82

Fleet::updateAgePart3
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.
Definition: fleet.h:88

Fleet::Reset
virtual void Reset(const TimeClass *const TimeInfo)
This function will reset the model population.
Definition: fleet.cc:120

FormulaMatrix
This class implements a dynamic vector of FormulaVector values.
Definition: formulamatrix.h:11

Keeper
This is the class used to store information about the variables that are used in model simulation.
Definition: keeper.h:17

LengthPredator
This is the class used to model the predation of stocks by a fleet.
Definition: lengthpredator.h:10

PopInfoMatrix
This class implements a dynamic vector of PopInfoVector values.
Definition: popinfomatrix.h:11

TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87

FleetType
FleetType
Definition: fleet.h:9

NUMBERFLEET
@ NUMBERFLEET
Definition: fleet.h:9

LINEARFLEET
@ LINEARFLEET
Definition: fleet.h:9

QUOTAFLEET
@ QUOTAFLEET
Definition: fleet.h:9

TOTALFLEET
@ TOTALFLEET
Definition: fleet.h:9

EFFORTFLEET
@ EFFORTFLEET
Definition: fleet.h:9

formulamatrix.h

keeper.h

lengthpredator.h