InputsForwardField

class ansys.dpf.core.operators.utility.forward_field.InputsForwardField(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to forward_field operator.

Examples

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

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.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.forward_field import InputsForwardField

Property detail

property InputsForwardField.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.utility.forward_field()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

Method detail

InputsForwardField.__str__()

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

InputsForwardField.__call__(inpt)

InputsForwardField.__getitem__(item) → Input