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.

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 ni 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