mesh_cut#

Autogenerated DPF operator classes.

class ansys.dpf.core.operators.mesh.mesh_cut.mesh_cut(field=None, iso_value=None, closed_surface=None, slice_surfaces=None, config=None, server=None)#

Extracts a skin of the mesh in triangles (2D elements) in a new meshed region

Parameters
  • field (Field) –

  • iso_value (float) – Iso value

  • closed_surface (float) – 1: closed surface, 0:iso surface

  • slice_surfaces (bool) – True: slicing will also take into account shell and 2d elements, false: slicing will ignore shell and 2d elements. default is true

Examples

>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
>>> op = dpf.operators.mesh.mesh_cut()
>>> # Make input connections
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_iso_value = float()
>>> op.inputs.iso_value.connect(my_iso_value)
>>> my_closed_surface = float()
>>> op.inputs.closed_surface.connect(my_closed_surface)
>>> my_slice_surfaces = bool()
>>> op.inputs.slice_surfaces.connect(my_slice_surfaces)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mesh.mesh_cut(
...     field=my_field,
...     iso_value=my_iso_value,
...     closed_surface=my_closed_surface,
...     slice_surfaces=my_slice_surfaces,
... )
>>> # Get output data
>>> result_mesh = op.outputs.mesh()
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 the global server.

property inputs#

Enables to connect inputs to the operator

Returns

inputs

Return type

InputsMeshCut

property outputs#

Enables to get outputs of the operator by evaluationg it

Returns

outputs

Return type

OutputsMeshCut

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 create an operator with the new configuration as a parameter.

Returns

Copy of the operator’s current configuration.

Return type

ansys.dpf.core.config.Config

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 of int, list of doubles,) –

    Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion,

    MeshesContainer, DataSources, 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.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
array([[0.59428386, 0.00201751, 0.0006032 ]])
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.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, 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)#

Put the grpc spec message in self._spec

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.

class ansys.dpf.core.operators.mesh.mesh_cut.InputsMeshCut(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to connect user inputs to mesh_cut operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_cut()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_iso_value = float()
>>> op.inputs.iso_value.connect(my_iso_value)
>>> my_closed_surface = float()
>>> op.inputs.closed_surface.connect(my_closed_surface)
>>> my_slice_surfaces = bool()
>>> op.inputs.slice_surfaces.connect(my_slice_surfaces)
property field#

Allows to connect field input to the operator.

Parameters

my_field (Field) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_cut()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)
property iso_value#

Allows to connect iso_value input to the operator.

Iso value

Parameters

my_iso_value (float) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_cut()
>>> op.inputs.iso_value.connect(my_iso_value)
>>> # or
>>> op.inputs.iso_value(my_iso_value)
property closed_surface#

Allows to connect closed_surface input to the operator.

1: closed surface, 0:iso surface

Parameters

my_closed_surface (float) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_cut()
>>> op.inputs.closed_surface.connect(my_closed_surface)
>>> # or
>>> op.inputs.closed_surface(my_closed_surface)
property slice_surfaces#

Allows to connect slice_surfaces input to the operator.

True: slicing will also take into account shell and 2d elements, false: slicing will ignore shell and 2d elements. default is true

Parameters

my_slice_surfaces (bool) –

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_cut()
>>> op.inputs.slice_surfaces.connect(my_slice_surfaces)
>>> # or
>>> op.inputs.slice_surfaces(my_slice_surfaces)
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, Field, FieldsContainer, Scoping,) –

DataSources, MeshedRegion, ScopingsContainer, CyclicSupport,

…, Output, Outputs, Operator, os.PathLike

Input of the operator.

class ansys.dpf.core.operators.mesh.mesh_cut.OutputsMeshCut(op: ansys.dpf.core.dpf_operator.Operator)#

Intermediate class used to get outputs from mesh_cut operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_cut()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh = op.outputs.mesh()
property mesh#

Allows to get mesh output of the operator

Returns

my_mesh

Return type

MeshedRegion

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_cut()
>>> # Connect inputs : op.inputs. ...
>>> result_mesh = op.outputs.mesh()