InputsRescope

class ansys.dpf.core.operators.scoping.rescope.InputsRescope(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to rescope operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.scoping.rescope()
>>> my_fields = dpf.FieldsContainer()
>>> op.inputs.fields.connect(my_fields)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_default_value = float()
>>> op.inputs.default_value.connect(my_default_value)

Overview

Methods

connect

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

Properties

fields	Allows to connect fields input to the operator.
mesh_scoping	Allows to connect mesh_scoping input to the operator.
default_value	Allows to connect default_value input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.scoping.rescope import InputsRescope

Property detail

property InputsRescope.fields: ansys.dpf.core.inputs.Input

Allows to connect fields 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.scoping.rescope()
>>> op.inputs.fields.connect(my_fields)
>>> # or
>>> op.inputs.fields(my_fields)

property InputsRescope.mesh_scoping: ansys.dpf.core.inputs.Input

Allows to connect mesh_scoping 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.scoping.rescope()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)

property InputsRescope.default_value: ansys.dpf.core.inputs.Input

Allows to connect default_value input to the operator.

If pin 2 is used, the IDs not found in the field are added with this default value.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.scoping.rescope()
>>> op.inputs.default_value.connect(my_default_value)
>>> # or
>>> op.inputs.default_value(my_default_value)

Method detail

InputsRescope.__str__()

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

Parameters:

• inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping, Enum,)

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

InputsRescope.__call__(inpt)

InputsRescope.__getitem__(item) → Input