Class ParametricGrid

Nested Relationships

Nested Types

Inheritance Relationships

Base Type

Class Documentation

class ParametricGrid : public Nextsim::IStructure

A class to hold the grid data for parameterised rectangular grids.

Public Types

typedef ModelArray::MultiDim GridDimensions

Public Functions

inline ParametricGrid()
inline virtual ~ParametricGrid()
inline virtual ModelState getModelState(const std::string &filePath) override

Returns the ModelState stored in the file.

inline virtual void dumpModelState(const ModelState &state, const std::string &filePath, bool isRestart = false) const override

Dumps the data to a file path.

Dumps the given ModelState to the given file path.

Parameters:

  • filePath – The path to attempt writing the data to.

  • state – The ModelState data

  • filePath – The path to attempt to write the data to.

inline virtual const std::string &structureType() const override

Returns the structure name that this class will process.

inline void setIO(IParaGridIO *p)

Sets the IParaGridIO instance to use to drive the input and output.

Parameters:

p – Pointer to the instance to use.

Public Static Attributes

static const std::string structureName = "parametric_rectangular"
class IParaGridIO

Subclassed by Nextsim::ParaGridIO

Public Functions

inline IParaGridIO(ParametricGrid &grid)
virtual ~IParaGridIO() = default
virtual ModelState getModelState(const std::string &filePath) = 0
virtual void dumpModelState(const ModelState &state, const std::string &filePath) = 0
virtual ModelState readForcingTime(const std::set<std::string> &forcings, const TimePoint &time, const std::string &filePath) = 0
virtual void writeDiagnosticTime(const ModelState &state, const std::string &filePath) = 0

Protected Functions

IParaGridIO() = delete