MeshFields.hpp File Reference

#include "codingUtilities/traits.hpp"
#include "dataRepository/RestartFlags.hpp"
#include "common/DataTypes.hpp"

Go to the source code of this file.

Classes
struct	geos::fields::StructuredIndex
	Trait struct for StructuredIndex data. More...
struct	geos::fields::ghostRank
	Trait struct for ghostRank data. More...
struct	geos::fields::elementVolume
	Trait struct for elementVolume data. More...
struct	geos::fields::elementAperture
	Trait struct for elementAperture data. More...
struct	geos::fields::elementArea
	Trait struct for elementArea data. More...
struct	geos::fields::parentIndex
	Trait struct for parentIndex data. More...
struct	geos::fields::parentEdgeIndex
	Trait struct for parentEdgeIndex data. More...
struct	geos::fields::childIndex
	Trait struct for childIndex data. More...
struct	geos::fields::ruptureTime
	Trait struct for ruptureTime data. More...
struct	geos::fields::normalVector
	Trait struct for normalVector data. More...
struct	geos::fields::tangentVector1
	Trait struct for tangentVector1 data. More...
struct	geos::fields::tangentVector2
	Trait struct for tangentVector2 data. More...

Namespaces
	geos
	geos::fields

Macros
#define	DECLARE_FIELD(NAME, KEY, TYPE, DEFAULT, PLOTLEVEL, RESTARTFLAG, DESCRIPTION)
	Generates a traits struct. More...

Macro Definition Documentation

DECLARE_FIELD

#define DECLARE_FIELD	(		NAME,
			KEY,
			TYPE,
			DEFAULT,
			PLOTLEVEL,
			RESTARTFLAG,
			DESCRIPTION
	)

Value:

 \ \
  struct NAME \
  { \ \
    static constexpr char const * key() \
    { return KEY; } \ \
    using type = TYPE; \ \
    using dataType = ::geos::fields::internal::typeHelper_t< TYPE >; \ \
    static constexpr dataType defaultValue() \
    { return DEFAULT; } \ \
    static constexpr dataRepository::PlotLevel plotLevel = dataRepository::PlotLevel::PLOTLEVEL; \ \
    static constexpr dataRepository::RestartFlags restartFlag = dataRepository::RestartFlags::RESTARTFLAG; \ \
    static constexpr char const * description = DESCRIPTION; \
  }

Generates a traits struct.

Parameters

NAME	Name of the traits struct.
KEY	The string literal that will be used as the key to register and lookup the data in the repository.
TYPE	The type of data that will be registered.
DEFAULT	The default value for the data.
PLOTLEVEL	The default plot level for the wrapper that will contain the data.
RESTARTFLAG	The default restart flag for the wrapper that contains the data.
DESCRIPTION	A string literal that contains a description of the data for use in sphinx documentation.

Definition at line 39 of file MeshFields.hpp.