This is the class used to store information about the areas used for the current model.
Definition: areatime.h:18
AreaClass(CommentStream &infile, Keeper *const keeper, const TimeClass *const TimeInfo)
This is the AreaClass constructor.
Definition: area.cc:7
FormulaVector size
This is the FormulaVector of the size of the areas in the current model.
Definition: areatime.h:74
~AreaClass()
This is the default AreaClass destructor.
Definition: areatime.h:30
int getModelArea(int area) const
This will return the external identifier of an area.
Definition: areatime.h:60
double getTemperature(int area, int time) const
This will return the temperature of an area on a timestep.
Definition: areatime.h:48
const IntVector & getAllModelAreas() const
This will return the the IntVector of all the areas in the current model.
Definition: areatime.h:65
int numAreas() const
This will return the number of areas for the current model.
Definition: areatime.h:35
int getInnerArea(int area) const
This will return the internal identifier of an area.
Definition: area.cc:97
DoubleMatrix temperature
This is the DoubleMatrix of the temperature, for each timestep, of the areas in the current model.
Definition: areatime.h:78
IntVector modelAreas
This is the IntVector of the areas in the current model.
Definition: areatime.h:65
double getSize(int area) const
This will return the size of an area.
Definition: areatime.h:41
This class implements a dynamic vector of DoubleVector values.
Definition: doublematrix.h:11
This class implements a dynamic vector of double values.
Definition: doublevector.h:11
This class implements a dynamic vector of int values.
Definition: intvector.h:11
int Size() const
This will return the size of the vector.
Definition: intvector.h:49
This is the class used to store information about the variables that are used in model simulation.
Definition: keeper.h:17
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87
int getSubStep() const
This will return the current substep of the model simulation.
Definition: areatime.h:103
void IncrementSubstep()
This is the function that increases the substep within the current timestep.
Definition: areatime.h:191
void Reset()
This is the function that resets the timestep to the beginning of the model simulation.
Definition: time.cc:93
double getMaxRatioConsumed() const
This function will return the maximum ratio of any stock that can be consumed on the current substep.
Definition: time.cc:101
int calcSteps(int year, int step) const
This will return the total number of timesteps that have taken place in the simulation from the start...
Definition: areatime.h:155
DoubleVector timesteps
This is the DoubleVector of timesteps in each year.
Definition: areatime.h:244
int getLastStep() const
This will return the last step of the model simulation.
Definition: areatime.h:133
int numtimesteps
This is the number of steps in a year in the model simulation.
Definition: areatime.h:230
int getLastYear() const
This will return the last year of the model simulation.
Definition: areatime.h:138
int didStepSizeChange() const
This is the function that will check to see if the length of the current timestep has changed from th...
Definition: time.cc:87
int getFirstYear() const
This will return the first year of the model simulation.
Definition: areatime.h:128
int currentstep
This is the current step of the model simulation.
Definition: areatime.h:206
double maxratioconsumed
This is the maximum ratio of stock that can be consumed in any given timestep.
Definition: areatime.h:240
int isWithinPeriod(int year, int step) const
This is the function that will check to see if specified year and step are within the time period cov...
Definition: time.cc:75
int lastyear
This is the last year in the model simulation.
Definition: areatime.h:222
int firstyear
This is the first year in the model simulation.
Definition: areatime.h:214
int getTime() const
This will return the total number of timesteps that have taken place in the simulation from the start...
Definition: areatime.h:118
int getYear() const
This will return the current year of the model simulation.
Definition: areatime.h:113
TimeClass(CommentStream &infile, double maxratio)
This is the TimeClass constructor.
Definition: time.cc:8
int currentyear
This is the current year of the model simulation.
Definition: areatime.h:210
int getFirstStep() const
This will return the first step of the model simulation.
Definition: areatime.h:123
int numSubSteps() const
This will return the number of substeps in the current timestep of the model simulation.
Definition: areatime.h:187
double getTimeStepSize() const
This will return the length of the current step of the model simulation as a proportion of the whole ...
Definition: areatime.h:143
int getStep() const
This will return the current step of the model simulation.
Definition: areatime.h:108
double lengthofyear
This is the length of a year in the model simulation (should be 12)
Definition: areatime.h:235
int laststep
This is the last step in the model simulation.
Definition: areatime.h:226
~TimeClass()
This is the TimeClass destructor.
Definition: areatime.h:98
IntVector numsubsteps
This is the IntVector of substeps in each step.
Definition: areatime.h:248
int currentsubstep
This is the current substep of the model simulation.
Definition: areatime.h:252
void IncrementTime()
This is the function that increases the timestep for the model simulation.
Definition: time.cc:57
int numSteps() const
This will return the number of steps in each year of the model simulation.
Definition: areatime.h:167
double getTimeStepLength() const
This will return the length of the current step of the model simulation.
Definition: areatime.h:148
int numTotalSteps() const
This will return the total number of timesteps in the model simulation.
Definition: areatime.h:161
int firststep
This is the first step in the model simulation.
Definition: areatime.h:218