Nextsim::IStructure Class Reference

Interface class for the model structure. More...

#include <IStructure.hpp>

Inheritance diagram for Nextsim::IStructure:

Collaboration diagram for Nextsim::IStructure:

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

Static Public Member Functions
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

Interface class for the model structure.

Derived classes will hold the structured data of the model. Member functions also provide · input and output of restart data and data fields for output, either natively or on a reshaped grid · iteration over the element data, using a given function. This should allow derived classes to implement both Eulerian grids and Lagrangian meshes.

Definition at line 30 of file IStructure.hpp.

Constructor & Destructor Documentation

IStructure()

Nextsim::IStructure::IStructure ( )

inline

Definition at line 32 of file IStructure.hpp.

Member Function Documentation

dataNodeName()

static const std::string Nextsim::IStructure::dataNodeName ( )

inlinestatic

Returns the name of the data node.

Definition at line 84 of file IStructure.hpp.

Here is the caller graph for this function:

dumpModelState()

virtual void Nextsim::IStructure::dumpModelState ( const ModelState & state, const ModelMetadata & metadata, const std::string & filePath, bool isRestart ) const

pure virtual

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.

Implemented in Nextsim::DevGrid, Nextsim::ParametricGrid, and Nextsim::RectangularGrid.

getModelState()

virtual ModelState Nextsim::IStructure::getModelState ( const std::string & filePath )

pure virtual

Dumps the data to a file path.

Parameters

filePath

The path to attempt writing the data to.

Returns the ModelState stored in the file

Implemented in Nextsim::DevGrid, Nextsim::ParametricGrid, and Nextsim::RectangularGrid.

metadataNodeName()

static const std::string Nextsim::IStructure::metadataNodeName ( )

inlinestatic

Returns the name of the metadata node.

Definition at line 82 of file IStructure.hpp.

Here is the caller graph for this function:

nIceLayers()

virtual int Nextsim::IStructure::nIceLayers ( ) const

pure virtual

The number of ice layers in this data structure.

Implemented in Nextsim::DevGrid, Nextsim::ParametricGrid, and Nextsim::RectangularGrid.

structureNodeName()

static const std::string Nextsim::IStructure::structureNodeName ( )

inlinestatic

The name of the group holding the definitive structure type.

Definition at line 86 of file IStructure.hpp.

Here is the caller graph for this function:

structureType()

virtual const std::string & Nextsim::IStructure::structureType ( ) const

inlinevirtual

Returns the structure name that this class will process.

Reimplemented in Nextsim::DevGrid, Nextsim::ParametricGrid, and Nextsim::RectangularGrid.

Definition at line 48 of file IStructure.hpp.

Here is the caller graph for this function:

structureTypeCheck()

bool Nextsim::IStructure::structureTypeCheck ( const std::string & str ) const

inline

Checks if the passed string matches (ignoring case) the name of the structure that this class constructs.

Parameters

str	The string to be checked.

Definition at line 55 of file IStructure.hpp.

Here is the call graph for this function:

typeNodeName()

static const std::string Nextsim::IStructure::typeNodeName ( )

inlinestatic

The name of the node holding the name of the structure type processed by this class.

Definition at line 89 of file IStructure.hpp.

Here is the caller graph for this function:

---

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

• /github/workspace/core/src/modules/include/IStructure.hpp