Class IDiagnosticOutput

• Defined in File IDiagnosticOutput.hpp

Inheritance Relationships

Base Type

• public Nextsim::ModelComponent (Class ModelComponent)

Derived Types

• public Nextsim::ConfigOutput (Class ConfigOutput)

• public Nextsim::NoOutput (Class NoOutput)

• public Nextsim::SimpleOutput (Class SimpleOutput)

Class Documentation

class IDiagnosticOutput : public Nextsim::ModelComponent

Subclassed by Nextsim::ConfigOutput, Nextsim::NoOutput, Nextsim::SimpleOutput

Public Functions

inline IDiagnosticOutput()

virtual ~IDiagnosticOutput() = default

virtual void setFilenamePrefix(const std::string &filePrefix) = 0

Sets the output file name.

Parameters:

fileName – The file name to be set.

virtual void outputState(const ModelState &state) = 0

Outputs the passed ModelState.

Parameters:

state – The model state to be written out.

inline virtual void setData(const ModelState::DataMap &state)

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

Parameters:

state – The ModelState containing the data to be set.

inline virtual void setModelStart(const TimePoint &ModelStart)

modelStart the TimePoint of the start of the model run.

Sets the model start time, which implementations may use to time output events.

Protected Attributes

const std::map<std::string, std::string> externalNames