InputsInvariants#

class ansys.dpf.core.operators.invariant.invariants.InputsInvariants(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to invariants operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.invariant.invariants()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)

Overview#

connect

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

field

Allows to connect field input to the operator.

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.invariant.invariants import InputsInvariants

Property detail#

property InputsInvariants.field: ansys.dpf.core.inputs.Input#

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.invariant.invariants()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

Method detail#

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

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