pyvista.CGNSReader#

class CGNSReader(*args, **kwargs)[source]#

CGNS Reader for .cgns files.

Creates a multi-block dataset and reads unstructured grids and structured meshes from binary files stored in CGNS file format, with data stored at the nodes, cells or faces.

By default, all point and cell arrays are loaded as well as the boundary patch. This varies from VTK’s defaults. For more details, see vtkCGNSReader

Examples

Load a CGNS file. All arrays are loaded by default.

>>> import pyvista
>>> from pyvista import examples
>>> filename = examples.download_cgns_multi(load=False)
>>> reader = pyvista.CGNSReader(filename)
>>> reader.load_boundary_patch = False
>>> ds = reader.read()
>>> ds[0][0].cell_data
pyvista DataSetAttributes
Association     : CELL
Active Scalars  : None
Active Vectors  : Momentum
Active Texture  : None
Active Normals  : None
Contains arrays :
    Density                 float64    (2928,)
    Momentum                float64    (2928, 3)            VECTORS
    EnergyStagnationDensity float64    (2928,)
    ViscosityEddy           float64    (2928,)
    TurbulentDistance       float64    (2928,)
    TurbulentSANuTilde      float64    (2928,)

Methods

`CGNSReader.base_array_status`(name)	Get status of base array with name.
`CGNSReader.disable_all_bases`()	Disable reading all bases.
`CGNSReader.disable_all_families`()	Disable reading all families.
`CGNSReader.enable_all_bases`()	Enable reading all bases.
`CGNSReader.enable_all_families`()	Enable reading all families.
`CGNSReader.family_array_status`(name)	Get status of family array with name.

Attributes

`CGNSReader.base_array_names`	Return the list of all base array names.
`CGNSReader.distribute_blocks`	Distribute each block in each zone across ranks.
`CGNSReader.family_array_names`	Return the list of all family array names.
`CGNSReader.load_boundary_patch`	Return or set loading boundary patches.
`CGNSReader.number_base_arrays`	Return the number of base arrays.
`CGNSReader.number_family_arrays`	Return the number of face arrays.
`CGNSReader.unsteady_pattern`	Return or set using an unsteady pattern.
`CGNSReader.vector_3d`	Return or set adding an empty dimension to vectors in case of 2D solutions.