Common.h¶
The Common.h
header contains global definitions used in many places of the
code. The following compile time constants are defined:
- CUBISM_DIMENSION
The dimension of the default data structures generated by the compiler. The default is
CUBISM_DIMENSION=3
.
For CUBISM_DIMENSION=1,2,3
the following enum
classes are defined that
can be used for more descriptive code:
- Dir
Specifies direction. For
CUBISM_DIMENSION=3
the values areDir::X
,Dir::Y
andDir::Z
for example.- Vector
Is an alias for
Dir
, where the values are interpreted as components instead of direction.- Tensor
Combines direction and component. For
CUBISM_DIMENSION=2
the values areTensor::XX
,Tensor::XY
,Tensor::YX
andTensor::YY
.
-
enum
Cubism
::
EntityType
¶ Cubism entity type descriptor.
- Cell
Cell
entity, coordinates map to cell center (default)- Node
Node
entity (vertices)- Face
Face
entity that is spanned by nodes and is boundary of a cellCoordinates map the face center
- Undefined
No association
Values:
-
enumerator
Cell
¶
-
enumerator
Node
¶
-
enumerator
Face
¶
-
enumerator
Undefined
¶