gadget2/reference/lengthgroup_8h_source.html

 #ifndef lengthgroup_h

 #define lengthgroup_h


 #include "doublevector.h"


 class LengthGroupDivision {

 public:

   LengthGroupDivision(double minlength, double maxlength, double dl);

   LengthGroupDivision(const DoubleVector& vec);

   LengthGroupDivision(const LengthGroupDivision& lgrpdiv);

   ~LengthGroupDivision() {};

   double meanLength(int i) const;

   double minLength(int i) const;

   double maxLength(int i) const;

   double minLength() const { return minlen; };

   double maxLength() const { return maxlen; };

   double dl() const { return Dl; };

   int numLengthGroups() const { return size; };

   int numLengthGroup(double len) const;

   int Combine(const LengthGroupDivision* const addition);

   int Error() const { return error; }

   void printError() const;

   void Print(ofstream& outfile) const;

 protected:

   int error;

   int size;

   double Dl;

   double minlen;

   double maxlen;

   DoubleVector meanlength;

   DoubleVector minlength;

 };


 extern int checkLengthGroupStructure(const LengthGroupDivision* finer,

   const LengthGroupDivision* coarser);


 #endif

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

LengthGroupDivision
This is the class used to store information about the length groups of the modelled stock population.
Definition: lengthgroup.h:10

LengthGroupDivision::minLength
double minLength() const
This function will return the minimum length of the smallest length group.
Definition: lengthgroup.h:55

LengthGroupDivision::error
int error
This is the flag to denote whether an error has occured or not.
Definition: lengthgroup.h:100

LengthGroupDivision::printError
void printError() const
This function will print an error message about the LengthGroupDivision.
Definition: lengthgroup.cc:200

LengthGroupDivision::Print
void Print(ofstream &outfile) const
This function will print the LengthGroupDivision information.
Definition: lengthgroup.cc:191

LengthGroupDivision::meanlength
DoubleVector meanlength
This is the DoubleVector of the mean lengths for each length group.
Definition: lengthgroup.h:120

LengthGroupDivision::meanLength
double meanLength(int i) const
This function will return the mean length of a specified length group.
Definition: lengthgroup.cc:93

LengthGroupDivision::numLengthGroups
int numLengthGroups() const
This function will return the total number of the length groups.
Definition: lengthgroup.h:70

LengthGroupDivision::dl
double dl() const
This function will return the step length of the length groups.
Definition: lengthgroup.h:65

LengthGroupDivision::LengthGroupDivision
LengthGroupDivision(double minlength, double maxlength, double dl)
This is the LengthGroupDivision constructor with evenly spaced length groups.
Definition: lengthgroup.cc:6

LengthGroupDivision::Combine
int Combine(const LengthGroupDivision *const addition)
This function will combine a second LengthGroupDivision with the current LengthGroupDivision.
Definition: lengthgroup.cc:111

LengthGroupDivision::maxLength
double maxLength() const
This function will return the maximum length of the biggest length group.
Definition: lengthgroup.h:60

LengthGroupDivision::minlength
DoubleVector minlength
This is the DoubleVector of the minimum lengths for each length group.
Definition: lengthgroup.h:124

LengthGroupDivision::numLengthGroup
int numLengthGroup(double len) const
This function will return the identifier of a length group containing a specified length.
Definition: lengthgroup.cc:75

LengthGroupDivision::maxlen
double maxlen
This is the maximum length of the biggest length group.
Definition: lengthgroup.h:116

LengthGroupDivision::~LengthGroupDivision
~LengthGroupDivision()
This is the default LengthGroupDivision destructor.
Definition: lengthgroup.h:32

LengthGroupDivision::size
int size
This is the size of the length group.
Definition: lengthgroup.h:104

LengthGroupDivision::Error
int Error() const
This function will return the flag denoting whether an error has occured or not.
Definition: lengthgroup.h:86

LengthGroupDivision::Dl
double Dl
This is the step length for each length group.
Definition: lengthgroup.h:108

LengthGroupDivision::minlen
double minlen
This is the minimum length of the smallest length group.
Definition: lengthgroup.h:112

doublevector.h

checkLengthGroupStructure
int checkLengthGroupStructure(const LengthGroupDivision *finer, const LengthGroupDivision *coarser)
This is the function that will check whether one LengthGroupDivision has length groups that are finer...
Definition: lengthgroup.cc:205