xgc_reader_types.hpp File Reference

Typedefs
using	DimType = int
using	VertexIdType = int
using	EdgeIdType = int
using	CurveIdType = int
using	SurfaceIdType = int
using	GeomIdType = int
using	MeshIdType = int
using	PlaneId = int

Enumerations
enum class	SurfaceType {   Core , ScrapeOffLayer , LowFieldSideEdge , HighFieldSideEdge ,   NearVacuum , Private , None }
enum class	CurveType {   Closed , Open , Separatrix , Wall ,   None , Closed , Open , Separatrix ,   Wall , None }
enum class	PointType { OPoint , XPoint , None }
enum class	TopoType { Vertex = 0 , Edge = 1 , Face = 2 , Region = 3 }

Typedef Documentation

CurveIdType

using CurveIdType = int

Interger identifier for the model curves (both physics and physical curves).

DimType

using DimType = int

Interger identifier for the physical dimensions.
(0D = 0, 1D = 1, 2D = 2, 3D = 3).

EdgeIdType

using EdgeIdType = int

Interger identifier for the model and mesh edges.

GeomIdType

using GeomIdType = int

Integer identifier for the model entities. Although we do have identifier for individual entities, this is helpful in functions that take in and return entities of any dimension.

MeshIdType

using MeshIdType = int

Integer identifier for the mesh entities. Although we do have identifier for individual entities, this is helpful in functions that take in and return entities of any dimensions.

PlaneId

using PlaneId = int

Interger identifier for the planes. Unique for each poloidal plane.

SurfaceIdType

using SurfaceIdType = int

Interger identifier for the model faces.

VertexIdType

using VertexIdType = int

Interger identifier for the model and mesh vertices.

Enumeration Type Documentation

CurveType

enum class CurveType

strong

Curves are divided into four basics types. Three of them (closed, open, separatrix) are purely defined by physics and wall curve is the only one that is physical curve.

Enumerator
Closed
Open
Separatrix
Wall
None
Closed
Open
Separatrix
Wall
None

PointType

enum class PointType

strong

Two basic types of model vertices. Magnetic Axis: OPoint. Saddle Points of field: Xpoints

Enumerator
OPoint
XPoint
None

SurfaceType

enum class SurfaceType

strong

The set of surfaces can be classified into seven different types depending on the physics they corresponds to. The physics regions can be increased/decreased as we move forward.

Enumerator
Core
ScrapeOffLayer
LowFieldSideEdge
HighFieldSideEdge
NearVacuum
Private
None

TopoType

enum class TopoType

strong

Basic Topology definition of model/mesh entities. The lowest is the vertex which is considered 0D, and region is the largest entity (3D).

Enumerator
Vertex
Edge
Face
Region