geos::fields::childIndex Struct Reference

Trait struct for childIndex data. More...

#include <MeshFields.hpp>

Public Types
using	type = array1d< localIndex >
using	dataType = internal::typeHelper_t< array1d< localIndex > >

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

Static Public Attributes
static constexpr dataRepository::PlotLevel	plotLevel = dataRepository::PlotLevel:: LEVEL_2
static constexpr dataRepository::RestartFlags	restartFlag = dataRepository::RestartFlags:: WRITE_AND_READ
static constexpr char const *	description = "Index of child within the mesh object it is registered on."

Detailed Description

Trait struct for childIndex data.

Definition at line 148 of file MeshFields.hpp.

Member Typedef Documentation

dataType

using geos::fields::childIndex::dataType = internal::typeHelper_t< array1d< localIndex > >

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

Definition at line 148 of file MeshFields.hpp.

type

using geos::fields::childIndex::type = array1d< localIndex >

The actual type to be registered.

Definition at line 148 of file MeshFields.hpp.

Member Function Documentation

defaultValue()

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

inlinestaticconstexpr

Returns

The default data value for childIndex .

Definition at line 148 of file MeshFields.hpp.

key()

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

inlinestaticconstexpr

Returns

The key for registration with the data repository.

Definition at line 148 of file MeshFields.hpp.

Member Data Documentation

description

constexpr char const* geos::fields::childIndex::description = "Index of child within the mesh object it is registered on."

staticconstexpr

Description of the childIndex data for use in sphinx documentation

Definition at line 148 of file MeshFields.hpp.

plotLevel

constexpr dataRepository::PlotLevel geos::fields::childIndex::plotLevel = dataRepository::PlotLevel:: LEVEL_2

staticconstexpr

The default dataRepository::PlotLevel for childIndex .

Definition at line 148 of file MeshFields.hpp.

restartFlag

constexpr dataRepository::RestartFlags geos::fields::childIndex::restartFlag = dataRepository::RestartFlags:: WRITE_AND_READ

staticconstexpr

The default dataRepository::RestartFlags for childIndex .

Definition at line 148 of file MeshFields.hpp.

---

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

• coreComponents/mesh/MeshFields.hpp