InputsField#

class ansys.dpf.core.operators.utility.field.InputsField(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to field operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.field()
>>> my_input = dpf.Field()
>>> op.inputs.input.connect(my_input)

Overview#

connect

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

input

Allows to connect input input to the operator.

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.utility.field import InputsField

Property detail#

property InputsField.input: ansys.dpf.core.inputs.Input#

Allows to connect input 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.utility.field()
>>> op.inputs.input.connect(my_input)
>>> # or
>>> op.inputs.input(my_input)

Method detail#

InputsField.__str__()#
InputsField.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.

InputsField.__call__(inpt)#
InputsField.__getitem__(item) → Input#