mesh_to_pyvista#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.mesh.mesh_to_pyvista.mesh_to_pyvista(coordinates=None, as_linear=None, mesh=None, vtk_updated=None, as_poly=None, config=None, server=None)#

Export a MeshedRegion in the pyVista format.

Parameters:

coordinates (Field, optional) – Node coordinates. if not set, the node coordinates of the mesh are employed.
as_linear (bool, optional) – Export a linear version of the mesh (quadratic surface elements do no include midside nodes). if not set, defaults to true.
mesh (MeshedRegion) – Mesh to export in pyvista format
vtk_updated (bool, optional) – True if the vtk version employed by pyvista is > vtk 9. default true.
as_poly (bool, optional) – Export elements as polyhedrons (cell-face- node representation). default false.

Returns:

nodes (Field) – Node coordinates double vector
cells – Cell connectivity int vector
cell_types – Cell types property int vector
offsets (optional) – If vtk_updated=false, offsets int vector

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.mesh.mesh_to_pyvista()

>>> # Make input connections
>>> my_coordinates = dpf.Field()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> my_as_linear = bool()
>>> op.inputs.as_linear.connect(my_as_linear)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_vtk_updated = bool()
>>> op.inputs.vtk_updated.connect(my_vtk_updated)
>>> my_as_poly = bool()
>>> op.inputs.as_poly.connect(my_as_poly)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mesh.mesh_to_pyvista(
...     coordinates=my_coordinates,
...     as_linear=my_as_linear,
...     mesh=my_mesh,
...     vtk_updated=my_vtk_updated,
...     as_poly=my_as_poly,
... )

>>> # Get output data
>>> result_nodes = op.outputs.nodes()
>>> result_cells = op.outputs.cells()
>>> result_cell_types = op.outputs.cell_types()
>>> result_offsets = op.outputs.offsets()

static default_config(server=None)#

Returns the default config of the operator.

This config can then be changed to the user needs and be used to instantiate the operator. The Configuration allows to customize how the operation will be processed by the operator.

Parameters:: server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

property inputs#

Enables to connect inputs to the operator

Returns:: inputs
Return type:: InputsMeshToPyvista

property outputs#

Enables to get outputs of the operator by evaluating it

Returns:: outputs
Return type:: OutputsMeshToPyvista

property config#

Copy of the operator’s current configuration.

You can modify the copy of the configuration and then use operator.config = new_config or instantiate an operator with the new configuration as a parameter.

For information on an operator’s options, see the documentation for that operator.

Returns:: Copy of the operator’s current configuration.
Return type:: ansys.dpf.core.config.Config

Examples

Modify the copy of an operator’s configuration and set it as current config of the operator.

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.add()
>>> config_add = op.config
>>> config_add.set_work_by_index_option(True)
>>> op.config = config_add

connect(pin, inpt, pin_out=0)#

Connect an input on the operator using a pin number.

Parameters:

pin (int) – Number of the input pin.
inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer – Operator, os.PathLike Object to connect to.
MeshedRegion – Operator, os.PathLike Object to connect to.
MeshesContainer – Operator, os.PathLike Object to connect to.
DataSources – Operator, os.PathLike Object to connect to.
CyclicSupport – Operator, os.PathLike Object to connect to.
dict – Operator, os.PathLike Object to connect to.
Outputs – Operator, os.PathLike Object to connect to.
pin_out (int, optional) – If the input is an operator, the output pin of the input operator. The default is 0.

Examples

Compute the minimum of displacement by chaining the "U" and "min_max_fc" operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...

connect_operator_as_input(pin, op)#: Connects an operator as an input on a pin. :type pin: :param pin: Number of the output pin. The default is 0. :type pin: int :type op: :param op: Requested type of the output. The default is None. :type op: ansys.dpf.core.dpf_operator.Operator

eval(pin=None)#

Evaluate this operator.

Parameters:: pin (int) – Number of the output pin. The default is None.
Returns:: output – Returns the first output of the operator by default and the output of a given pin when specified. Or, it only evaluates the operator without output.
Return type:: FieldsContainer, Field, MeshedRegion, Scoping

Examples

Use the eval method.

>>> from ansys.dpf import core as dpf
>>> import ansys.dpf.core.operators.math as math
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> normfc = math.norm_fc(disp_op).eval()

get_output(pin=0, output_type=None)#

Retrieve the output of the operator on the pin number.

To activate the progress bar for server version higher or equal to 3.0, use my_op.progress_bar=True

Parameters:

pin (int, optional) – Number of the output pin. The default is 0.
output_type (ansys.dpf.core.common.types, type, optional) – Requested type of the output. The default is None.

Returns:

Output of the operator.

Return type:

type

static operator_specification(op_name, server=None)#: Documents an Operator with its description (what the Operator does), its inputs and outputs and some properties

property progress_bar: bool#: With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False

run()#: Evaluate this operator.

property specification#

Returns the Specification (or documentation) of this Operator

Return type:: Specification

class ansys.dpf.core.operators.mesh.mesh_to_pyvista.InputsMeshToPyvista(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to mesh_to_pyvista operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> my_coordinates = dpf.Field()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> my_as_linear = bool()
>>> op.inputs.as_linear.connect(my_as_linear)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_vtk_updated = bool()
>>> op.inputs.vtk_updated.connect(my_vtk_updated)
>>> my_as_poly = bool()
>>> op.inputs.as_poly.connect(my_as_poly)

property coordinates#

Allows to connect coordinates input to the operator.

Node coordinates. if not set, the node coordinates of the mesh are employed.

Parameters:: my_coordinates (Field) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> # or
>>> op.inputs.coordinates(my_coordinates)

property as_linear#

Allows to connect as_linear input to the operator.

Export a linear version of the mesh (quadratic surface elements do no include midside nodes). if not set, defaults to true.

Parameters:: my_as_linear (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> op.inputs.as_linear.connect(my_as_linear)
>>> # or
>>> op.inputs.as_linear(my_as_linear)

property mesh#

Allows to connect mesh input to the operator.

Mesh to export in pyvista format

Parameters:: my_mesh (MeshedRegion) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)

property vtk_updated#

Allows to connect vtk_updated input to the operator.

True if the vtk version employed by pyvista is > vtk 9. default true.

Parameters:: my_vtk_updated (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> op.inputs.vtk_updated.connect(my_vtk_updated)
>>> # or
>>> op.inputs.vtk_updated(my_vtk_updated)

property as_poly#

Allows to connect as_poly input to the operator.

Export elements as polyhedrons (cell-face- node representation). default false.

Parameters:: my_as_poly (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> op.inputs.as_poly.connect(my_as_poly)
>>> # or
>>> op.inputs.as_poly(my_as_poly)

connect(inpt)#

Connect any input (an entity or an operator output) to any input pin of this operator. Searches for the input type corresponding to the output.

Parameters:

inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,) –
ScopingsContainer (E501) – Input of the operator.
MeshedRegion (E501) – Input of the operator.
MeshesContainer (E501) – Input of the operator.
DataSources (E501) – Input of the operator.
CyclicSupport (E501) – Input of the operator.
Outputs (E501) – Input of the operator.
noqa (os.PathLike #) – Input of the operator.

class ansys.dpf.core.operators.mesh.mesh_to_pyvista.OutputsMeshToPyvista(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from mesh_to_pyvista operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> # Connect inputs : op.inputs. ...
>>> result_nodes = op.outputs.nodes()
>>> result_cells = op.outputs.cells()
>>> result_cell_types = op.outputs.cell_types()
>>> result_offsets = op.outputs.offsets()

property nodes#

Allows to get nodes output of the operator

Returns:: my_nodes
Return type:: Field

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> # Connect inputs : op.inputs. ...
>>> result_nodes = op.outputs.nodes()

property cells#

Allows to get cells output of the operator

Return type:: my_cells

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> # Connect inputs : op.inputs. ...
>>> result_cells = op.outputs.cells()

property cell_types#

Allows to get cell_types output of the operator

Return type:: my_cell_types

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> # Connect inputs : op.inputs. ...
>>> result_cell_types = op.outputs.cell_types()

property offsets#

Allows to get offsets output of the operator

Return type:: my_offsets

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_to_pyvista()
>>> # Connect inputs : op.inputs. ...
>>> result_offsets = op.outputs.offsets()