Class DevStep

Inheritance Relationships

Base Type

Class Documentation

class DevStep : public Nextsim::IModelStep

A class providing a simple implementation of Iterator.

Public Functions

DevStep()
virtual ~DevStep() = default
inline virtual void writeRestartFile(const std::string &filePath) override

Writes a restart file containing the current model state to the given file location.

Parameters:

filePath – The path to the location to write the file.

inline virtual void setData(PrognosticData &pDat) override

Sets the data object that will be used within the timesteps.

Parameters:

data – The PrognosticData holding the model data.

void setRestartDetails(const Duration &restartPeriod, const std::string &fileName)

Sets the period with which restart files are created.

Parameters:

  • restartPeriod – The Duration between writing out restart files.

  • filename – The file name pattern to be used for the restart files. The string will be used as a format for the time string, based on the syntax of strftime.

virtual void init() override

Initializes the model, based on some environment stored in the implementing class.

virtual void start(const TimePoint &startTime) override

Initializes the iterant based on the start time.

Parameters:

startTime – the time at the initialization of the iterant.

virtual void iterate(const TimestepTime &dt) override

Performs one iteration a specified length

Parameters:

dt – The length of the timestep.

inline virtual void stop(const TimePoint &stopTime) override

Finalizes the iterant based on the stop time.

Parameters:

stopTime – the time at the finalization of the iterant.