geos::fields::StructuredIndex Struct Reference

Trait struct for StructuredIndex data. More...

#include <MeshFields.hpp>

Public Types
using	type = array2d< integer >
using	dataType = ::geos::fields::internal::typeHelper_t< array2d< integer > >

Static Public Member Functions
static constexpr char const *	key ()
static constexpr dataType	defaultValue ()

Static Public Attributes
static constexpr dataRepository::PlotLevel	plotLevel = dataRepository::PlotLevel:: NOPLOT
static constexpr dataRepository::RestartFlags	restartFlag = dataRepository::RestartFlags:: NO_WRITE
static constexpr char const *	description = "Structured cell index provided by mesh generator"

Detailed Description

Trait struct for StructuredIndex data.

Definition at line 100 of file MeshFields.hpp.

Member Typedef Documentation

dataType

using geos::fields::StructuredIndex::dataType = ::geos::fields::internal::typeHelper_t< array2d< integer > >

The template type T for registration of a container<T>.

Definition at line 100 of file MeshFields.hpp.

type

using geos::fields::StructuredIndex::type = array2d< integer >

The actual type to be registered.

Definition at line 100 of file MeshFields.hpp.

Member Function Documentation

defaultValue()

static constexpr dataType geos::fields::StructuredIndex::defaultValue ( )

inlinestaticconstexpr

Returns

The default data value for StructuredIndex .

Definition at line 100 of file MeshFields.hpp.

key()

static constexpr char const* geos::fields::StructuredIndex::key ( )

inlinestaticconstexpr

Returns

The key for registration with the data repository.

Definition at line 100 of file MeshFields.hpp.

Member Data Documentation

description

constexpr char const* geos::fields::StructuredIndex::description = "Structured cell index provided by mesh generator"

staticconstexpr

Description of the StructuredIndex data for use in sphinx documentation

Definition at line 100 of file MeshFields.hpp.

plotLevel

constexpr dataRepository::PlotLevel geos::fields::StructuredIndex::plotLevel = dataRepository::PlotLevel:: NOPLOT

staticconstexpr

The default dataRepository::PlotLevel for StructuredIndex .

Definition at line 100 of file MeshFields.hpp.

restartFlag

constexpr dataRepository::RestartFlags geos::fields::StructuredIndex::restartFlag = dataRepository::RestartFlags:: NO_WRITE

staticconstexpr

The default dataRepository::RestartFlags for StructuredIndex .

Definition at line 100 of file MeshFields.hpp.

---

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

• coreComponents/mesh/MeshFields.hpp