paraview.simple.OpenFOAMReader

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

The OpenFOAM reader

reads OpenFOAM data files and outputs multiblock datasets. Mesh information and time dependent data are supported. This is a distributed reader. See https://www.openfoam.com/documentation/user-guide for a description of the OpenFOAM format.

Data Descriptors

Adddimensionalunitstoarraynames

Read dimensional units from field data and add them to array names as human-readable string.

Cachemesh

Cache the OpenFOAM mesh between GUI selection changes.

CaseType

The property indicates whether decomposed mesh or reconstructed mesh should be read

CellArrays

Copydatatocellzones

Copy data of internal mesh to the cell zones

Createcelltopointfiltereddata

Create point data from cell data. Beware: the filter does not do inverse distance weighting.

FileName

This property specifies the file name for the reader.

LabelSize

The expected label-size for the OpenFOAM data.

LagrangianArrays

Lagrangianpositionswithoutextradata

Lagrangian positions without extra data (before OpenFOAM 1.4, after 2.4)

ListtimestepsaccordingtocontrolDict

List time directories listed according to the settings in controlDict.

MeshRegions

PointArrays

Readzones

Read point/face/cell-Zones?

Refresh

Refresh time information and selection list metadata. Useful when watching a running simulation.

ScalarSize

The expected scalar-size for the OpenFOAM data.

SkipZeroTime

Ignore the 0/ time directory.

TimestepValues

WeightPointDataByCellSize

Use cell size as weight in cell data-to-point data procedure.

Data Descriptors inherited from Proxy

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Methods

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

Methods inherited from SourceProxy

FileNameChanged(self)

Called when the filename of a source proxy is changed.

GetCellDataInformation(self)

Returns the associated cell data information.

GetDataInformation(self, idx=None)

This method returns a DataInformation wrapper around a vtkPVDataInformation

GetFieldDataInformation(self)

Returns the associated cell data information.

GetPointDataInformation(self)

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.

UpdatePipelineInformation(self)

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.

ListProperties(self)

Returns a list of all property names on this proxy.

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.

__del__(self)

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

__hash__(self)

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.

__iter__(self)

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