Class PrognosticData

Nested Relationships

Nested Types

Inheritance Relationships

Base Types

Class Documentation

class PrognosticData : public Nextsim::CheckingModelComponent, public Nextsim::Configured<PrognosticData>

A class defining a configurable ModelComponent that stores the prognostic data values and handles their updates in the timestep, including all calls to the variables those calculations depend on.

Public Types

enum [anonymous]

Values:

enumerator CHECKFIELDS_KEY
enumerator CHECKFIELDSFAST_KEY

Public Functions

PrognosticData()
virtual ~PrognosticData() = default
virtual void configure() override

The configuration function.

inline virtual std::string getName() const override

Returns the name of the component.

virtual void setData(const ModelState::DataMap &ms) override

Set the initial data of the component from the passed ModelState.

Parameters:

state – The ModelState containing the data to be set.

virtual ModelState getStateDiagnostic() const override

Returns all data and configuration from this component.

The state returned by this function contains all available data in this component and all components that it calls.

virtual ModelState getStatePrognostic() const override

Returns the state of the ModelComponent.

Returns the state of the ModelComponent and any ModelComponents it depends on.

The state returned by this function contains all the data necessary to restart this component and all components that it calls.

void update(const TimestepTime &tsTime)

Updates the state of the prognostic data for this timestep.

Parameters:

tsInitialTime – the time at the start of the timestep

void writeRestartFile(const std::string &filePath) const

Writes a restart file to the specified file path.

Parameters:

filePath – the file path to write the restart file to.

Public Static Functions

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