Class RectangularGrid¶

Defined in File RectangularGrid.hpp

Nested Relationships¶

Nested Types¶

Inheritance Relationships¶

Base Type¶

public Nextsim::IStructure (Class IStructure)

Class Documentation¶

class RectangularGrid : public Nextsim::IStructure ¶

Public Functions

inline RectangularGrid()¶

inline RectangularGrid(const GridDimensions &dims)¶

inline virtual ~RectangularGrid()¶

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 setDimensions(const GridDimensions &dims)¶

inline void setIO(IRectGridIO *p)¶: Sets the pointer to the class that will perform the IO. Should be an instance of IRectGridIO.

Public Static Attributes

static const std::string structureName = "simple_rectangular"¶

struct GridDimensions¶

Public Members

int nx¶

int ny¶

class IRectGridIO¶

Subclassed by Nextsim::RectGridIO

Public Functions

inline IRectGridIO(RectangularGrid &grid)¶

virtual ~IRectGridIO() = default¶

virtual ModelState getModelState(const std::string &filePath) = 0¶

virtual void dumpModelState(const ModelState &state, const std::string &filePath, bool isRestart) const = 0¶

Dumps the given ModelState to the given file path.

Parameters:

state – The ModelState data
filePath – The path to attempt to write the data to.

Protected Functions

IRectGridIO() = default¶