pyvista.MultiBlockPlot3DReader.add_function

pyvista.MultiBlockPlot3DReader.add_function#

MultiBlockPlot3DReader.add_function(
value: int | Plot3DFunctionEnum,
) None[source]#

Specify additional functions to compute.

The available functions are enumerated in Plot3DFunctionEnum. The members of this enumeration are most easily accessed by their aliases as class variables.

Multiple functions may be requested by calling this method multiple times.

Parameters:
valueint | Plot3DFunctionEnum

The function to add.

Examples

>>> import pyvista as pv
>>> from pyvista import examples
>>> filename = examples.download_file('multi-bin.xyz')
>>> reader = pv.reader.MultiBlockPlot3DReader(filename)
>>> reader.add_function(112)  # add a function by its integer value
>>> reader.add_function(
...     reader.PRESSURE_COEFFICIENT
... )  # add a function by enumeration via class variable alias