gadget2/reference/initialcond_8h_source.html

 #ifndef initialcond_h

 #define initialcond_h


 #include "formulamatrixptrvector.h"

 #include "areatime.h"

 #include "conversionindex.h"

 #include "commentstream.h"

 #include "agebandmatrixptrvector.h"

 #include "livesonareas.h"

 #include "keeper.h"


 class InitialCond : public HasName, protected LivesOnAreas {

 public:

   InitialCond(CommentStream& infile, const IntVector& areas, Keeper* const keeper,

      const char* refWeightFile, const char* givenname, const AreaClass* const Area, double DL);

   ~InitialCond();

   void Initialise(AgeBandMatrixPtrVector& Alkeys);

   void setCI(const LengthGroupDivision* const GivenLDiv);

   void Print(ofstream& outfile) const;

 protected:

   void readNormalConditionData(CommentStream& infile, Keeper* const keeper,

      int numage, int minage, const AreaClass* const Area);

   void readNormalParameterData(CommentStream& infile, Keeper* const keeper,

      int numage, int minage, const AreaClass* const Area);

   void readNumberData(CommentStream& infile, Keeper* const keeper,

      int numage, int minage, const AreaClass* const Area);

   LengthGroupDivision* LgrpDiv;

   ConversionIndex* CI;

   AgeBandMatrixPtrVector initialPop;

   FormulaMatrixPtrVector initialNumber;

   FormulaMatrix areaFactor;

   FormulaMatrix ageFactor;

   FormulaMatrix relCond;

   FormulaMatrix meanLength;

   FormulaMatrix sdevLength;

   FormulaMatrix alpha;

   FormulaMatrix beta;

   Formula sdevMult;

   DoubleVector refWeight;

   int readoption;

 };


 #endif

agebandmatrixptrvector.h

areatime.h

AgeBandMatrixPtrVector
This class implements a dynamic vector of AgeBandMatrix values.
Definition: agebandmatrixptrvector.h:12

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

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

ConversionIndex
This is the class used to convert information from one LengthGroupDivision length structure to a seco...
Definition: conversionindex.h:12

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

FormulaMatrixPtrVector
This class implements a dynamic vector of FormulaMatrix values.
Definition: formulamatrixptrvector.h:10

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

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

HasName
This is the base class for any object that has a name.
Definition: hasname.h:10

InitialCond
This is the class used to calculate the initial population of a stock.
Definition: initialcond.h:24

InitialCond::beta
FormulaMatrix beta
This is the FormulaMatrix of the beta parameter used when calculating the length weight relationship.
Definition: initialcond.h:131

InitialCond::initialNumber
FormulaMatrixPtrVector initialNumber
This is the FormulaMatrixPtrVector that contains the number (from the input file) of the initial popu...
Definition: initialcond.h:103

InitialCond::readNormalParameterData
void readNormalParameterData(CommentStream &infile, Keeper *const keeper, int numage, int minage, const AreaClass *const Area)
This is the function used to read the normal distribution for the initial condtion data.
Definition: initialcond.cc:92

InitialCond::initialPop
AgeBandMatrixPtrVector initialPop
This is the AgeBandMatrixPtrVector used to store the initial population.
Definition: initialcond.h:99

InitialCond::refWeight
DoubleVector refWeight
This is the DoubleVector of the reference weight values.
Definition: initialcond.h:139

InitialCond::sdevMult
Formula sdevMult
This is the optional factor used when calculating the standard deviation of the length.
Definition: initialcond.h:135

InitialCond::relCond
FormulaMatrix relCond
This is the FormulaMatrix of the condition factor used to calculate the weight of the initial populat...
Definition: initialcond.h:115

InitialCond::readNormalConditionData
void readNormalConditionData(CommentStream &infile, Keeper *const keeper, int numage, int minage, const AreaClass *const Area)
This is the function used to read the normal distribution and condition factor for the initial condti...
Definition: initialcond.cc:9

InitialCond::sdevLength
FormulaMatrix sdevLength
This is the FormulaMatrix of the standard deviation of the length at age used to calculate the initia...
Definition: initialcond.h:123

InitialCond::readNumberData
void readNumberData(CommentStream &infile, Keeper *const keeper, int numage, int minage, const AreaClass *const Area)
This is the function used to read the numbers of the initial population.
Definition: initialcond.cc:178

InitialCond::readoption
int readoption
This is the identifier of the function to be used to read the initial population data from file.
Definition: initialcond.h:143

InitialCond::Initialise
void Initialise(AgeBandMatrixPtrVector &Alkeys)
This function will set the initial population of the stock to that specified in the initial condition...
Definition: initialcond.cc:462

InitialCond::CI
ConversionIndex * CI
This is the ConversionIndex used to convert from the initial population LengthGroupDivision to the st...
Definition: initialcond.h:95

InitialCond::alpha
FormulaMatrix alpha
This is the FormulaMatrix of the alpha parameter used when calculating the length weight relationship...
Definition: initialcond.h:127

InitialCond::setCI
void setCI(const LengthGroupDivision *const GivenLDiv)
This will set the ConversionIndex required for to calculate the initial conditions.
Definition: initialcond.cc:420

InitialCond::~InitialCond
~InitialCond()
This is the default InitialCond destructor.
Definition: initialcond.cc:412

InitialCond::InitialCond
InitialCond(CommentStream &infile, const IntVector &areas, Keeper *const keeper, const char *refWeightFile, const char *givenname, const AreaClass *const Area, double DL)
This is the InitialCond constructor.
Definition: initialcond.cc:277

InitialCond::meanLength
FormulaMatrix meanLength
This is the FormulaMatrix of the mean length at age used to calculate the initial population.
Definition: initialcond.h:119

InitialCond::LgrpDiv
LengthGroupDivision * LgrpDiv
This is the LengthGroupDivision of the initial population of the stock.
Definition: initialcond.h:91

InitialCond::ageFactor
FormulaMatrix ageFactor
This is the FormulaMatrix of the age factor used to calculate the initial population.
Definition: initialcond.h:111

InitialCond::areaFactor
FormulaMatrix areaFactor
This is the FormulaMatrix of the area factor used to calculate the initial population.
Definition: initialcond.h:107

InitialCond::Print
void Print(ofstream &outfile) const
This function will print the initial population.
Definition: initialcond.cc:433

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

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

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::areas
IntVector areas
This is the IntVector of internal areas that the object is defined on.
Definition: livesonareas.h:51

commentstream.h

conversionindex.h

formulamatrixptrvector.h

keeper.h

livesonareas.h