CGNS.PAT

The PATtern module provides the user with functions dedicated to CGNS/Python trees. The PAT.cgnslib module uses the SIDS compliant data structures, you can create, read, check, modify some CGNS/Python sub-trees related to a SIDS type. With this module you are working with a Python data structure, all function are using plain Python/Numpy objects. Thus, the PAT module is not required for your applications, as you can write your own function to handle these Python objects. The PAT.cgnsutils provides utility fonctions for raw CGNS/Python trees or nodes. The PAT defines also constant modules such as PAT.cgnskeywords for all SIDS names or constant strings, PAT.cgnstypes for the SIDS types descriptions (enumerates, allowed list of children…) and the PAT.cgnserrors with error codes and their messages.

A special module PAT.SIDS has all CGNS/SIDS patterns gathered as PAT.cgnslib calls. These patterns, used for creation only, are building in a recursive way the whole sub-tree for a given SIDS type.

Direct links to modules documentation

• Utility functions (cgnsutils.py)
• Mid-level-like library (cgnslib.py)

Utilities

The CGNS.PAT.cgnsutils has a large set of utility functions using the CGNS/Python nodes, sub-trees or trees as arguments, you can manipulate tree paths, links, values. Functions are not gathered into a class because we want them to proceed on standard CGNS/Python trees. Most functions have an optional error management, you can ask them to raise an exception or to return None. The dienow argument is set to False as default, which means a error would return a None. A dienow set to True raises an error. Some functions also have an optional legacy management, to take into account old CGNS/Python stuff. When set to True, the CGNSTree_t top node should not appear and is not inserted when needed. The weird CGNS/SIDS types such as “int[IndexDimension]” are used instead of CGNS/Python replacements. The legacy argument is set to False as default.

The list below gives an overview of publicly available functions.

• Node Basics

• Node Structure and contents

• Path search and node retrieval

• CGNS/SIDS related features

• Node value manipulation

• Path manipulation functions

• Miscellaneous

Node Basics
nodeCreate	Create a new node
nodeCopy	Deep copy of node
nodeDelete	Delete node and its children
setAsChild	Add child
childrenNames	List of children names
removeChildByName	Delete child

Node Structure and Contents (top)
checkNode	Checks basic node structure
checkRootNode	Checks if the node is a tree root
checkNodeCompliant	Checks if node is CGNS/Python
checkNodeType	Checks CGNS/SIDS type
checkParentType	Checks CGNS/SIDS type of parent
checkNodeName	Checks name syntax (node arg)
checkName	Checks name syntax (str arg)
checkSameNode	Compare node contents (name,type,…)
checkDuplicatedName	Checks name against children
checkChildName	Checks name against children (again)
getChildName	Gets or generates new name
checkPath	Checks CGNS/SIDS path
checkArray	Checks numpy.ndarray
checkArrayChar	Checks numpy.ndarray of type C1
checkArrayReal	Checks numpy.ndarray of type R4 or R8
checkArrayInteger	Checks numpy.ndarray of type I4 or I8
hasChildType	Finds children from CGNS/SIDS type
hasChildNode	Finds child node from name
getChildName	Gets or generates new name

Search and Retrieve (top)
getNodeByPath	Return a node from its path
getValueByPath	Return a node value from node path
getParentFromNode	Return the parent node of the arg node
getChildrenByPath	Return list of node children from path
getTypeByPath	Return a node CGNS/SIDS type from path
getPathsByNameSet	All nodes matching the unordered set of name
getPathsByTypeSet	All nodes matching the unordered set of CGNS/SIDS types
getPathsByTypeList	All nodes matching the ordered list of CGNS/SIDS types
getPathsByTypeOrNameList	All nodes matching a list of names and CGNS/SIDS types
getNextChildSortByType	Iterator, get next child by type/name order

CGNS/SIDS information (top)
getAuthNames	List of allowed CGNS/SIDS names as child of node
getAuthChildren	List of allowed CGNS/SIDS types as child of node
getAuthDataTypes	List of allowed CGNS/SIDS data types for this node
getAuthParentTypes	List of all allowed CGNS/SIDS parent types
getAuthParentTypePaths	List of all allowed CGNS/SIDS parent types paths
getAuthShapes	List of all allowed CGNS/SIDS value shapes

Value manipulation (top)
getValueShape	Return node value shape (numpy.ndarray)
getValueDataType	Return node value data type as CGNS/SIDS data type
getValueType	Return value data type as CGNS/SIDS data type
hasFortranFlag	Return True if the node has a numpy.ndarray fortran order
setStringAsArray	Create a numpy.ndarray from a string
setIntegerAsArray	Create a numpy.ndarray from a integer tuple (numpy.int32)
setLongAsArray	Create a numpy.ndarray from a integer tuple (numpy.int64)
setFloatAsArray	Create a numpy.ndarray from a float tuple (numpy.float32)
setDoubleAsArray	Create a numpy.ndarray from a float tuple (numpy.float64)
setStringByPath	Update a numpy.ndarray from a string
setIntegerByPath	Update a numpy.ndarray from a integer tuple (numpy.int32)
setLongByPath	Update a numpy.ndarray from a integer tuple (numpy.int64)
setFloatByPath	Update a numpy.ndarray from a float tuple (numpy.float32)
setDoubleByPath	Update a numpy.ndarray from a float tuple (numpy.float64)
concatenateForArrayChar2D	Create a numpy.ndarray from list of strings
concatenateForArrayChar3D	Create a numpy.ndarray from list of list of strings
getValue	Get the node value
stringValueMatches	Check node value and arg string
copyArray	Copy numpy.ndarray with flags

Path functions (top)
getPathFromNode	Get the path of a node not including root name
getPathFromRoot	Get the path of a node including root name
getPathsFullTree	Get list of all CGNS/Python tree paths
getPathsByNameFilter	Get list of all tree paths with name filter
getPathsByTypeFilter	Get list of all tree paths with type filter
getPathToList	Returns the path string as a list of node names
getPathAncestor	Get the parent path of the arg path
getPathLeaf	Get the last node name of the arg path
hasFirstPathItem	Get the first item of the path
stackPathItem	Add items at end of path
removeFirstPathItem	Remove the first item of the path
getPathNoRoot	Get path with CGNS/Python root removed
getPathAsTypes	Get list of types of nodes along the arg path
getPathNormalize	Normalizes the arg path
getPathListCommonAncestor	Find the common ancestor of path list
getPathListAsWidthFirstIndex	Orders a path list with respect to width first search
hasSameRootPath	Finds if first path is prefix of second

Miscellaneous (top)
toString	Get a tree as a string
toFile	Write tree as a string in an importable file
stringNameMatches	Checks if the node name matches a regexp string
stringValueMatches	Checks if the node value matches a regexp string
copyArray	Copy a numpy.ndarray with flags

The Pythonish CGNS lib

The so-called CGNSlib or MLL or Mid-level library, is set of functions for used to read/write/modify a set of nodes matching a CGNS/SIDS type. The Pythonish flavour of this library declares a set of functions with more or less the same interface but with Python values.

Each function takes a parent as argument. If the parent is present, the new sub-tree is inserted in the parent child list. In all cases the call returns the created sub-tree The function names patterns are:

• newXXX: creates a new XXX_t type node

• updateXXX: updates fields in the XXX_t node

• checkXXX: check if node is ok for SIDS and for CGNS/Python

SIDS	Function
	newCGNSTree
6.2	newCGNSBase
4.1	newDataClass
4.2	newDescriptor
4.3	newDimensionalUnits
4.4	newDimensionalExponents
4.5	newGridLocation
4.6	newIndexArray
	newPointList
	newPointRange
4.8	newRind
5.1.1	newDataConversion
	newSimulationType
	newBase
	newOrdinal
6.3	newZone
7.1	newGridCoordinates
5.1	newDataArray
	newDiscreteData
7.3	newElements
9.2	newZoneBC
9.3	newBC
	newBoundary
9.4	newBCDataSet
9.5	newBCData
9.6	newBCProperty
	newCoordinates
7.5	newAxisymmetry
7.6	newRotatingCoordinates
7.7	newFlowSolution
8.1	newZoneGridConnectivity
8.2	newGridConnectivity1to1
8.4	newGridConnectivity
8.6	newGridConnectivityProperty
8.6.2	newAverageInterface
8.7	newOversetHoles
10.1	newFlowEquationSet
10.2	newGoverningEquations
10.4	newGasModel
10.6	newThermalConductivityModel
10.5	newViscosityModel
10.7.1	newTurbulenceClosure
10.7.2	newTurbulenceModel
10.8	newThermalRelaxationModel
10.9	newChemicalKineticsModel
10.10.1	newEMElectricFieldModel
10.10.2	newEMMagneticFieldModel
10.10.3	newEMConductivityModel
11.1.1	newBaseIterativeData
11.1.2	newZoneIterativeData
11.2	newRigidGridMotion
12.1	newReferenceState
12.3	newConvergenceHistory
12.5	newIntegralData
12.6	newFamily
	newFamilyName
12.7	newGeometryReference
12.8	newFamilyBC
11.3	newArbitraryGridMotion
12.10	newUserDefinedData
12.11	newGravity
	newField
	newModel
	newDiffusionModel
	newParentElements
	newParentElementsPosition

SIDS patterns

The patterns are importable modules, they create a complete SIDS sub-tree with default values. There is no way to customize the default values or the actual contents of the sub-tree. The pattern creates the mandatory as well as the optional nodes. Once created, the user has to modify the sub-tree using the PAT.cgnsutils or PAT.cgnslib functions.

Once the pattern module is imported, the actual pattern is referenced by the data variable:

import BaseIterativeData_t.data as mysubtree

The pattern is a CGNS/Python list and thus it should be copied before any modification:

import BaseIterativeData_t
import copy

t=BaseIterativeData_t.data

t1=copy.deepcopy(t)
t2=copy.deepcopy(t)

For example, you can use PAT.cgnslib to create a BaseIterativeData_t node with:

data=C.newBaseIterativeData(None)

This call create the unique BaseIterativeData_t node (or sub-tree which is the same in this case because we have only one node). The new node is returned, the None argument means we do not define a parent node, it is up to the user to add this new node in a existing children list.

Now we can use the PAT.SIDS.BaseIterativeData_t which creates the same BaseIterativeData_t node as before, but also create the whole SIDS sub-tree with default values, here is a snippet of this pattern:

import CGNS.PAT.cgnslib      as C
import CGNS.PAT.cgnskeywords as K

data=C.newBaseIterativeData(None)
C.newDataArray(data,K.NumberOfZones_s)
C.newDataArray(data,K.NumberOfFamilies_s)
C.newDataArray(data,K.ZonePointers_s)
C.newDataArray(data,K.FamilyPointers_s)
C.newDataArray(data,'{DataArray}')
C.newDataClass(data)
C.newDimensionalUnits(data)
C.newUserDefinedData(data,'{UserDefinedData}')
C.newDescriptor(data,'{Descriptor}')

You see all the mandatory and optional SIDS nodes are created, the user has to set his own values in the resulting sub-tree using the PAT.cgnslib or the PAT.cgnsutils functions.

CGNS Keywords

Instead of generating a new doc from a file, the file itself is included here. The purpose of cgnskeywords.py is to declare all constants as Python variables. This leads to several advantages:

• You cannot make a typo on a name. For example, if you use “ZoneGridConnectivity” as a plain string you may mistype it as “Zonegridconnectivity” or “ZoneGridConectivity” and this may silently produce a bad CGNS tree.

• You can handle enumerate as lists. For example you have lists for units: MassUnits_l, LengthUnits_l, AllDimensionalUnits_l, AllUnits_l

• You can identify what is a CGNS reserved or recommended name or not.

#  ---------------------------------------------------------------------------
#  pyCGNS - Python package for CFD General Notation System -
#  See license.txt file in the root directory of this Python module source
#  ---------------------------------------------------------------------------
#
"""
 TYPES, ENUMERATES, CONSTANTS, NAMES from CGNS/MLL

 Conventions:

 [1] A CGNS/SIDS string constant is postfixed with _s
 'ZoneType' is ZoneType_s

 [2] A CGNS/SIDS string constant naming a type has _ts
 'ZoneType_t' is ZoneType_ts

 [3] A list of possible values for a given type has _l
 ZoneType_l is [Null_s,UserDefined_s,Structured_s,Unstructured_s]
 which is same as ["Null","UserDefined","Structured","Unstructured"]
 List should be ordered wrt the actual enumerate

 [4] An enumerate mapping of a list of values is not prefixed
 ZoneType is {'Unstructured':3,'Null':0,'Structured':2,'UserDefined':1}

 [5] The reverse dictionnary of the previous one is postfixed with _
 ZoneType_ is {0:'Null',1:'UserDefined',2:'Structured',3:'Unstructured'}

 [6] The variables are declared with an integer value (not enumerates)
 wrt their position in the _l list, for example:
 (Null,UserDefined,Structured,Unstructured)=list(ZoneType_)

 [7] The _t type names are reserved for Cython, enums are then used as int:
 ctypedef int DataType_t
 int cg_array_read_as(int A, DataType_t type, void *Data)
 
"""

# ----------------------------------------------------------------------------


def stringAsKeyDict(l):
    return dict(zip(l, range(len(l))))


def enumAsKeyDict(l):
    return dict(zip(range(len(l)), l))


# --------------------------------------------------
# --- ADF-level Datatypes
#
# MT: No data; LK: Link
adftypes = ("C1", "I4", "I8", "R4", "R8", "MT", "LK")
(C1, I4, I8, R4, R8, MT, LK) = adftypes

# --------------------------------------------------
# --- ADF-level Constants
#
ADF_DATA_TYPE_LENGTH = 32
ADF_DATE_LENGTH = 32
ADF_FILENAME_LENGTH = 1024
ADF_FORMAT_LENGTH = 20
ADF_LABEL_LENGTH = 32
ADF_MAXIMUM_LINK_DEPTH = 100
ADF_MAX_DIMENSIONS = 12
ADF_MAX_ERROR_STR_LENGTH = 80
ADF_MAX_LINK_DATA_SIZE = 4096
ADF_NAME_LENGTH = 32
ADF_STATUS_LENGTH = 32
ADF_VERSION_LENGTH = 32

ADF_ROOT_NODE_NAME = "HDF5 MotherNode"
ADF_ROOT_NODE_LABEL = "Root Node of HDF5 File"

CGNSHDF5ROOT_s = ADF_ROOT_NODE_NAME
CGNSLIBRARYVERSION = 4.0

# -------------------------------------------------- (NOT SIDS)
# --- CGNS/Python mapping extensions
#
CGNSTree_ts = "CGNSTree_t"
CGNSTree_s = "CGNSTree"

# --- Type with weird (coming from outer space) names
#
Transform_ts = "Transform_t"
DiffusionModel_ts = "DiffusionModel_t"
EquationDimension_ts = "EquationDimension_t"
InwardNormalIndex_ts = "InwardNormalIndex_t"
IntIndexDimension_ts = "IntIndexDimension_t"

# --- Add legacy strings for translation tools
#
Transform_ts2 = '"int[IndexDimension]"'
Transform_ts3 = "int[IndexDimension]"
DiffusionModel_ts2 = '"int[1+...+IndexDimension]"'
EquationDimension_ts2 = '"int"'
InwardNormalIndex_ts2 = '"int[IndexDimension]"'

weirdSIDStypes = {
    Transform_ts2: IntIndexDimension_ts,
    Transform_ts3: IntIndexDimension_ts,
    DiffusionModel_ts2: DiffusionModel_ts,
    EquationDimension_ts2: EquationDimension_ts,
    InwardNormalIndex_ts2: IntIndexDimension_ts,
}

weirdSIDStypes_ = {
    Transform_ts: Transform_ts2,
    DiffusionModel_ts: DiffusionModel_ts2,
    EquationDimension_ts: EquationDimension_ts2,
    InwardNormalIndex_ts: InwardNormalIndex_ts2,
}

# -------------------------------------------------- (SIDS)
# SIDS
#
Null_s = "Null"
UserDefined_s = "UserDefined"

# --------------------------------------------------
Kilogram_s = "Kilogram"
Gram_s = "Gram"
Slug_s = "Slug"
PoundMass_s = "PoundMass"
MassUnits_l = [Null_s, UserDefined_s, Kilogram_s, Gram_s, Slug_s, PoundMass_s]

MassUnits = stringAsKeyDict(MassUnits_l)
MassUnits_ = enumAsKeyDict(MassUnits_l)
(MassUnitsNull, MassUnitsUserDefined, Kilogram, Gram, Slug, PoundMass) = list(
    MassUnits_
)

# --------------------------------------------------
Meter_s = "Meter"
Centimeter_s = "Centimeter"
Millimeter_s = "Millimeter"
Foot_s = "Foot"
Inch_s = "Inch"
LengthUnits_l = [
    Null_s,
    UserDefined_s,
    Meter_s,
    Centimeter_s,
    Millimeter_s,
    Foot_s,
    Inch_s,
]

LengthUnits = stringAsKeyDict(LengthUnits_l)
LengthUnits_ = enumAsKeyDict(LengthUnits_l)
(
    LengthUnitsNull,
    LengthUnitsUserDefined,
    Meter,
    Centimeter,
    Millimeter,
    Foot,
    Inch,
) = list(LengthUnits_)

# --------------------------------------------------
Second_s = "Second"
TimeUnits_l = [Null_s, UserDefined_s, Second_s]

TimeUnits = stringAsKeyDict(TimeUnits_l)
TimeUnits_ = enumAsKeyDict(TimeUnits_l)
(TimeUnitsNull, TimeUnitsUserDefined, Second) = list(TimeUnits_)

# --------------------------------------------------
Kelvin_s = "Kelvin"
Celcius_s = "Celcius"
Rankine_s = "Rankine"
Fahrenheit_s = "Fahrenheit"
TemperatureUnits_l = [
    Null_s,
    UserDefined_s,
    Kelvin_s,
    Celcius_s,
    Rankine_s,
    Fahrenheit_s,
]

TemperatureUnits = stringAsKeyDict(TemperatureUnits_l)
TemperatureUnits_ = enumAsKeyDict(TemperatureUnits_l)
(
    TemperatureUnitsNull,
    TemperatureUnitsUserDefined,
    Kelvin,
    Celcius,
    Rankine,
    Fahrenheit,
) = list(TemperatureUnits_)

# --------------------------------------------------
Degree_s = "Degree"
Radian_s = "Radian"
AngleUnits_l = [Null_s, UserDefined_s, Degree_s, Radian_s]

AngleUnits = stringAsKeyDict(AngleUnits_l)
AngleUnits_ = enumAsKeyDict(AngleUnits_l)
(AngleUnitsNull, AngleUnitsUserDefined, Degree, Radian) = list(AngleUnits_)

# --------------------------------------------------
Ampere_s = "Ampere"
Abampere_s = "Abampere"
Statampere_s = "Statampere"
Edison_s = "Edison"
auCurrent_s = "auCurrent"
ElectricCurrentUnits_l = [
    Null_s,
    UserDefined_s,
    Ampere_s,
    Abampere_s,
    Statampere_s,
    Edison_s,
    auCurrent_s,
]

ElectricCurrentUnits = stringAsKeyDict(ElectricCurrentUnits_l)
ElectricCurrentUnits_ = enumAsKeyDict(ElectricCurrentUnits_l)
(
    ElectricCurrentUnitsNull,
    ElectricCurrentUnitsUserDefined,
    Ampere,
    Abampere,
    Statampere,
    Edison,
    auCurrent,
) = list(ElectricCurrentUnits_)

# --------------------------------------------------
Mole_s = "Mole"
Entities_s = "Entities"
StandardCubicFoot_s = "StandardCubicFoot"
StandardCubicMeter_s = "StandardCubicMeter"
SubstanceAmountUnits_l = [
    Null_s,
    UserDefined_s,
    Mole_s,
    Entities_s,
    StandardCubicFoot_s,
    StandardCubicMeter_s,
]

SubstanceAmountUnits = stringAsKeyDict(SubstanceAmountUnits_l)
SubstanceAmountUnits_ = enumAsKeyDict(SubstanceAmountUnits_l)
(
    SubstanceAmountUnitsNull,
    SubstanceAmountUnitsUserDefined,
    Mole,
    Entities,
    StandardCubicFoot,
    StandardCubicMeter,
) = list(SubstanceAmountUnits_)

# --------------------------------------------------
Candela_s = "Candela"
Candle_s = "Candle"
Carcel_s = "Carcel"
Hefner_s = "Hefner"
Violle_s = "Violle"
LuminousIntensityUnits_l = [
    Null_s,
    UserDefined_s,
    Candela_s,
    Candle_s,
    Carcel_s,
    Hefner_s,
    Violle_s,
]

LuminousIntensityUnits = stringAsKeyDict(LuminousIntensityUnits_l)
LuminousIntensityUnits_ = enumAsKeyDict(LuminousIntensityUnits_l)
(
    LuminousIntensityUnitsNull,
    LuminousIntensityUnitsUserDefined,
    Candela,
    Candle,
    Carcel,
    Hefner,
    Violle,
) = list(LuminousIntensityUnits_)

# --------------------------------------------------
DimensionalUnits_s = "DimensionalUnits"
AdditionalUnits_s = "AdditionalUnits"
AdditionalExponents_s = "AdditionalExponents"

AllDimensionalUnits_l = (
    TimeUnits_l + MassUnits_l + LengthUnits_l + TemperatureUnits_l + AngleUnits_l
)
AllAdditionalUnits_l = (
    LuminousIntensityUnits_l + SubstanceAmountUnits_l + ElectricCurrentUnits_l
)
AllUnits_l = AllDimensionalUnits_l + AllAdditionalUnits_l

# --------------------------------------------------
DataClass_ts = "DataClass_t"
DataClass_s = "DataClass"

Dimensional_s = "Dimensional"
NormalizedByDimensional_s = "NormalizedByDimensional"
NormalizedByUnknownDimensional_s = "NormalizedByUnknownDimensional"
NondimensionalParameter_s = "NondimensionalParameter"
DimensionlessConstant_s = "DimensionlessConstant"

DataClass_l = [
    Null_s,
    UserDefined_s,
    Dimensional_s,
    NormalizedByDimensional_s,
    NormalizedByUnknownDimensional_s,
    NondimensionalParameter_s,
    DimensionlessConstant_s,
]
DataClass = stringAsKeyDict(DataClass_l)
DataClass_ = enumAsKeyDict(DataClass_l)
(
    Null,
    UserDefined,
    Dimensional,
    NormalizedByDimensional,
    NormalizedByUnknownDimensional,
    NondimensionalParameter,
    DimensionlessConstant,
) = list(DataClass_)

# ------------------------------------------------------------
GridLocation_ts = "GridLocation_t"
GridLocation_s = "GridLocation"

Vertex_s = "Vertex"
Edge_s = "Edge"
Face_s = "Face"
Cell_s = "Cell"
CellCenter_s = "CellCenter"
FaceCenter_s = "FaceCenter"
IFaceCenter_s = "IFaceCenter"
JFaceCenter_s = "JFaceCenter"
KFaceCenter_s = "KFaceCenter"
EdgeCenter_s = "EdgeCenter"

GridLocation_l = [
    Null_s,
    UserDefined_s,
    Vertex_s,
    CellCenter_s,
    FaceCenter_s,
    IFaceCenter_s,
    JFaceCenter_s,
    KFaceCenter_s,
    EdgeCenter_s,
]
GridLocation = stringAsKeyDict(GridLocation_l)
GridLocation_ = enumAsKeyDict(GridLocation_l)
(
    Null,
    UserDefined,
    Vertex,
    CellCenter,
    FaceCenter,
    IFaceCenter,
    JFaceCenter,
    KFaceCenter,
    EdgeCenter,
) = list(GridLocation_)

VertexSize_s = "VertexSize"
CellSize_s = "CellSize"
VertexSizeBoundary_s = "VertexSizeBoundary"
ElementsSize_s = "ElementsSize"

# ------------------------------------------------------------
PointSetType_ts = "PointSetType_t"

PointList_s = "PointList"
PointListDonor_s = "PointListDonor"
PointRange_s = "PointRange"
PointRangeDonor_s = "PointRangeDonor"
ElementRange_s = "ElementRange"
ElementList_s = "ElementList"
CellListDonor_s = "CellListDonor"

PointSetType_l = [
    Null_s,
    UserDefined_s,
    PointList_s,
    PointListDonor_s,
    PointRange_s,
    PointRangeDonor_s,
    ElementRange_s,
    ElementList_s,
    CellListDonor_s,
]
PointSetType = stringAsKeyDict(PointSetType_l)
PointSetType_ = enumAsKeyDict(PointSetType_l)
(
    Null,
    UserDefined,
    PointList,
    PointListDonor,
    PointRange,
    PointRangeDonor,
    ElementRange,
    ElementList,
    CellListDonor,
) = list(PointSetType_)

ZoneDonorName_s = "ZoneDonorName"

# ------------------------------------------------------------
BCDataType_ts = "BCDataType_t"
BCDataType_s = "BCDataType"

DirichletData_s = "DirichletData"
NeumannData_s = "NeumannData"
Dirichlet_s = "Dirichlet"
Neumann_s = "Neumann"

BCDataType_l = [Null_s, UserDefined_s, Dirichlet_s, Neumann_s]
BCDataType = stringAsKeyDict(BCDataType_l)
BCDataType_ = enumAsKeyDict(BCDataType_l)
(BCDataTypeNull, BCDataTypeUserDefined, Dirichlet, Neumann) = list(BCDataType_)

FullPotential_s = "FullPotential"
Euler_s = "Euler"
NSLaminar_s = "NSLaminar"
NSTurbulent_s = "NSTurbulent"
NSLaminarIncompressible_s = "NSLaminarIncompressible"
NSTurbulentIncompressible_s = "NSTurbulentIncompressible"

Ideal_s = "Ideal"
VanderWaals_s = "VanderWaals"
Constant_s = "Constant"
PowerLaw_s = "PowerLaw"
SutherlandLaw_s = "SutherlandLaw"
ConstantPrandtl_s = "ConstantPrandtl"
EddyViscosity_s = "EddyViscosity"
ReynoldsStress_s = "ReynoldsStress"
Algebraic_s = "Algebraic"
BaldwinLomax_s = "BaldwinLomax"
ReynoldsStressAlgebraic_s = "ReynoldsStressAlgebraic"
Algebraic_BaldwinLomax_s = "Algebraic_BaldwinLomax"
Algebraic_CebeciSmith_s = "Algebraic_CebeciSmith"
HalfEquation_JohnsonKing_s = "HalfEquation_JohnsonKing"
OneEquation_BaldwinBarth_s = "OneEquation_BaldwinBarth"
OneEquation_SpalartAllmaras_s = "OneEquation_SpalartAllmaras"
TwoEquation_JonesLaunder_s = "TwoEquation_JonesLaunder"
TwoEquation_MenterSST_s = "TwoEquation_MenterSST"
TwoEquation_Wilcox_s = "TwoEquation_Wilcox"
CaloricallyPerfect_s = "CaloricallyPerfect"
ThermallyPerfect_s = "ThermallyPerfect"
ConstantDensity_s = "ConstantDensity"
RedlichKwong_s = "RedlichKwong"
Frozen_s = "Frozen"
ThermalEquilib_s = "ThermalEquilib"
ThermalNonequilib_s = "ThermalNonequilib"
ChemicalEquilibCurveFit_s = "ChemicalEquilibCurveFit"
ChemicalEquilibMinimization_s = "ChemicalEquilibMinimization"
ChemicalNonequilib_s = "ChemicalNonequilib"
EMElectricField_s = "EMElectricField"
EMMagneticField_s = "EMMagneticField"
EMConductivity_s = "EMConductivity"
Voltage_s = "Voltage"
Interpolated_s = "Interpolated"
Equilibrium_LinRessler_s = "Equilibrium_LinRessler"
Chemistry_LinRessler_s = "Chemistry_LinRessler"

FamilySpecified_s = "FamilySpecified"

# --------------------------------------------------
DataType_ts = "DataType_t"
DataType_s = "DataType"

Integer_s = "Integer"
LongInteger_s = "LongInteger"
RealSingle_s = "RealSingle"
RealDouble_s = "RealDouble"
Character_s = "Character"

DataType_l = [
    Null_s,
    UserDefined_s,
    Integer_s,
    RealSingle_s,
    RealDouble_s,
    Character_s,
    LongInteger_s,
]
DataType = stringAsKeyDict(DataType_l)
DataType_ = enumAsKeyDict(DataType_l)

(
    DataTypeNull,
    DataTypeUserDefined,
    Integer,
    RealSingle,
    RealDouble,
    Character,
    LongInteger,
) = list(DataType_)

# --------------------------------------------------
GridConnectivityType_ts = "GridConnectivityType_t"
GridConnectivityType_s = "GridConnectivityType"
GridConnectivity_ts = "GridConnectivity_t"
ZoneGridConnectivity_ts = "ZoneGridConnectivity_t"
ZoneGridConnectivity_s = "ZoneGridConnectivity"

Overset_s = "Overset"
Abutting_s = "Abutting"
Abutting1to1_s = "Abutting1to1"

GridConnectivityType_l = [Null_s, UserDefined_s, Overset_s, Abutting_s, Abutting1to1_s]
GridConnectivityType = stringAsKeyDict(GridConnectivityType_l)
GridConnectivityType_ = enumAsKeyDict(GridConnectivityType_l)

(Null, UserDefined, Overset, Abutting, Abutting1to1) = list(GridConnectivityType_)

# --------------------------------------------------
ZoneType_ts = "ZoneType_t"
ZoneType_s = "ZoneType"
Zone_ts = "Zone_t"

Structured_s = "Structured"
Unstructured_s = "Unstructured"

ZoneType_l = [Null_s, UserDefined_s, Structured_s, Unstructured_s]
ZoneType = stringAsKeyDict(ZoneType_l)
ZoneType_ = enumAsKeyDict(ZoneType_l)

(ZoneTypeNull, ZoneTypeUserdefined, Structured, Unstructured) = list(ZoneType_)

ZoneSubRegion_ts = "ZoneSubRegion_t"
BCRegionName_s = "BCRegionName"
GridConnectivityRegionName_s = "GridConnectivityRegionName"

# --------------------------------------------------
SimulationType_ts = "SimulationType_t"
SimulationType_s = "SimulationType"

TimeAccurate_s = "TimeAccurate"
NonTimeAccurate_s = "NonTimeAccurate"

SimulationType_l = [Null_s, UserDefined_s, TimeAccurate_s, NonTimeAccurate_s]
SimulationType = stringAsKeyDict(SimulationType_l)
SimulationType_ = enumAsKeyDict(SimulationType_l)

(Null, UserDefined, TimeAccurate, NonTimeAccurate) = list(SimulationType_)

# --------------------------------------------------
RigidGridMotionType_s = "RigidGridMotionType"
RigidGridMotionType_ts = "RigidGridMotionType_t"

ConstantRate_s = "ConstantRate"
VariableRate_s = "VariableRate"

RigidGridMotionType_l = [Null_s, UserDefined_s, ConstantRate_s, VariableRate_s]
RigidGridMotionType = stringAsKeyDict(RigidGridMotionType_l)
RigidGridMotionType_ = enumAsKeyDict(RigidGridMotionType_l)

(Null, UserDefined, ConstantRate, VariableRate) = list(RigidGridMotionType_)

ArbitraryGridMotionType_s = "ArbitraryGridMotionType"
ArbitraryGridMotionType_ts = "ArbitraryGridMotionType_t"

NonDeformingGrid_s = "NonDeformingGrid"
DeformingGrid_s = "DeformingGrid"

ArbitraryGridMotion_ts = "ArbitraryGridMotion_t"
ArbitraryGridMotion_s = "ArbitraryGridMotion"
ArbitraryGridMotionType_l = [Null_s, UserDefined_s, NonDeformingGrid_s, DeformingGrid_s]
ArbitraryGridMotion = stringAsKeyDict(ArbitraryGridMotionType_l)
ArbitraryGridMotion_ = enumAsKeyDict(ArbitraryGridMotionType_l)

(Null, UserDefined, NonDeformingGrid, DeformingGrid) = list(ArbitraryGridMotion_)

# --------------------------------------------------
WallFunction_ts = "WallFunction_t"
WallFunction_s = "WallFunction"

Generic_s = "Generic"

WallFunctionType_ts = "WallFunctionType_t"
WallFunctionType_s = "WallFunctionType"

WallFunctionType_l = [Null_s, UserDefined_s, Generic_s]
WallFunctionType = stringAsKeyDict(WallFunctionType_l)
WallFunctionType_ = enumAsKeyDict(WallFunctionType_l)

(Null, UserDefined, Generic) = list(WallFunctionType_)

# --------------------------------------------------
Area_ts = "Area_t"
Area_s = "Area"

BleedArea_s = "BleedArea"
CaptureArea_s = "CaptureArea"

AreaType_ts = "AreaType_t"
AreaType_s = "AreaType"
AreaType_l = [Null_s, UserDefined_s, BleedArea_s, CaptureArea_s]
AreaType = stringAsKeyDict(AreaType_l)
AreaType_ = enumAsKeyDict(AreaType_l)
(Null, UserDefined, BleedArea, CaptureArea) = list(AreaType_)

# --------------------------------------------------
ZoneBC_ts = "ZoneBC_t"
ZoneBC_s = "ZoneBC"
ZoneIterativeData_ts = "ZoneIterativeData_t"
ZoneIterativeData_s = "ZoneIterativeData"

UserDefinedData_ts = "UserDefinedData_t"

AverageAll_s = "AverageAll"
AverageCircumferential_s = "AverageCircumferential"
AverageRadial_s = "AverageRadial"
AverageI_s = "AverageI"
AverageJ_s = "AverageJ"
AverageK_s = "AverageK"
CGNSLibraryVersion_s = "CGNSLibraryVersion"
CellDimension_s = "CellDimension"
IndexDimension_s = "IndexDimension"
PhysicalDimension_s = "PhysicalDimension"
GridCoordinates_s = "GridCoordinates"
CoordinateNames_s = "CoordinateNames"
CoordinateX_s = "CoordinateX"
CoordinateY_s = "CoordinateY"
CoordinateZ_s = "CoordinateZ"
CoordinateR_s = "CoordinateR"
CoordinateTheta_s = "CoordinateTheta"
CoordinatePhi_s = "CoordinatePhi"
CoordinateNormal_s = "CoordinateNormal"
CoordinateTangential_s = "CoordinateTangential"
CoordinateXi_s = "CoordinateXi"
CoordinateEta_s = "CoordinateEta"
CoordinateZeta_s = "CoordinateZeta"
CoordinateTransform_s = "CoordinateTransform"
InterpolantsDonor_s = "InterpolantsDonor"
ElementConnectivity_s = "ElementConnectivity"
ElementStartOffset_s = "ElementStartOffset"
ParentData_s = "ParentData"
ParentElements_s = "ParentElements"
ParentElementsPosition_s = "ParentElementsPosition"
ElementSizeBoundary_s = "ElementSizeBoundary"
VectorX_ps = "%sX"
VectorY_ps = "%sY"
VectorZ_ps = "%sZ"
VectorTheta_ps = "%sTheta"
VectorPhi_ps = "%sPhi"
VectorMagnitude_ps = "%sMagnitude"
VectorNormal_ps = "%sNormal"
VectorTangential_ps = "%sTangential"
Potential_s = "Potential"
StreamFunction_s = "StreamFunction"
Density_s = "Density"
Pressure_s = "Pressure"
Temperature_s = "Temperature"
EnergyInternal_s = "EnergyInternal"
Enthalpy_s = "Enthalpy"
Entropy_s = "Entropy"
EntropyApprox_s = "EntropyApprox"
DensityStagnation_s = "DensityStagnation"
PressureStagnation_s = "PressureStagnation"
TemperatureStagnation_s = "TemperatureStagnation"
EnergyStagnation_s = "EnergyStagnation"
EnthalpyStagnation_s = "EnthalpyStagnation"
EnergyStagnationDensity_s = "EnergyStagnationDensity"
VelocityX_s = "VelocityX"
VelocityY_s = "VelocityY"
VelocityZ_s = "VelocityZ"
VelocityR_s = "VelocityR"
VelocityTheta_s = "VelocityTheta"
VelocityPhi_s = "VelocityPhi"
VelocityMagnitude_s = "VelocityMagnitude"
VelocityNormal_s = "VelocityNormal"
VelocityTangential_s = "VelocityTangential"
VelocitySound_s = "VelocitySound"
VelocitySoundStagnation_s = "VelocitySoundStagnation"
MomentumX_s = "MomentumX"
MomentumY_s = "MomentumY"
MomentumZ_s = "MomentumZ"
MomentumMagnitude_s = "MomentumMagnitude"
RotatingVelocityX_s = "RotatingVelocityX"
RotatingVelocityY_s = "RotatingVelocityY"
RotatingVelocityZ_s = "RotatingVelocityZ"
RotatingMomentumX_s = "RotatingMomentumX"
RotatingMomentumY_s = "RotatingMomentumY"
RotatingMomentumZ_s = "RotatingMomentumZ"
RotatingVelocityMagnitude_s = "RotatingVelocityMagnitude"
RotatingPressureStagnation_s = "RotatingPressureStagnation"
RotatingEnergyStagnation_s = "RotatingEnergyStagnation"
RotatingEnergyStagnationDensity_s = "RotatingEnergyStagnationDensity"
RotatingEnthalpyStagnation_s = "RotatingEnthalpyStagnation"
EnergyKinetic_s = "EnergyKinetic"
PressureDynamic_s = "PressureDynamic"
SoundIntensityDB_s = "SoundIntensityDB"
SoundIntensity_s = "SoundIntensity"
VorticityX_s = "VorticityX"
VorticityY_s = "VorticityY"
VorticityZ_s = "VorticityZ"
VorticityMagnitude_s = "VorticityMagnitude"
SkinFrictionX_s = "SkinFrictionX"
SkinFrictionY_s = "SkinFrictionY"
SkinFrictionZ_s = "SkinFrictionZ"
SkinFrictionMagnitude_s = "SkinFrictionMagnitude"
VelocityAngleX_s = "VelocityAngleX"
VelocityAngleY_s = "VelocityAngleY"
VelocityAngleZ_s = "VelocityAngleZ"
VelocityUnitVectorX_s = "VelocityUnitVectorX"
VelocityUnitVectorY_s = "VelocityUnitVectorY"
VelocityUnitVectorZ_s = "VelocityUnitVectorZ"
MassFlow_s = "MassFlow"
ViscosityKinematic_s = "ViscosityKinematic"
ViscosityMolecular_s = "ViscosityMolecular"
ViscosityEddyDynamic_s = "ViscosityEddyDynamic"
ViscosityEddy_s = "ViscosityEddy"
ThermalConductivity_s = "ThermalConductivity"
PowerLawExponent_s = "PowerLawExponent"
SutherlandLawConstant_s = "SutherlandLawConstant"
TemperatureReference_s = "TemperatureReference"
ViscosityMolecularReference_s = "ViscosityMolecularReference"
ThermalConductivityReference_s = "ThermalConductivityReference"
IdealGasConstant_s = "IdealGasConstant"
SpecificHeatPressure_s = "SpecificHeatPressure"
SpecificHeatVolume_s = "SpecificHeatVolume"
ReynoldsStressXX_s = "ReynoldsStressXX"
ReynoldsStressXY_s = "ReynoldsStressXY"
ReynoldsStressXZ_s = "ReynoldsStressXZ"
ReynoldsStressYY_s = "ReynoldsStressYY"
ReynoldsStressYZ_s = "ReynoldsStressYZ"
ReynoldsStressZZ_s = "ReynoldsStressZZ"
LengthReference_s = "LengthReference"
MolecularWeight_s = "MolecularWeight"
MolecularWeight_ps = "MolecularWeight%s"
HeatOfFormation_s = "HeatOfFormation"
HeatOfFormation_ps = "HeatOfFormation%s"
FuelAirRatio_s = "FuelAirRatio"
ReferenceTemperatureHOF_s = "ReferenceTemperatureHOF"
MassFraction_s = "MassFraction"
MassFraction_ps = "MassFraction%s"
LaminarViscosity_s = "LaminarViscosity"
LaminarViscosity_ps = "LaminarViscosity%s"
ThermalConductivity_ps = "ThermalConductivity%s"
EnthalpyEnergyRatio_s = "EnthalpyEnergyRatio"
CompressibilityFactor_s = "CompressibilityFactor"
VibrationalElectronEnergy_s = "VibrationalElectronEnergy"
VibrationalElectronTemperature_s = "VibrationalElectronTemperature"
SpeciesDensity_s = "SpeciesDensity"
SpeciesDensity_ps = "SpeciesDensity%s"
MoleFraction_s = "MoleFraction"
MoleFraction_ps = "MoleFraction%s"
ElectricFieldX_s = "ElectricFieldX"
ElectricFieldY_s = "ElectricFieldY"
ElectricFieldZ_s = "ElectricFieldZ"
MagneticFieldX_s = "MagneticFieldX"
MagneticFieldY_s = "MagneticFieldY"
MagneticFieldZ_s = "MagneticFieldZ"
CurrentDensityX_s = "CurrentDensityX"
CurrentDensityY_s = "CurrentDensityY"
CurrentDensityZ_s = "CurrentDensityZ"
LorentzForceX_s = "LorentzForceX"
LorentzForceY_s = "LorentzForceY"
LorentzForceZ_s = "LorentzForceZ"
ElectricConductivity_s = "ElectricConductivity"
JouleHeating_s = "JouleHeating"
TurbulentDistance_s = "TurbulentDistance"
TurbulentDistanceIndex_s = "TurbulentDistanceIndex"  # not SIDS
TurbulentEnergyKinetic_s = "TurbulentEnergyKinetic"
TurbulentEnergyKineticDensity_s = "TurbulentEnergyKineticDensity"  # not SIDS
TurbulentDissipation_s = "TurbulentDissipation"
TurbulentDissipationRate_s = "TurbulentDissipationRate"
TurbulentDissipationDensity_s = "TurbulentDissipationDensity"  # not SIDS
TurbulentBBReynolds_s = "TurbulentBBReynolds"
TurbulentSANuTilde_s = "TurbulentSANuTilde"
TurbulentSANuTildeDensity_s = "TurbulentSANuTildeDensity"  # not SIDS
Mach_s = "Mach"
Mach_Velocity_s = "Mach_Velocity"
Mach_VelocitySound_s = "Mach_VelocitySound"
Reynolds_s = "Reynolds"
Reynolds_Velocity_s = "Reynolds_Velocity"
Reynolds_Length_s = "Reynolds_Length"
Reynolds_ViscosityKinematic_s = "Reynolds_ViscosityKinematic"
Prandtl_s = "Prandtl"
Prandtl_ThermalConductivity_s = "Prandtl_ThermalConductivity"
Prandtl_ViscosityMolecular_s = "Prandtl_ViscosityMolecular"
Prandtl_SpecificHeatPressure_s = "Prandtl_SpecificHeatPressure"
PrandtlTurbulent_s = "PrandtlTurbulent"
SpecificHeatRatio_s = "SpecificHeatRatio"
SpecificHeatRatio_Pressure_s = "SpecificHeatRatio_Pressure"
SpecificHeatRatio_Volume_s = "SpecificHeatRatio_Volume"
CoefPressure_s = "CoefPressure"
CoefSkinFrictionX_s = "CoefSkinFrictionX"
CoefSkinFrictionY_s = "CoefSkinFrictionY"
CoefSkinFrictionZ_s = "CoefSkinFrictionZ"
Coef_PressureDynamic_s = "Coef_PressureDynamic"
Coef_PressureReference_s = "Coef_PressureReference"
Vorticity_s = "Vorticity"
Acoustic_s = "Acoustic"
RiemannInvariantPlus_s = "RiemannInvariantPlus"
RiemannInvariantMinus_s = "RiemannInvariantMinus"
CharacteristicEntropy_s = "CharacteristicEntropy"
CharacteristicVorticity1_s = "CharacteristicVorticity1"
CharacteristicVorticity2_s = "CharacteristicVorticity2"
CharacteristicAcousticPlus_s = "CharacteristicAcousticPlus"
CharacteristicAcousticMinus_s = "CharacteristicAcousticMinus"
ForceX_s = "ForceX"
ForceY_s = "ForceY"
ForceZ_s = "ForceZ"
ForceR_s = "ForceR"
ForceTheta_s = "ForceTheta"
ForcePhi_s = "ForcePhi"
Lift_s = "Lift"
Drag_s = "Drag"
MomentX_s = "MomentX"
MomentY_s = "MomentY"
MomentZ_s = "MomentZ"
MomentR_s = "MomentR"
MomentTheta_s = "MomentTheta"
MomentPhi_s = "MomentPhi"
MomentXi_s = "MomentXi"
MomentEta_s = "MomentEta"
MomentZeta_s = "MomentZeta"
Moment_CenterX_s = "Moment_CenterX"
Moment_CenterY_s = "Moment_CenterY"
Moment_CenterZ_s = "Moment_CenterZ"
CoefLift_s = "CoefLift"
CoefDrag_s = "CoefDrag"
CoefMomentX_s = "CoefMomentX"
CoefMomentY_s = "CoefMomentY"
CoefMomentZ_s = "CoefMomentZ"
CoefMomentR_s = "CoefMomentR"
CoefMomentTheta_s = "CoefMomentTheta"
CoefMomentPhi_s = "CoefMomentPhi"
CoefMomentXi_s = "CoefMomentXi"
CoefMomentEta_s = "CoefMomentEta"
CoefMomentZeta_s = "CoefMomentZeta"
Coef_PressureDynamic_s = "Coef_PressureDynamic"
Coef_Area_s = "Coef_Area"
Coef_Length_s = "Coef_Length"
TimeValues_s = "TimeValues"
IterationValues_s = "IterationValues"
NumberOfZones_s = "NumberOfZones"
NumberOfFamilies_s = "NumberOfFamilies"
NumberOfSteps_s = "NumberOfSteps"
DataConversion_s = "DataConversion"

ZonePointers_s = "ZonePointers"
FamilyPointers_s = "FamilyPointers"
RigidGridMotionPointers_s = "RigidGridMotionPointers"
ArbitraryGridMotionPointers_s = "ArbitraryGridMotionPointers"
GridCoordinatesPointers_s = "GridCoordinatesPointers"
FlowSolutionPointers_s = "FlowSolutionPointers"
ZoneGridConnectivityPointers_s = "ZoneGridConnectivityPointers"
ZoneSubRegionPointers_s = "ZoneSubRegionPointers"
PointerNames_l = [
    ZonePointers_s,
    FamilyPointers_s,
    RigidGridMotionPointers_s,
    ArbitraryGridMotionPointers_s,
    GridCoordinatesPointers_s,
    FlowSolutionPointers_s,
    ZoneGridConnectivityPointers_s,
    ZoneSubRegionPointers_s,
]

OriginLocation_s = "OriginLocation"
RigidRotationAngle_s = "RigidRotationAngle"
Translation_s = "Translation"
RotationAngle_s = "RotationAngle"
RigidVelocity_s = "RigidVelocity"
RigidRotationRate_s = "RigidRotationRate"
GridVelocityX_s = "GridVelocityX"
GridVelocityY_s = "GridVelocityY"
GridVelocityZ_s = "GridVelocityZ"
GridVelocityR_s = "GridVelocityR"
GridVelocityTheta_s = "GridVelocityTheta"
GridVelocityPhi_s = "GridVelocityPhi"
GridVelocityXi_s = "GridVelocityXi"
GridVelocityEta_s = "GridVelocityEta"
GridVelocityZeta_s = "GridVelocityZeta"

SurfaceArea_s = "SurfaceArea"
RegionName_s = "RegionName"
AverageInterface_ts = "AverageInterface_t"
Axisymmetry_ts = "Axisymmetry_t"
Axisymmetry_s = "Axisymmetry"
AxisymmetryReferencePoint_s = "AxisymmetryReferencePoint"
AxisymmetryAxisVector_s = "AxisymmetryAxisVector"
AxisymmetryAngle_s = "AxisymmetryAngle"
BCDataSet_ts = "BCDataSet_t"
BCData_ts = "BCData_t"
BCData_s = "BCData"

BCProperty_ts = "BCProperty_t"
BCProperty_s = "BCProperty"
BC_ts = "BC_t"

BaseIterativeData_ts = "BaseIterativeData_t"
BaseIterativeData_s = "BaseIterativeData"

CGNSBase_ts = "CGNSBase_t"
CGNSLibraryVersion_ts = "CGNSLibraryVersion_t"

# --------------------------------------------------
ConvergenceHistory_ts = "ConvergenceHistory_t"
ZoneConvergenceHistory_s = "ZoneConvergenceHistory"
GlobalConvergenceHistory_s = "GlobalConvergenceHistory"

ConvergenceHistory_l = [ZoneConvergenceHistory_s, GlobalConvergenceHistory_s]

NormDefinitions_s = "NormDefinitions"

DataArray_ts = "DataArray_t"
DataConversion_ts = "DataConversion_t"
Descriptor_ts = "Descriptor_t"

# --------------------------------------------------
DimensionalExponents_ts = "DimensionalExponents_t"
DimensionalExponents_s = "DimensionalExponents"
DimensionalUnits_ts = "DimensionalUnits_t"
AdditionalUnits_ts = "AdditionalUnits_t"
AdditionalExponents_ts = "AdditionalExponents_t"

DiscreteData_ts = "DiscreteData_t"
DiscreteData_s = "DiscreteData"

FamilyBC_s = "FamilyBC"
FamilyBC_ts = "FamilyBC_t"
FamilyBCDataSet_ts = "FamilyBCDataSet_t"

FamilyName_ts = "FamilyName_t"
FamilyName_s = "FamilyName"
AdditionalFamilyName_ts = "AdditionalFamilyName_t"
AdditionalFamilyName_s = "AdditionalFamilyName"
Family_ts = "Family_t"
Family_s = "Family"
FlowEquationSet_ts = "FlowEquationSet_t"
FlowEquationSet_s = "FlowEquationSet"
FlowSolution_ts = "FlowSolution_t"
GasModel_ts = "GasModel_t"
GasModel_s = "GasModel"

GeometryEntity_ts = "GeometryEntity_t"
GeometryFile_ts = "GeometryFile_t"
GeometryFile_s = "GeometryFile"

GeometryFormat_s = "GeometryFormat"
GeometryFormat_ts = "GeometryFormat_t"

# not supported '-'
NASAIGES_s = "NASA-IGES"
ICEMCFD_s = "ICEM-CFD"

SDRC_s = "SDRC"
Unigraphics_s = "Unigraphics"
ProEngineer_s = "ProEngineer"
GeometryFormat_l = [
    Null_s,
    NASAIGES_s,
    SDRC_s,
    Unigraphics_s,
    ProEngineer_s,
    ICEMCFD_s,
    UserDefined_s,
]
GeometryReference_ts = "GeometryReference_t"
GeometryReference_s = "GeometryReference"

Gravity_ts = "Gravity_t"
Gravity_s = "Gravity"
GravityVector_s = "GravityVector"

GridConnectivity1to1_ts = "GridConnectivity1to1_t"
GridConnectivityProperty_ts = "GridConnectivityProperty_t"
GridConnectivityProperty_s = "GridConnectivityProperty"

GridCoordinates_ts = "GridCoordinates_t"
IndexArray_ts = "IndexArray_t"
IndexRange_ts = "IndexRange_t"
IntegralData_ts = "IntegralData_t"
InwardNormalList_ts = "InwardNormalList_t"
InwardNormalList_s = "InwardNormalList"
InwardNormalIndex_s = "InwardNormalIndex"
Ordinal_ts = "Ordinal_t"
Ordinal_s = "Ordinal"
Transform_s = "Transform"
OversetHoles_ts = "OversetHoles_t"
OversetHoles_s = "OversetHoles"
Periodic_ts = "Periodic_t"
Periodic_s = "Periodic"

ReferenceState_ts = "ReferenceState_t"
ReferenceState_s = "ReferenceState"
ReferenceStateDescription_s = "ReferenceStateDescription"

RigidGridMotion_ts = "RigidGridMotion_t"
RigidGridMotion_s = "RigidGridMotion"

Rind_s = "Rind"
Rind_ts = "Rind_t"

RotatingCoordinates_s = "RotatingCoordinates"
RotatingCoordinates_ts = "RotatingCoordinates_t"
RotationRateVector_s = "RotationRateVector"
RotationCenter_s = "RotationCenter"

GoverningEquations_s = "GoverningEquations"
GoverningEquations_ts = "GoverningEquations_t"

GoverningEquationsType_l = [
    Null_s,
    UserDefined_s,
    FullPotential_s,
    Euler_s,
    NSLaminar_s,
    NSTurbulent_s,
    NSLaminarIncompressible_s,
    NSTurbulentIncompressible_s,
]
GoverningEquationsType_s = "GoverningEquationsType"
GoverningEquationsType_ts = "GoverningEquationsType_t"
GoverningEquationsType = stringAsKeyDict(GoverningEquationsType_l)
GoverningEquationsType_ = enumAsKeyDict(GoverningEquationsType_l)
(
    GoverningEquationsNull,
    GoverningEquationUserDefined,
    FullPotential,
    Euler,
    NSLaminar,
    NSTurbulent,
    NSLaminarIncompressible,
    NSTurbulentIncompressible,
) = list(GoverningEquationsType_)

# --------------------------------------------------
BCType_s = "BCType"
BCType_ts = "BCType_t"
BCTypeSimple_s = "BCTypeSimple"
BCTypeSimple_ts = "BCTypeSimple_t"
BCTypeCompound_s = "BCTypeCompound"
BCTypeCompound_ts = "BCTypeCompound_ts"

BCAxisymmetricWedge_s = "BCAxisymmetricWedge"
BCDegenerateLine_s = "BCDegenerateLine"
BCDegeneratePoint_s = "BCDegeneratePoint"
BCDirichlet_s = "BCDirichlet"
BCExtrapolate_s = "BCExtrapolate"
BCFarfield_s = "BCFarfield"
BCGeneral_s = "BCGeneral"
BCInflow_s = "BCInflow"
BCInflowSubsonic_s = "BCInflowSubsonic"
BCInflowSupersonic_s = "BCInflowSupersonic"
BCNeumann_s = "BCNeumann"
BCOutflow_s = "BCOutflow"
BCOutflowSubsonic_s = "BCOutflowSubsonic"
BCOutflowSupersonic_s = "BCOutflowSupersonic"
BCSymmetryPlane_s = "BCSymmetryPlane"
BCSymmetryPolar_s = "BCSymmetryPolar"
BCTunnelInflow_s = "BCTunnelInflow"
BCTunnelOutflow_s = "BCTunnelOutflow"
BCWall_s = "BCWall"
BCWallInviscid_s = "BCWallInviscid"
BCWallViscous_s = "BCWallViscous"
BCWallViscousHeatFlux_s = "BCWallViscousHeatFlux"
BCWallViscousIsothermal_s = "BCWallViscousIsothermal"

BCType_l = [
    Null_s,
    UserDefined_s,
    BCAxisymmetricWedge_s,
    BCDegenerateLine_s,
    BCDegeneratePoint_s,
    BCDirichlet_s,
    BCExtrapolate_s,
    BCFarfield_s,
    BCGeneral_s,
    BCInflow_s,
    BCInflowSubsonic_s,
    BCInflowSupersonic_s,
    BCNeumann_s,
    BCOutflow_s,
    BCOutflowSubsonic_s,
    BCOutflowSupersonic_s,
    BCSymmetryPlane_s,
    BCSymmetryPolar_s,
    BCTunnelInflow_s,
    BCTunnelOutflow_s,
    BCWall_s,
    BCWallInviscid_s,
    BCWallViscous_s,
    BCWallViscousHeatFlux_s,
    BCWallViscousIsothermal_s,
    FamilySpecified_s,
]
BCType = stringAsKeyDict(BCType_l)
BCType_ = enumAsKeyDict(BCType_l)
(
    Null,
    UserDefined,
    BCAxisymmetricWedge,
    BCDegenerateLine,
    BCDegeneratePoint,
    BCDirichlet,
    BCExtrapolate,
    BCFarfield,
    BCGeneral,
    BCInflow,
    BCInflowSubsonic,
    BCInflowSupersonic,
    BCNeumann,
    BCOutflow,
    BCOutflowSubsonic,
    BCOutflowSupersonic,
    BCSymmetryPlane,
    BCSymmetryPolar,
    BCTunnelInflow,
    BCTunnelOutflow,
    BCWall,
    BCWallInviscid,
    BCWallViscous,
    BCWallViscousHeatFlux,
    BCWallViscousIsothermal,
    FamilySpecified,
) = list(BCType_)

BC_l = BCType_l
BC = BCType
BC_ = BCType_

FamilyBC_l = BCType_l
FamilyBC = BCType
FamilyBC_ = BCType_

# CAUTION, index of values in the lists below cannot be used as enumerate,
# the lists are subset of the global list and some index are missing.
BCTypeSimple_l = [
    Null_s,
    UserDefined_s,
    BCGeneral_s,
    BCDirichlet_s,
    BCNeumann_s,
    BCExtrapolate_s,
    BCWallInviscid_s,
    BCWallViscousHeatFlux_s,
    BCWallViscousIsothermal_s,
    BCWallViscous_s,
    BCWall_s,
    BCInflowSubsonic_s,
    BCInflowSupersonic_s,
    BCOutflowSubsonic_s,
    BCOutflowSupersonic_s,
    BCTunnelInflow_s,
    BCTunnelOutflow_s,
    BCDegenerateLine_s,
    BCDegeneratePoint_s,
    BCSymmetryPlane_s,
    BCSymmetryPolar_s,
    BCAxisymmetricWedge_s,
    FamilySpecified_s,
]
BCTypeCompound_l = [Null_s, UserDefined_s, BCInflow_s, BCOutflow_s, BCFarfield_s]

# --------------------------------------------------
# WARNING -
# - the model sub-list CANNOT be used to define the corresponding enumerate
#   because the new values are add at the end of a global list (ModelType)
#   then the ONLY enumerate to use is the ModelType one which has its own list
#
GasModelType_l = [
    Null_s,
    UserDefined_s,
    Ideal_s,
    VanderWaals_s,
    CaloricallyPerfect_s,
    ThermallyPerfect_s,
    ConstantDensity_s,
    RedlichKwong_s,
]
GasModelType_s = "GasModelType"
GasModelType_ts = "GasModelType_t"
GasModelIdentifier_l = [
    IdealGasConstant_s,
    SpecificHeatRatio_s,
    SpecificHeatVolume_s,
    SpecificHeatPressure_s,
]

ViscosityModel_ts = "ViscosityModel_t"
ViscosityModel_s = "ViscosityModel"
ViscosityModelType_l = [Null_s, UserDefined_s, Constant_s, PowerLaw_s, SutherlandLaw_s]
ViscosityModelType_s = "ViscosityModelType"
ViscosityModelType_ts = "ViscosityModelType_t"
ViscosityModelIdentifier_l = [
    PowerLawExponent_s,
    SutherlandLawConstant_s,
    TemperatureReference_s,
    ViscosityMolecularReference_s,
]

ThermalConductivityModel_ts = "ThermalConductivityModel_t"
ThermalConductivityModel_s = "ThermalConductivityModel"
ThermalConductivityModelType_l = [
    Null_s,
    UserDefined_s,
    ConstantPrandtl_s,
    PowerLaw_s,
    SutherlandLaw_s,
]
ThermalConductivityModelType_s = "ThermalConductivityModelType"
ThermalConductivityModelType_ts = "ThermalConductivityModelType_t"
ThermalConductivityModelIdentifier_l = [
    Prandtl_s,
    PowerLawExponent_s,
    SutherlandLawConstant_s,
    TemperatureReference_s,
    ThermalConductivityReference_s,
]

TurbulenceModel_ts = "TurbulenceModel_t"
TurbulenceModel_s = "TurbulenceModel"
TurbulenceModelType_l = [
    Null_s,
    UserDefined_s,
    Algebraic_BaldwinLomax_s,
    Algebraic_CebeciSmith_s,
    HalfEquation_JohnsonKing_s,
    OneEquation_BaldwinBarth_s,
    OneEquation_SpalartAllmaras_s,
    TwoEquation_JonesLaunder_s,
    TwoEquation_MenterSST_s,
    TwoEquation_Wilcox_s,
]
TurbulenceModelType_s = "TurbulenceModelType"
TurbulenceModelType_ts = "TurbulenceModelType_t"

TurbulenceClosure_ts = "TurbulenceClosure_t"
TurbulenceClosure_s = "TurbulenceClosure"
TurbulenceClosureType_l = [
    Null_s,
    UserDefined_s,
    EddyViscosity_s,
    ReynoldsStress_s,
    ReynoldsStressAlgebraic_s,
]
TurbulenceClosureType_s = "TurbulenceClosureType"
TurbulenceClosureType_ts = "TurbulenceClosureType_t"
TurbulenceClosureIdentifier_l = [PrandtlTurbulent_s]

ThermalRelaxationModel_ts = "ThermalRelaxationModel_t"
ThermalRelaxationModel_s = "ThermalRelaxationModel"
ThermalRelaxationModelType_l = [
    Null_s,
    UserDefined_s,
    Frozen_s,
    ThermalEquilib_s,
    ThermalNonequilib_s,
]
ThermalRelaxationModelType_s = "ThermalRelaxationModelType"
ThermalRelaxationModelType_ts = "ThermalRelaxationModelType_t"

ChemicalKineticsModel_ts = "ChemicalKineticsModel_t"
ChemicalKineticsModel_s = "ChemicalKineticsModel"
ChemicalKineticsModelType_l = [
    Null_s,
    UserDefined_s,
    Frozen_s,
    ChemicalEquilibCurveFit_s,
    ChemicalEquilibMinimization_s,
    ChemicalNonequilib_s,
]
ChemicalKineticsModelType_s = "ChemicalKineticsModelType"
ChemicalKineticsModelType_ts = "ChemicalKineticsModelType_t"
ChemicalKineticsModelIdentifier_l = [FuelAirRatio_s, ReferenceTemperatureHOF_s]

EMElectricFieldModel_s = "EMElectricFieldModel"
EMElectricFieldModel_ts = "EMElectricFieldModel_t"
EMElectricFieldModelType_l = [
    Null_s,
    UserDefined_s,
    Constant_s,
    Frozen_s,
    Interpolated_s,
    Voltage_s,
]
EMElectricFieldModelType_s = "EMElectricFieldModelType"
EMElectricFieldModelType_ts = "EMElectricFieldModelType_t"

EMMagneticFieldModel_s = "EMMagneticFieldModel"
EMMagneticFieldModel_ts = "EMMagneticFieldModel_t"
EMMagneticFieldModelType_l = [
    Null_s,
    UserDefined_s,
    Constant_s,
    Frozen_s,
    Interpolated_s,
]
EMMagneticFieldModelType_s = "EMMagneticFieldModelType"
EMMagneticFieldModelType_ts = "EMMagneticFieldModelType_t"

EMConductivityModel_s = "EMConductivityModel"
EMConductivityModel_ts = "EMConductivityModel_t"
EMConductivityModelType_l = [
    Null_s,
    UserDefined_s,
    Constant_s,
    Frozen_s,
    Equilibrium_LinRessler_s,
    Chemistry_LinRessler_s,
]
EMConductivityModelType_s = "EMConductivityModelType"
EMConductivityModelType_ts = "EMConductivityModelType_t"
EMConductivityModelIdentifier_l = [
    Null_s,
    UserDefined_s,
    ElectricFieldX_s,
    ElectricFieldY_s,
    ElectricFieldZ_s,
    MagneticFieldX_s,
    MagneticFieldY_s,
    MagneticFieldZ_s,
    CurrentDensityX_s,
    CurrentDensityY_s,
    CurrentDensityZ_s,
    ElectricConductivity_s,
    LorentzForceX_s,
    LorentzForceY_s,
    LorentzForceZ_s,
    JouleHeating_s,
]

ModelType_l = [
    Null_s,
    UserDefined_s,
    Ideal_s,
    VanderWaals_s,
    Constant_s,
    PowerLaw_s,
    SutherlandLaw_s,
    ConstantPrandtl_s,
    EddyViscosity_s,
    ReynoldsStress_s,
    ReynoldsStressAlgebraic_s,
    Algebraic_BaldwinLomax_s,
    Algebraic_CebeciSmith_s,
    HalfEquation_JohnsonKing_s,
    OneEquation_BaldwinBarth_s,
    OneEquation_SpalartAllmaras_s,
    TwoEquation_JonesLaunder_s,
    TwoEquation_MenterSST_s,
    TwoEquation_Wilcox_s,
    CaloricallyPerfect_s,
    ThermallyPerfect_s,
    ConstantDensity_s,
    RedlichKwong_s,
    Frozen_s,
    ThermalEquilib_s,
    ThermalNonequilib_s,
    ChemicalEquilibCurveFit_s,
    ChemicalEquilibMinimization_s,
    ChemicalNonequilib_s,
    EMElectricField_s,
    EMMagneticField_s,
    EMConductivity_s,
    Voltage_s,
    Interpolated_s,
    Equilibrium_LinRessler_s,
    Chemistry_LinRessler_s,
]
ModelType = stringAsKeyDict(ModelType_l)
ModelType_ = enumAsKeyDict(ModelType_l)
(
    Null,
    UserDefined,
    Ideal,
    VanderWaals,
    Constant,
    PowerLaw,
    SutherlandLaw,
    ConstantPrandtl,
    EddyViscosity,
    ReynoldsStress,
    ReynoldsStressAlgebraic,
    Algebraic_BaldwinLomax,
    Algebraic_CebeciSmith,
    HalfEquation_JohnsonKing,
    OneEquation_BaldwinBarth,
    OneEquationpalartAllmaras,
    TwoEquation_JonesLaunder,
    TwoEquation_MenterSST,
    TwoEquation_Wilcox,
    CaloricallyPerfect,
    ThermallyPerfect,
    ConstantDensity,
    RedlichKwong,
    Frozen,
    ThermalEquilib,
    ThermalNonequilib,
    ChemicalEquilibCurveFit,
    ChemicalEquilibMinimization,
    ChemicalNonequilib,
    EMElectricField,
    EMMagneticField,
    EMConductivity,
    Voltage,
    Interpolated,
    Equilibrium_LinRessler,
    Chemistry_LinRessler,
) = list(ModelType_)

DiffusionModel_s = "DiffusionModel"
EquationDimension_s = "EquationDimension"

# --------------------------------------------------

AverageInterfaceType_s = "AverageInterfaceType"
AverageInterfaceType_ts = "AverageInterfaceType_t"
AverageInterfaceType_l = [
    Null_s,
    UserDefined_s,
    AverageAll_s,
    AverageCircumferential_s,
    AverageRadial_s,
    AverageI_s,
    AverageJ_s,
    AverageK_s,
]

AverageInterfaceType = stringAsKeyDict(AverageInterfaceType_l)
AverageInterfaceType_ = enumAsKeyDict(AverageInterfaceType_l)
(
    Null,
    UserDefined,
    AverageAll,
    AverageCircumferential,
    AverageRadial,
    AverageI,
    AverageJ,
    AverageK,
) = list(AverageInterfaceType_)

AverageInterface_s = "AverageInterface"
AverageInterface_ts = "AverageInterface_t"

NODE_s = "NODE"
BAR_2_s = "BAR_2"
BAR_3_s = "BAR_3"
TRI_3_s = "TRI_3"
TRI_6_s = "TRI_6"
QUAD_4_s = "QUAD_4"
QUAD_8_s = "QUAD_8"
QUAD_9_s = "QUAD_9"
TETRA_4_s = "TETRA_4"
TETRA_10_s = "TETRA_10"
PYRA_5_s = "PYRA_5"
PYRA_14_s = "PYRA_14"
PENTA_6_s = "PENTA_6"
PENTA_15_s = "PENTA_15"
PENTA_18_s = "PENTA_18"
HEXA_8_s = "HEXA_8"
HEXA_20_s = "HEXA_20"
HEXA_27_s = "HEXA_27"
MIXED_s = "MIXED"
PYRA_13_s = "PYRA_13"
NGON_n_s = "NGON_n"
NFACE_n_s = "NFACE_n"
BAR_4_s = "BAR_4"
TRI_9_s = "TRI_9"
TRI_10_s = "TRI_10"
QUAD_12_s = "QUAD_12"
QUAD_16_s = "QUAD_16"
TETRA_16_s = "TETRA_16"
TETRA_20_s = "TETRA_20"
PYRA_21_s = "PYRA_21"
PYRA_29_s = "PYRA_29"
PYRA_30_s = "PYRA_30"
PENTA_24_s = "PENTA_24"
PENTA_38_s = "PENTA_38"
PENTA_40_s = "PENTA_40"
HEXA_32_s = "HEXA_32"
HEXA_56_s = "HEXA_56"
HEXA_64_s = "HEXA_64"
BAR_5_s = "BAR_5"
TRI_12_s = "TRI_12"
TRI_15_s = "TRI_15"
QUAD_P4_16_s = "QUAD_P4_16"
QUAD_25_s = "QUAD_25"
TETRA_22_s = "TETRA_22"
TETRA_34_s = "TETRA_34"
TETRA_35_s = "TETRA_35"
PYRA_P4_29_s = "PYRA_P4_29"
PYRA_50_s = "PYRA_50"
PYRA_55_s = "PYRA_55"
PENTA_33_s = "PENTA_33"
PENTA_66_s = "PENTA_66"
PENTA_75_s = "PENTA_75"
HEXA_44_s = "HEXA_44"
HEXA_98_s = "HEXA_98"
HEXA_125_s = "HEXA_125"

# ORDER *IS* SIGNIFICANT

Null_npe = 0
UserDefined_npe = 0
NODE_npe = 1
BAR_2_npe = 2
BAR_3_npe = 3
TRI_3_npe = 3
TRI_6_npe = 6
QUAD_4_npe = 4
QUAD_8_npe = 8
QUAD_9_npe = 9
TETRA_4_npe = 4
TETRA_10_npe = 10
PYRA_5_npe = 5
PYRA_14_npe = 14
PENTA_6_npe = 6
PENTA_15_npe = 15
PENTA_18_npe = 18
HEXA_8_npe = 8
HEXA_20_npe = 20
HEXA_27_npe = 27
MIXED_npe = 0
PYRA_13_npe = 13
NGON_n_npe = 0
NFACE_n_npe = 0
BAR_4_npe = 4
TRI_9_npe = 9
TRI_10_npe = 10
QUAD_12_npe = 12
QUAD_16_npe = 16
TETRA_16_npe = 16
TETRA_20_npe = 20
PYRA_21_npe = 21
PYRA_29_npe = 29
PYRA_30_npe = 30
PENTA_24_npe = 24
PENTA_38_npe = 38
PENTA_40_npe = 40
HEXA_32_npe = 32
HEXA_56_npe = 56
HEXA_64_npe = 64
BAR_5_npe = 40
TRI_12_npe = 41
TRI_15_npe = 42
QUAD_P4_16_npe = 43
QUAD_25_npe = 44
TETRA_22_npe = 45
TETRA_34_npe = 46
TETRA_35_npe = 47
PYRA_P4_29_npe = 48
PYRA_50_npe = 49
PYRA_55_npe = 50
PENTA_33_npe = 51
PENTA_66_npe = 52
PENTA_75_npe = 53
HEXA_44_npe = 54
HEXA_98_npe = 55
HEXA_125_npe = 56

Elements_ts = "Elements_t"
ElementType_ts = "ElementType_t"
ElementType_s = "ElementType"
Elements_s = "Elements"
ElementType_l = [
    Null_s,
    UserDefined_s,
    NODE_s,
    BAR_2_s,
    BAR_3_s,
    TRI_3_s,
    TRI_6_s,
    QUAD_4_s,
    QUAD_8_s,
    QUAD_9_s,
    TETRA_4_s,
    TETRA_10_s,
    PYRA_5_s,
    PYRA_14_s,
    PENTA_6_s,
    PENTA_15_s,
    PENTA_18_s,
    HEXA_8_s,
    HEXA_20_s,
    HEXA_27_s,
    MIXED_s,
    PYRA_13_s,
    NGON_n_s,
    NFACE_n_s,
    BAR_4_s,
    TRI_9_s,
    TRI_10_s,
    QUAD_12_s,
    QUAD_16_s,
    TETRA_16_s,
    TETRA_20_s,
    PYRA_21_s,
    PYRA_29_s,
    PYRA_30_s,
    PENTA_24_s,
    PENTA_38_s,
    PENTA_40_s,
    HEXA_32_s,
    HEXA_56_s,
    HEXA_64_s,
    BAR_5_s,
    TRI_12_s,
    TRI_15_s,
    QUAD_P4_16_s,
    QUAD_25_s,
    TETRA_22_s,
    TETRA_34_s,
    TETRA_35_s,
    PYRA_P4_29_s,
    PYRA_50_s,
    PYRA_55_s,
    PENTA_33_s,
    PENTA_66_s,
    PENTA_75_s,
    HEXA_44_s,
    HEXA_98_s,
    HEXA_125_s,
]
ElementTypeNPE_l = [
    Null_npe,
    UserDefined_npe,
    NODE_npe,
    BAR_2_npe,
    BAR_3_npe,
    TRI_3_npe,
    TRI_6_npe,
    QUAD_4_npe,
    QUAD_8_npe,
    QUAD_9_npe,
    TETRA_4_npe,
    TETRA_10_npe,
    PYRA_5_npe,
    PYRA_14_npe,
    PENTA_6_npe,
    PENTA_15_npe,
    PENTA_18_npe,
    HEXA_8_npe,
    HEXA_20_npe,
    HEXA_27_npe,
    MIXED_npe,
    PYRA_13_npe,
    NGON_n_npe,
    NFACE_n_npe,
    BAR_4_npe,
    TRI_9_npe,
    TRI_10_npe,
    QUAD_12_npe,
    QUAD_16_npe,
    TETRA_16_npe,
    TETRA_20_npe,
    PYRA_21_npe,
    PYRA_29_npe,
    PYRA_30_npe,
    PENTA_24_npe,
    PENTA_38_npe,
    PENTA_40_npe,
    HEXA_32_npe,
    HEXA_56_npe,
    HEXA_64_npe,
    BAR_5_npe,
    TRI_12_npe,
    TRI_15_npe,
    QUAD_P4_16_npe,
    QUAD_25_npe,
    TETRA_22_npe,
    TETRA_34_npe,
    TETRA_35_npe,
    PYRA_P4_29_npe,
    PYRA_50_npe,
    PYRA_55_npe,
    PENTA_33_npe,
    PENTA_66_npe,
    PENTA_75_npe,
    HEXA_44_npe,
    HEXA_98_npe,
    HEXA_125_npe,
]
ElementType = stringAsKeyDict(ElementType_l)
ElementType_ = enumAsKeyDict(ElementType_l)
ElementTypeNPE = dict(zip(ElementType_l, ElementTypeNPE_l))
(
    Null,
    UserDefined,
    NODE,
    BAR_2,
    BAR_3,
    TRI_3,
    TRI_6,
    QUAD_4,
    QUAD_8,
    QUAD_9,
    TETRA_4,
    TETRA_10,
    PYRA_5,
    PYRA_14,
    PENTA_6,
    PENTA_15,
    PENTA_18,
    HEXA_8,
    HEXA_20,
    HEXA_27,
    MIXED,
    PYRA_13,
    NGON_n,
    NFACE_n,
    BAR_4,
    TRI_9,
    TRI_10,
    QUAD_12,
    QUAD_16,
    TETRA_16,
    TETRA_20,
    PYRA_21,
    PYRA_29,
    PYRA_30,
    PENTA_24,
    PENTA_38,
    PENTA_40,
    HEXA_32,
    HEXA_56,
    HEXA_64,
    BAR_5,
    TRI_12,
    TRI_15,
    QUAD_P4_16,
    QUAD_25,
    TETRA_22,
    TETRA_34,
    TETRA_35,
    PYRA_P4_29,
    PYRA_50,
    PYRA_55,
    PENTA_33,
    PENTA_66,
    PENTA_75,
    HEXA_44,
    HEXA_98,
    HEXA_125,
) = list(ElementType_)

ElementType3D = [
    TETRA_4,
    TETRA_10,
    PYRA_5,
    PYRA_14,
    PENTA_6,
    PENTA_15,
    PENTA_18,
    HEXA_8,
    HEXA_20,
    HEXA_27,
    MIXED,
    PYRA_13,
    TETRA_16,
    TETRA_20,
    PYRA_21,
    PYRA_29,
    PYRA_30,
    PENTA_24,
    PENTA_38,
    PENTA_40,
    HEXA_32,
    HEXA_56,
    HEXA_64,
    TETRA_22,
    TETRA_34,
    TETRA_35,
    PYRA_P4_29,
    PYRA_50,
    PYRA_55,
    PENTA_33,
    PENTA_66,
    PENTA_75,
    HEXA_44,
    HEXA_98,
    HEXA_125,
]
ElementType2D = [
    TRI_3,
    TRI_6,
    QUAD_4,
    QUAD_8,
    QUAD_9,
    TRI_9,
    TRI_10,
    QUAD_12,
    QUAD_16,
    TRI_12,
    TRI_15,
    QUAD_P4_16,
    QUAD_25,
]
ElementType1D = [BAR_2, BAR_3, BAR_4, BAR_5]
ElementType0D = [NODE]
ElementType_tri = [TRI_3, TRI_6, TRI_9, TRI_10, TRI_12, TRI_15]
ElementType_quad = [QUAD_4, QUAD_8, QUAD_9, QUAD_12, QUAD_16, QUAD_P4_16, QUAD_25]
ElementType_tetra = [
    TETRA_4,
    TETRA_10,
    TETRA_16,
    TETRA_20,
    TETRA_22,
    TETRA_34,
    TETRA_35,
]
ElementType_pyra = [
    PYRA_5,
    PYRA_13,
    PYRA_21,
    PYRA_29,
    PYRA_30,
    PYRA_P4_29,
    PYRA_50,
    PYRA_55,
]
ElementType_penta = [
    PENTA_6,
    PENTA_15,
    PENTA_18,
    PENTA_24,
    PENTA_38,
    PENTA_40,
    PENTA_33,
    PENTA_66,
    PENTA_75,
]
ElementType_hexa = [
    HEXA_8,
    HEXA_20,
    HEXA_27,
    HEXA_32,
    HEXA_56,
    HEXA_64,
    HEXA_44,
    HEXA_98,
    HEXA_125,
]
ElementType_trionly = ElementType_tetra
ElementType_quadonly = ElementType_hexa
ElementType_triquad = ElementType_pyra + ElementType_penta

ElementRangeList_s = "ElementRangeList"
#

# ---
cgnsnames = [globals()[k] for k in dir() if (k[-2:] == "_s")]
cgnstypes = [globals()[k] for k in dir() if (k[-3:] == "_ts")] + list(weirdSIDStypes)
cgnsenums = {
    GoverningEquations_ts: GoverningEquationsType_l,
    GasModel_ts: GasModelType_l,
    GasModelType_ts: GasModelIdentifier_l,
    TurbulenceModel_ts: TurbulenceModelType_l,
    ViscosityModel_ts: ViscosityModelType_l,
    ViscosityModelType_ts: ViscosityModelIdentifier_l,
    ThermalConductivityModel_ts: ThermalConductivityModelType_l,
    ThermalConductivityModelType_ts: ThermalConductivityModelIdentifier_l,
    ThermalRelaxationModel_ts: ThermalRelaxationModelType_l,
    ChemicalKineticsModel_ts: ChemicalKineticsModelType_l,
    ChemicalKineticsModelType_ts: ChemicalKineticsModelIdentifier_l,
    EMElectricFieldModel_ts: EMElectricFieldModelType_l,
    EMMagneticFieldModel_ts: EMMagneticFieldModelType_l,
    EMConductivityModel_ts: EMConductivityModelType_l,
    EMConductivityModelType_ts: EMConductivityModelIdentifier_l,
}
for k in dir():
    if k[-2:] == "_l":
        cgnsenums[k[:-1] + "t"] = locals()[k]
#
cgnsnames.sort()
cgnstypes.sort()
#
# Compatibility
# - some constants have no integer/string correspondance, the legacy wrapper
#   had its own defines, try to set them as long as it doens't collide with
#   existing constants.
#
CoordinateX = CoordinateX_s
CoordinateY = CoordinateY_s
CoordinateZ = CoordinateZ_s
CoefLift = CoefLift_s
Density = Density_s

Zone_t = Zone_ts
ReferenceState_t = ReferenceState_ts
FlowEquationSet_t = FlowEquationSet_ts
GoverningEquations_t = GoverningEquations_ts
GasModel_t = GasModel_ts
ViscosityModel_t = ViscosityModel_ts
TurbulenceModel_t = TurbulenceModel_ts
UserDefinedData_t = UserDefinedData_ts
FlowSolution_t = FlowSolution_ts
DataArray_t = DataArray_ts
Family_t = Family_ts
DiscreteData_t = DiscreteData_ts
RigidGridMotion_t = RigidGridMotion_ts

# sorted type list, for CGNS.NAV use or any CGNS/SIDS doc related order
sortedtypelist = [
    CGNSTree_ts,
    Family_ts,
    FamilyName_ts,
    AdditionalFamilyName_ts,
    CGNSBase_ts,
    Zone_ts,
    ZoneType_ts,
    GridCoordinates_ts,
    Elements_ts,
    ZoneBC_ts,
    AdditionalExponents_ts,
    AdditionalUnits_ts,
    ArbitraryGridMotionType_ts,
    ArbitraryGridMotion_ts,
    AreaType_ts,
    Area_ts,
    AverageInterfaceType_ts,
    AverageInterface_ts,
    Axisymmetry_ts,
    BCDataSet_ts,
    BCData_ts,
    BCProperty_ts,
    BCTypeSimple_ts,
    BCType_ts,
    BC_ts,
    BaseIterativeData_ts,
    ChemicalKineticsModelType_ts,
    ChemicalKineticsModel_ts,
    ConvergenceHistory_ts,
    DataArray_ts,
    DataClass_ts,
    DataConversion_ts,
    DataType_ts,
    Descriptor_ts,
    DiffusionModel_ts,
    DimensionalExponents_ts,
    DimensionalUnits_ts,
    DiscreteData_ts,
    EMConductivityModelType_ts,
    EMConductivityModel_ts,
    EMElectricFieldModelType_ts,
    EMElectricFieldModel_ts,
    EMMagneticFieldModelType_ts,
    EMMagneticFieldModel_ts,
    ElementType_ts,
    EquationDimension_ts,
    FamilyBC_ts,
    FlowEquationSet_ts,
    FlowSolution_ts,
    GasModelType_ts,
    GasModel_ts,
    GeometryEntity_ts,
    GeometryFile_ts,
    GeometryFormat_ts,
    GeometryReference_ts,
    GoverningEquationsType_ts,
    GoverningEquations_ts,
    Gravity_ts,
    GridConnectivity1to1_ts,
    GridConnectivityProperty_ts,
    GridConnectivityType_ts,
    GridConnectivity_ts,
    GridLocation_ts,
    IndexArray_ts,
    IndexRange_ts,
    IntegralData_ts,
    InwardNormalIndex_ts,
    InwardNormalList_ts,
    Ordinal_ts,
    OversetHoles_ts,
    Periodic_ts,
    ReferenceState_ts,
    RigidGridMotionType_ts,
    RigidGridMotion_ts,
    Rind_ts,
    RotatingCoordinates_ts,
    SimulationType_ts,
    ThermalConductivityModelType_ts,
    ThermalConductivityModel_ts,
    ThermalRelaxationModelType_ts,
    ThermalRelaxationModel_ts,
    Transform_ts,
    TurbulenceClosureType_ts,
    TurbulenceClosure_ts,
    TurbulenceModelType_ts,
    TurbulenceModel_ts,
    UserDefinedData_ts,
    ViscosityModelType_ts,
    ViscosityModel_ts,
    WallFunctionType_ts,
    WallFunction_ts,
    ZoneGridConnectivity_ts,
    ZoneIterativeData_ts,
    CGNSLibraryVersion_ts,
]


#
# --- last line

CGNS Types

• “int”
• “int[1+…+IndexDimension]”
• “int[IndexDimension]”
• AdditionalExponents_t
• AdditionalFamilyName_t
• AdditionalUnits_t
• ArbitraryGridMotionType_t
• ArbitraryGridMotion_t
• AreaType_t
• Area_t
• AverageInterfaceType_t
• AverageInterface_t
• Axisymmetry_t
• BCDataSet_t
• BCData_t
• BCProperty_t
• BC_t
• BaseIterativeData_t
• CGNSBase_t
• CGNSLibraryVersion_t
• CGNSTree_t
• ChemicalKineticsModel_t
• ConvergenceHistory_t
• DataArray_t
• DataClass_t
• DataConversion_t
• Descriptor_t
• DiffusionModel_t
• DimensionalExponents_t
• DimensionalUnits_t
• DiscreteData_t
• EMConductivityModel_t
• EMElectricFieldModel_t
• EMMagneticFieldModel_t
• Elements_t
• EquationDimension_t
• FamilyBC_t
• FamilyName_t
• Family_t
• FlowEquationSet_t
• FlowSolution_t
• GasModel_t
• GeometryEntity_t
• GeometryFile_t
• GeometryFormat_t
• GeometryReference_t
• GoverningEquations_t
• Gravity_t
• GridConnectivity1to1_t
• GridConnectivityProperty_t
• GridConnectivityType_t
• GridConnectivity_t
• GridCoordinates_t
• GridLocation_t
• IndexArray_t
• IndexRange_t
• IntegralData_t
• InwardNormalIndex_t
• Ordinal_t
• OversetHoles_t
• Periodic_t
• ReferenceState_t
• RigidGridMotionType_t
• RigidGridMotion_t
• Rind_t
• RotatingCoordinates_t
• SimulationType_t
• ThermalConductivityModel_t
• ThermalRelaxationModel_t
• Transform_t
• TurbulenceClosure_t
• TurbulenceModel_t
• UserDefinedData_t
• ViscosityModel_t
• WallFunctionType_t
• WallFunction_t
• ZoneBC_t
• ZoneGridConnectivity_t
• ZoneIterativeData_t
• ZoneSubRegion_t
• ZoneType_t
• Zone_t

Error codes and functions

The errors are managed using exceptions. The base class is cgnsException, the derived classes are in the list below, for each class you can have several error codes. For example you can catch cgnsNameError and have a more detailled error diagnostic with the error code:

try:
  CGU.checkName('.')
except CGE.cgnsNameError:
  # skip exception
  # a cgnsNameError is a cgnsException
  pass

try:
  CGU.checkName('zapzap/s')
except CGE.cgnsException,why:
  # get message and print it
  # actually 'why' is the exception object but print calls its __str__
  print why

try:
  CGU.checkName('')
except CGE.cgnsNameError,exc:
  # a cgnsException has a 'code' attribute (the integer error code)
  # a 'value' attribute with a tuple of arguments set at raise time
  # a cgnsNameError is a cgnsException
  if (exc.code==21): print 'Cannot find node ',exc.value

cgnsNameError

code	Message
21	No node with name [%s]
22	Node name should have type string
23	Empty string is not allowed for a node name
24	Node name should not contain a ‘/’
25	Node name length should not be greater than 32 chars
102	Duplicated child name [%s] in [%s]

cgnsNodeError

code	Message
1	Node is empty !
2	Node should be a list of <name, value, children, type>
3	Node name should be a string
4	Node [%s] children list should be a list
5	Node [%s] bad value: should be a numpy object

cgnsTypeError

code	Message
103	Node type of [%s] not [%s]
104	Node type of [%s] not in %s

cgnsValueError

code	Message
000

---

Glossary

cgns.org

The official CGNS web site, by extension any document on this web site has an official taste…

CGNS

The specific purpose of the CFD General Notation System (CGNS) project is to provide a standard for recording and recovering computer data associated with the numerical solution of the equations of fluid dynamics. See also the How to?.

CGNS/SIDS

The Standard Interface Data Structure is the specification of the data model. This public document describes the syntax and the semantics of all tree-structured data required or proposed for a CFD simulation.

CGNS/MLL

The Mid-Level Library is an example implementation of CGNS/SIDS on top of CGNS/ADF and CGNS/HDF5 mappings. This library has a C and a Fortran API.

CGNS/ADF

The Advanced Data Format *CGNS/SIDS* implementation. A binary storage format and its companion library, developped by Boeing.

CGNS/HDF5

The Hierarchical Data Format *CGNS/SIDS* implementation. A binary storage format and its companion library (see below).

CGNS/Python

The Python programming language *CGNS/SIDS* implementation.

CHLone

A CGNS/HDF5 compliant implementation. The CHLone library is available on SourceForge.

HDF5

A powerful storage system for large data. The HDF5 library should be seen as a middleware system with a lot of powerful features related to efficient, portable and trustable storage mean.

python

An object oriented interpreted programming language.

cython

A compiler tool that translate Python/Numpy into C code for performance purpose.

numpy

The numerical library for Python. Numpy is used to store the data in Python arrays which have a direct memory mapping to actual C or Fortran memory.

VTK

A visualization toolkit used to display 3D objects in CGNS.NAV.

PySide

The Python interface for the Qt toolkit. PySide

Qt

A powerful graphical toolkit available under GPL v3, LGPL v2 and a commercial license. The current use of Qt is under LGPL v2 in pyCGNS.

PAT Index

• Index