Class Model

• Defined in File Model.hpp

Inheritance Relationships

Base Type

• public Nextsim::Configured< Model > (Template Class Configured)

Class Documentation

class Model : public Nextsim::Configured<Model>

A class that encapsulates the whole of the model.

Public Types

enum [anonymous]

Values:

enumerator RESTARTFILE_KEY

enumerator STARTTIME_KEY

enumerator STOPTIME_KEY

enumerator RUNLENGTH_KEY

enumerator TIMESTEP_KEY

enumerator MISSINGVALUE_KEY

enumerator RESTARTPERIOD_KEY

enumerator RESTARTOUTFILE_KEY

Public Functions

Model()

~Model()

void configureRestarts()

void configureTime()

virtual void configure() override

The configuration function.

inline ConfigMap getConfig() const

void run()

Run the model.

void writeRestartFile()

Write a restart file for the model.

void setFinalFilename(const std::string &finalFile)

Sets the filename of the restart file that would currently be written out.

Public Static Functions

static HelpMap &getHelpText(HelpMap &map, bool getAll)

static HelpMap &getHelpRecursive(HelpMap &map, bool getAll)

Public Static Attributes

static const std::string restartOptionName = "model.init_file"