paraview.simple.CGNSWriter(*input, **params)

The CGNS writer writes files stored in CGNS format. The file extension is .cgns. The input of this reader is a structured grid, polygon data, unstructured grid or a multi-block dataset containing these data types.

Data Descriptors


Select the cell data arrays to pass through.


Explicitly choose which arrays to write.


Select the edge data arrays to pass through.


Select the field data arrays to pass through.


The name of the file to be written.


The suffix to append to the file name when writing files at different timesteps. (File extensions such as .csv should be excluded.) The % format specifiers are used. For example, _%d will write files as FileName_0, FileName_1, FileName_2, etc., and _%.3d will write files as FileName_000, FileName_001, FileName_002 etc.


The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter and CGNSWriter) may not support writing ghost levels.


The input filter/source whose output dataset is written to the file.


Select the point data arrays to pass through.


Select the row data arrays to pass through.


When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format. When turned OFF, the file will use ADF as the underlying file format. HDF5 is preferred and default.


Select the vertex data arrays to pass through.


When WriteAllTimeSteps is turned ON, the writer is executed once for each time step available from the reader.

Data Descriptors inherited from Proxy


dictionary for instance variables (if defined)


list of weak references to the object (if defined)


Initialize = aInitialize(self, connection=None, update=True)

Methods inherited from SourceProxy


Called when the filename of a source proxy is changed.


Returns the associated cell data information.

GetDataInformation(self, idx=None)

This method returns a DataInformation wrapper around a vtkPVDataInformation


Returns the associated cell data information.


Returns the associated point data information.

UpdatePipeline(self, time=None)

This method updates the server-side VTK pipeline and the associated data information. Make sure to update a source to validate the output meta-data.


This method updates the meta-data of the server-side VTK pipeline and the associated information properties

__getitem__(self, idx)

Given a slice, int or string, returns the corresponding output port

Methods inherited from Proxy

GetProperty(self, name)

Given a property name, returns the property object.

GetPropertyValue(self, name)

Returns a scalar for properties with 1 elements, the property itself for vectors.

InitializeFromProxy(self, aProxy, update=True)

Constructor. Assigns proxy to self.SMProxy, updates the server object as well as register the proxy in _pyproxies dictionary.


Returns a list of all property names on this proxy.

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.


Destructor. Cleans up all observers as well as remove the proxy from the _pyproxies dictionary

__eq__(self, other)

Returns true if the underlying SMProxies are the same.

__getattr__(self, name)

With the exception of a few overloaded methods, returns the SMProxy method


Return hash(self).

__init__(self, **args)

Default constructor. It can be used to initialize properties by passing keyword arguments where the key is the name of the property. In addition registrationGroup and registrationName (optional) can be specified (as keyword arguments) to automatically register the proxy with the proxy manager.


Creates an iterator for the properties.

__ne__(self, other)

Returns false if the underlying SMProxies are the same.

__setattr__(self, name, value)

Implement setattr(self, name, value).

add_attribute(self, name, value)

For the full list of servermanager proxies, please refer to Available readers, sources, writers, filters and animation cues