InputsMakePlaneLevelset

class ansys.dpf.core.operators.mesh.make_plane_levelset.InputsMakePlaneLevelset(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to make_plane_levelset operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.make_plane_levelset()
>>> my_coordinates = dpf.MeshedRegion()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> my_normal = dpf.Field()
>>> op.inputs.normal.connect(my_normal)
>>> my_origin = dpf.Field()
>>> op.inputs.origin.connect(my_origin)

Overview

Methods

connect

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

Properties

coordinates	Allows to connect coordinates input to the operator.
normal	Allows to connect normal input to the operator.
origin	Allows to connect origin input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.mesh.make_plane_levelset import InputsMakePlaneLevelset

Property detail

property InputsMakePlaneLevelset.coordinates: ansys.dpf.core.inputs.Input[ansys.dpf.core.meshed_region.MeshedRegion | ansys.dpf.core.field.Field]

Allows to connect coordinates 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.make_plane_levelset()
>>> op.inputs.coordinates.connect(my_coordinates)
>>> # or
>>> op.inputs.coordinates(my_coordinates)

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

Allows to connect normal input to the operator.

An overall 3D vector that gives the normal direction of the plane.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.make_plane_levelset()
>>> op.inputs.normal.connect(my_normal)
>>> # or
>>> op.inputs.normal(my_normal)

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

Allows to connect origin input to the operator.

An overall 3d vector that gives a point of the plane.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.make_plane_levelset()
>>> op.inputs.origin.connect(my_origin)
>>> # or
>>> op.inputs.origin(my_origin)

Method detail

InputsMakePlaneLevelset.__str__()

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

InputsMakePlaneLevelset.__call__(inpt)

InputsMakePlaneLevelset.__getitem__(item) → Input