InputsRemoveRigidBodyMotion

class ansys.dpf.core.operators.result.remove_rigid_body_motion.InputsRemoveRigidBodyMotion(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to remove_rigid_body_motion operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.remove_rigid_body_motion()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_reference_node_id = int()
>>> op.inputs.reference_node_id.connect(my_reference_node_id)
>>> my_mesh = dpf.MeshedRegion()
>>> op.inputs.mesh.connect(my_mesh)

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.
reference_node_id	Allows to connect reference_node_id input to the operator.
mesh	Allows to connect mesh input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.result.remove_rigid_body_motion import InputsRemoveRigidBodyMotion

Property detail

property InputsRemoveRigidBodyMotion.field: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field | ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect field input to the operator.

field or fields container with only one field is expected

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsRemoveRigidBodyMotion.reference_node_id: ansys.dpf.core.inputs.Input[int]

Allows to connect reference_node_id input to the operator.

Id of the reference entity (node).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.remove_rigid_body_motion()
>>> op.inputs.reference_node_id.connect(my_reference_node_id)
>>> # or
>>> op.inputs.reference_node_id(my_reference_node_id)

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

Allows to connect mesh input to the operator.

default is the mesh in the support

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

Method detail

InputsRemoveRigidBodyMotion.__str__()

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

InputsRemoveRigidBodyMotion.__call__(inpt)

InputsRemoveRigidBodyMotion.__getitem__(item) → Input