gadget2/reference/lengthpredator_8h_source.html

 #ifndef lengthpredator_h

 #define lengthpredator_h


 #include "poppredator.h"


 class LengthPredator : public PopPredator {

 public:

   LengthPredator(const char* givenname, const IntVector& Areas,

          const TimeClass* const TimeInfo,Keeper* const keeper,Formula multscaler);

   virtual ~LengthPredator() {};

   virtual void Sum(const PopInfoVector& NumberInArea, int area);

   double getMultScaler() const { return multi; };

   virtual void setTimeMultiplier(const TimeClass* const TimeInfo, int quotastep,double value);  //

   virtual void Reset(const TimeClass* const TimeInfo);

 protected:

   Formula multi;

   DoubleVector timeMultiplier; //To be set by the quota class

 };


 #endif

DoubleVector
This class implements a dynamic vector of double values.
Definition: doublevector.h:11

Formula
This is the class used to calculate the value of the variables used in the model simulation.
Definition: formula.h:18

IntVector
This class implements a dynamic vector of int values.
Definition: intvector.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

LengthPredator::LengthPredator
LengthPredator(const char *givenname, const IntVector &Areas, const TimeClass *const TimeInfo, Keeper *const keeper, Formula multscaler)
This is the LengthPredator constructor.
Definition: lengthpredator.cc:6

LengthPredator::getMultScaler
double getMultScaler() const
This will return the multiplicative value used scale the catch.
Definition: lengthpredator.h:35

LengthPredator::multi
Formula multi
This is the multiplicative constant that can be used to scale the biomass consumed.
Definition: lengthpredator.h:46

LengthPredator::setTimeMultiplier
virtual void setTimeMultiplier(const TimeClass *const TimeInfo, int quotastep, double value)
This is a multiplier set in lengthpredator.
Definition: lengthpredator.cc:27

LengthPredator::Sum
virtual void Sum(const PopInfoVector &NumberInArea, int area)
This will calculate the amount of prey that is consumed by the predator.
Definition: lengthpredator.cc:16

LengthPredator::Reset
virtual void Reset(const TimeClass *const TimeInfo)
This function will reset the predation information.
Definition: lengthpredator.cc:20

LengthPredator::~LengthPredator
virtual ~LengthPredator()
This is the default LengthPredator destructor.
Definition: lengthpredator.h:24

LengthPredator::timeMultiplier
DoubleVector timeMultiplier
Definition: lengthpredator.h:47

PopInfoVector
This class implements a dynamic vector of PopInfo values.
Definition: popinfovector.h:11

PopPredator
This is the class used to model the predation of a population.
Definition: poppredator.h:16

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

poppredator.h