Nextsim::ParametricGrid Class Reference

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

#include <ParametricGrid.hpp>

Inheritance diagram for Nextsim::ParametricGrid:

Collaboration diagram for Nextsim::ParametricGrid:

Classes
class	IParaGridIO

Public Types
typedef ModelArray::MultiDim	GridDimensions

Public Member Functions
ModelState	getModelState (const std::string &filePath) override
	Dumps the data to a file path.
void	dumpModelState (const ModelState &state, const ModelMetadata &metadata, const std::string &filePath, bool isRestart=false) const override
	Dumps the data to a file path.
const std::string &	structureType () const override
	Returns the structure name that this class will process.
int	nIceLayers () const override
	The number of ice layers in this data structure.
void	setIO (IParaGridIO *p)
Public Member Functions inherited from Nextsim::IStructure
bool	structureTypeCheck (const std::string &str) const
	Checks if the passed string matches (ignoring case) the name of the structure that this class constructs.

Static Public Attributes
static const std::string	structureName = "parametric_rectangular"

Additional Inherited Members
Static Public Member Functions inherited from Nextsim::IStructure
static const std::string	metadataNodeName ()
	Returns the name of the metadata node.
static const std::string	dataNodeName ()
	Returns the name of the data node.
static const std::string	structureNodeName ()
	The name of the group holding the definitive structure type.
static const std::string	typeNodeName ()
	The name of the node holding the name of the structure type processed by this class.

Detailed Description

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

Definition at line 22 of file ParametricGrid.hpp.

Member Typedef Documentation

GridDimensions

ModelArray::MultiDim Nextsim::ParametricGrid::GridDimensions

Definition at line 24 of file ParametricGrid.hpp.

Constructor & Destructor Documentation

ParametricGrid()

Nextsim::ParametricGrid::ParametricGrid ( )

inline

Definition at line 25 of file ParametricGrid.hpp.

~ParametricGrid()

virtual Nextsim::ParametricGrid::~ParametricGrid ( )

inlinevirtual

Definition at line 29 of file ParametricGrid.hpp.

Member Function Documentation

dumpModelState()

void Nextsim::ParametricGrid::dumpModelState ( const ModelState & state, const ModelMetadata & metadata, const std::string & filePath, bool isRestart = false ) const

inlineoverridevirtual

Dumps the data to a file path.

Parameters

filePath

The path to attempt writing the data to.

Dumps the given ModelState to the given file path.

Parameters

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

Implements Nextsim::IStructure.

Definition at line 42 of file ParametricGrid.hpp.

Here is the caller graph for this function:

getModelState()

ModelState Nextsim::ParametricGrid::getModelState ( const std::string & filePath )

inlineoverridevirtual

Dumps the data to a file path.

Parameters

filePath

The path to attempt writing the data to.

Returns the ModelState stored in the file

Implements Nextsim::IStructure.

Definition at line 37 of file ParametricGrid.hpp.

Here is the caller graph for this function:

nIceLayers()

int Nextsim::ParametricGrid::nIceLayers ( ) const

inlineoverridevirtual

The number of ice layers in this data structure.

Implements Nextsim::IStructure.

Definition at line 55 of file ParametricGrid.hpp.

setIO()

void Nextsim::ParametricGrid::setIO ( IParaGridIO * p )

inline

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

Parameters

p	Pointer to the instance to use.

Definition at line 90 of file ParametricGrid.hpp.

Here is the caller graph for this function:

structureType()

const std::string & Nextsim::ParametricGrid::structureType ( ) const

inlineoverridevirtual

Returns the structure name that this class will process.

Reimplemented from Nextsim::IStructure.

Definition at line 53 of file ParametricGrid.hpp.

Member Data Documentation

structureName

const std::string Nextsim::ParametricGrid::structureName = "parametric_rectangular"

static

Definition at line 92 of file ParametricGrid.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/core/src/modules/include/ParametricGrid.hpp
• /github/workspace/core/src/modules/ParametricGrid.cpp