InputsFieldToFc#

class ansys.dpf.core.operators.utility.field_to_fc.InputsFieldToFc(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to field_to_fc operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.field_to_fc()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_label = dict()
>>> op.inputs.label.connect(my_label)

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.

label

Allows to connect label input to the operator.

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.utility.field_to_fc import InputsFieldToFc

Property detail#

property InputsFieldToFc.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.

If a fields container is set in input, it is passed on as an output with the additional label space (if any).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.field_to_fc()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)
property InputsFieldToFc.label: ansys.dpf.core.inputs.Input[dict]#

Allows to connect label input to the operator.

Sets a label space.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.field_to_fc()
>>> op.inputs.label.connect(my_label)
>>> # or
>>> op.inputs.label(my_label)

Method detail#

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

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