InputsMeshClip

class ansys.dpf.core.operators.mesh.mesh_clip.InputsMeshClip(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to mesh_clip operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_clip()
>>> 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 = int()
>>> op.inputs.closed_surface.connect(my_closed_surface)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)
>>> my_slice_surfaces = bool()
>>> op.inputs.slice_surfaces.connect(my_slice_surfaces)

Overview

Methods

connect

Connect any input (an entity or an operator output) to any input pin of this operator.

Properties

field	Allows to connect field input to the operator.
iso_value	Allows to connect iso_value input to the operator.
closed_surface	Allows to connect closed_surface input to the operator.
mesh	Allows to connect mesh input to the operator.
slice_surfaces	Allows to connect slice_surfaces input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.mesh.mesh_clip import InputsMeshClip

Property detail

property InputsMeshClip.field: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field]

Allows to connect field input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsMeshClip.iso_value: ansys.dpf.core.inputs.Input[float]

Allows to connect iso_value input to the operator.

iso value

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsMeshClip.closed_surface: ansys.dpf.core.inputs.Input[int]

Allows to connect closed_surface input to the operator.

1: closed surface, 0: iso surface.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsMeshClip.mesh: ansys.dpf.core.inputs.Input[ansys.dpf.core.meshed_region.MeshedRegion]

Allows to connect mesh input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsMeshClip.slice_surfaces: ansys.dpf.core.inputs.Input[bool]

Allows to connect slice_surfaces input to the operator.

True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.mesh_clip()
>>> op.inputs.slice_surfaces.connect(my_slice_surfaces)
>>> # or
>>> op.inputs.slice_surfaces(my_slice_surfaces)

Method detail

InputsMeshClip.__str__()

InputsMeshClip.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.

Deprecated since version Deprecated: in favor of explicit output-to-input connections.

InputsMeshClip.__call__(inpt)

InputsMeshClip.__getitem__(item) → Input