CepsEnums.hpp File Reference

#include "common/core/CepsTypes.hpp"

Go to the source code of this file.

Namespaces
	ceps
	A namespace for all utility methods.

Macros
#define	CEPS_DECL_ENUM_OPERATORS(ENUM)

Enumerations
enum class	CepsCompactSupportFlag : CepsEnum {   Const , C4 , C5 , CInf ,   SRectangle }
	Compact Support type enum. More...
enum class	CepsLocationFlag : CepsEnum { ZeroD = 0 , Point = 1 , Cell = 2 }
	DataLocation: an enum that will be used by various elements of the code (pde, readers, etc) More...
enum class	CepsGhostFlag : CepsEnum { Owned = 0 , Halo = 1 }
	PartitionLocation: an enum that will be used by various elements of the code (pde, readers, etc) More...
enum class	CepsCellType : CepsEnum { Simplex = 1 , Quad = 100 }
	Enum for different shapes of cells. More...
enum class	CepsFunctionFlag : CepsEnum {   None = 1 << 1 , Time = 1 << 2 , Space = 1 << 3 , Solution = 1 << 4 ,   Attribute = 1 << 5 , DofIndex = 1 << 6 , CellIndex = 1 << 7 , NodeIndex = 1 << 8 ,   UnknownIndex = 1 << 9 }
	Enum for CepsStandardArgs functions. More...
enum class	CepsBoundaryConditionFlag : CepsEnum { Dirichlet , Neumann , Robin }
	Enumeration for boundary condition type. More...
enum class	CepsSourceTermFlag : CepsEnum { Default = 1 << 1 , Stimulation = 1 << 2 , Laplace = 1 << 3 }
	Source terms flags. More...
enum class	CepsAssemblingFlag : CepsEnum { TimeDerivative , SpatialOperator }
	Source terms flags. More...
enum class	CepsOutputFormat : CepsEnum {   VTKLegacy = (1 << 1) , VTU = (1 << 2) , Music = (1 << 3) | VTKLegacy , ParaviewSeries = (1 << 4) | VTU ,   VTKCeps = (1 << 5) , Medit = (1 << 6) }
	Style of output files. More...

Functions
template<typename _Enum >
constexpr auto	ceps::toIntegral (_Enum e) -> typename std::underlying_type< _Enum >::type
	Converts an enum type variable to an integer. More...

Variables
constexpr CepsUInt	CepsCompactSupportFlagSize = 4
	Size of enum CepsCompactSupportFlags. More...
constexpr CepsUInt	CepsLocationFlagSize = 3
	Size of enum CepsLocationFlag. More...
constexpr CepsUInt	CepsGhostFlagSize = 2
	Size of enum CepsGhostFlag. More...
constexpr CepsUInt	CepsCellTypeSize = 200
	Size of enum CepsCellType. More...
constexpr CepsUInt	CepsFunctionFlagSize = 1 << 9
	Number of function flags. More...

Detailed Description

Definitions of some enums + tools to handle flags

Definition in file CepsEnums.hpp.

Macro Definition Documentation

CEPS_DECL_ENUM_OPERATORS

#define CEPS_DECL_ENUM_OPERATORS

(

ENUM

)

Definition at line 48 of file CepsEnums.hpp.

Enumeration Type Documentation

CepsAssemblingFlag

enum CepsAssemblingFlag : CepsEnum

strong

Source terms flags.

Enumerator
TimeDerivative	Compute matrix of time derivatives.
SpatialOperator	Compute matrix of spatial operators.

Definition at line 171 of file CepsEnums.hpp.

CepsBoundaryConditionFlag

enum CepsBoundaryConditionFlag : CepsEnum

strong

Enumeration for boundary condition type.

Enumerator
Dirichlet	Dirichlet BC.
Neumann	Neumann BC.
Robin	Robin BC.

Definition at line 154 of file CepsEnums.hpp.

CepsCellType

enum CepsCellType : CepsEnum

strong

Enum for different shapes of cells.

Enumerator
Simplex	Simplices.
Quad	Quadrilaterals.

Definition at line 127 of file CepsEnums.hpp.

CepsCompactSupportFlag

enum CepsCompactSupportFlag : CepsEnum

strong

Compact Support type enum.

Enumerator
Const	Rectangle with amplitude 1.
C4	C4 bell.
C5	C5 bell.
CInf	CInf bell.
SRectangle	Smooth rectangle.

Definition at line 91 of file CepsEnums.hpp.

CepsFunctionFlag

enum CepsFunctionFlag : CepsEnum

strong

Enum for CepsStandardArgs functions.

Enumerator
None	No dependance, constant functions.
Time	Depends on time.
Space	Depends on position x.
Solution	Depends on the content of a solution vector with values at dofs.
Attribute	Depends on the attribute of the region of evaluation.
DofIndex	Use dof index to determine position.
CellIndex	Use cell index to determine position.
NodeIndex	Use node index to determine position.
UnknownIndex	Use unknown index to compute result.

Definition at line 136 of file CepsEnums.hpp.

CepsGhostFlag

enum CepsGhostFlag : CepsEnum

strong

PartitionLocation: an enum that will be used by various elements of the code (pde, readers, etc)

Enumerator
Owned	Data is owned.
Halo	Data is in the halo.

Definition at line 118 of file CepsEnums.hpp.

CepsLocationFlag

enum CepsLocationFlag : CepsEnum

strong

DataLocation: an enum that will be used by various elements of the code (pde, readers, etc)

Enumerator
ZeroD	Data is defined once.
Point	Data is defined on each point.
Cell	Data is defined at cell centers.

Definition at line 107 of file CepsEnums.hpp.

CepsOutputFormat

enum CepsOutputFormat : CepsEnum

strong

Style of output files.

Enumerator
VTKLegacy	VTK Legacy, one by time steps.
VTU	VTU/PVTU files, one by time steps and by procs.
Music	MUSIC files, VTKLegacy and xml.
ParaviewSeries	Paraview files series, JSON + VTU/PVTU.
VTKCeps	vtk_ceps format, use contrib/CepsParaviewPlugin.py (5.11)
Medit	.mesh outputs. Sucks.

Definition at line 178 of file CepsEnums.hpp.

CepsSourceTermFlag

enum CepsSourceTermFlag : CepsEnum

strong

Source terms flags.

Enumerator
Default	Simply add the source term.
Stimulation	Apply cardiac specific treatment before adding.
Laplace	A source term that multiplies grad phi (for FE)

Definition at line 162 of file CepsEnums.hpp.

Variable Documentation

CepsCellTypeSize

constexpr CepsUInt CepsCellTypeSize = 200

constexpr

Size of enum CepsCellType.

Definition at line 133 of file CepsEnums.hpp.

CepsCompactSupportFlagSize

constexpr CepsUInt CepsCompactSupportFlagSize = 4

constexpr

Size of enum CepsCompactSupportFlags.

Definition at line 103 of file CepsEnums.hpp.

CepsFunctionFlagSize

constexpr CepsUInt CepsFunctionFlagSize = 1 << 9

constexpr

Number of function flags.

Definition at line 150 of file CepsEnums.hpp.

CepsGhostFlagSize

constexpr CepsUInt CepsGhostFlagSize = 2

constexpr

Size of enum CepsGhostFlag.

Definition at line 124 of file CepsEnums.hpp.

CepsLocationFlagSize

constexpr CepsUInt CepsLocationFlagSize = 3

constexpr

Size of enum CepsLocationFlag.

Definition at line 114 of file CepsEnums.hpp.