gadget2/reference/otherfood_8h_source.html

 #ifndef otherfood_h

 #define otherfood_h


 #include "formulamatrix.h"

 #include "lengthprey.h"

 #include "base.h"


 class OtherFood : public BaseClass {

 public:

   OtherFood(CommentStream& infile, const char* givenname,

     const AreaClass* const Area, const TimeClass* const TimeInfo, Keeper* const keeper);

   virtual ~OtherFood();

   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);

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

   LengthPrey* getPrey() const { return prey; };

   void Print(ofstream& outfile) const;

 protected:

   FormulaMatrix amount;

   LengthPrey* prey;

   PopInfoMatrix tmpPopulation;

 };


 #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

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

LengthPrey
This is the class used to model a simple length based prey.
Definition: lengthprey.h:11

OtherFood
This is the class used to model the available prey that is not modelled dynamically.
Definition: otherfood.h:16

OtherFood::Reset
virtual void Reset(const TimeClass *const TimeInfo)
This function will reset the model population.
Definition: otherfood.cc:94

OtherFood::adjustEat
virtual void adjustEat(int area, const TimeClass *const TimeInfo)
This function will adjust the modelled consumption for an area in the model.
Definition: otherfood.h:50

OtherFood::checkEat
virtual void checkEat(int area, const TimeClass *const TimeInfo)
This function will check the modelled consumption for an area in the model.
Definition: otherfood.cc:68

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

OtherFood::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: otherfood.h:93

OtherFood::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: otherfood.h:87

OtherFood::Migrate
virtual void Migrate(const TimeClass *const TimeInfo)
This function will implement the migration of the model population for the model.
Definition: otherfood.h:122

OtherFood::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: otherfood.h:99

OtherFood::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: otherfood.h:63

OtherFood::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: otherfood.h:69

OtherFood::isOtherFoodStepArea
int isOtherFoodStepArea(int area, const TimeClass *const TimeInfo)
This will check if there is otherfood available on the current timestep.
Definition: otherfood.cc:78

OtherFood::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: otherfood.h:75

OtherFood::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: otherfood.h:105

OtherFood::amount
FormulaMatrix amount
This is the amount of the otherfood that is available for the predators to consume.
Definition: otherfood.h:149

OtherFood::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: otherfood.h:111

OtherFood::prey
LengthPrey * prey
This is the otherfood, as a prey in the current model.
Definition: otherfood.h:153

OtherFood::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: otherfood.h:81

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

OtherFood::getPrey
LengthPrey * getPrey() const
This will return the otherfood, as a prey type, for use in other functions.
Definition: otherfood.h:139

OtherFood::tmpPopulation
PopInfoMatrix tmpPopulation
This is the PopInfoMatrix used to temporarily store the amount of food available.
Definition: otherfood.h:157

OtherFood::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: otherfood.h:38

OtherFood::Print
void Print(ofstream &outfile) const
This function will print the model population.
Definition: otherfood.cc:88

OtherFood::~OtherFood
virtual ~OtherFood()
This is the default OtherFood destructor.
Definition: otherfood.cc:64

OtherFood::OtherFood
OtherFood(CommentStream &infile, const char *givenname, const AreaClass *const Area, const TimeClass *const TimeInfo, Keeper *const keeper)
This is the OtherFood constructor.
Definition: otherfood.cc:12

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

formulamatrix.h

lengthprey.h