Gadget
naturalm.h
Go to the documentation of this file.
1 #ifndef naturalm_h
2 #define naturalm_h
3 
4 #include "areatime.h"
5 #include "commentstream.h"
6 #include "selectfunc.h"
7 #include "livesonareas.h"
8 #include "modelvariablevector.h"
9 #include "keeper.h"
10 
19 class NaturalMortality : public HasName, public LivesOnAreas {
20 public:
31  NaturalMortality(CommentStream& infile, int minage, int numage, const char* givenname,
32  const IntVector& Areas, const TimeClass* const TimeInfo, Keeper* const keeper);
36  ~NaturalMortality();
42  const DoubleVector& getProportion(int area) const { return proportion[this->areaNum(area)]; };
47  void Reset(const TimeClass* const TimeInfo);
52  void Print(ofstream& outfile);
53 protected:
57  ModelVariableVector mortality;
61  SelectFunc* fnMortality;
65  DoubleMatrix proportion;
69  int minStockAge;
73  int readoption;
74 };
75 
76 #endif
CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40
DoubleMatrix
This class implements a dynamic vector of DoubleVector values.
Definition: doublematrix.h:11
DoubleVector
This class implements a dynamic vector of double values.
Definition: doublevector.h:11
HasName
This is the base class for any object that has a name.
Definition: hasname.h:10
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
LivesOnAreas
This is the class used to store information about the areas an object is defined on for the current m...
Definition: livesonareas.h:10
LivesOnAreas::areaNum
int areaNum(int area) const
This function will return the area associated with an internal area.
Definition: livesonareas.cc:33
ModelVariableVector
This class implements a dynamic vector of ModelVariable values.
Definition: modelvariablevector.h:10
NaturalMortality
This is the class used to calculate the affect of natural mortality on the stock.
Definition: naturalm.h:19
NaturalMortality::~NaturalMortality
~NaturalMortality()
This is the default NaturalMortality destructor.
Definition: naturalm.cc:45
NaturalMortality::NaturalMortality
NaturalMortality(CommentStream &infile, int minage, int numage, const char *givenname, const IntVector &Areas, const TimeClass *const TimeInfo, Keeper *const keeper)
This is the NaturalMortality constructor.
Definition: naturalm.cc:10
NaturalMortality::readoption
int readoption
This is the identifier of the function to be used to read the natural mortality data from file.
Definition: naturalm.h:73
NaturalMortality::Reset
void Reset(const TimeClass *const TimeInfo)
This function will reset the NaturalMortality information.
Definition: naturalm.cc:50
NaturalMortality::fnMortality
SelectFunc * fnMortality
This is the SelectFunc used to calculate of the proportion of each age group of the stock that will d...
Definition: naturalm.h:61
NaturalMortality::mortality
ModelVariableVector mortality
This is the ModelVariableVector used to store the mortality of each age group.
Definition: naturalm.h:57
NaturalMortality::minStockAge
int minStockAge
This is the minimum age of the stock, used as an index when calculating proportion.
Definition: naturalm.h:69
NaturalMortality::Print
void Print(ofstream &outfile)
This function will print the summary NaturalMortality information.
Definition: naturalm.cc:92
NaturalMortality::getProportion
const DoubleVector & getProportion(int area) const
This function will return the DoubleVector of the proportion of each age group that will survive on t...
Definition: naturalm.h:42
NaturalMortality::proportion
DoubleMatrix proportion
This is the DoubleMatrix used to store the proportion of each age group that will survive (ie....
Definition: naturalm.h:65
SelectFunc
This is the base class used to calculate the selection level as a function of length.
Definition: selectfunc.h:14
TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87
Generated by doxygen 1.9.1