InputsExtractField#

class ansys.dpf.core.operators.utility.extract_field.InputsExtractField(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to extract_field operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_field()
>>> my_fields_container = dpf.Field()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_indices = dpf.()
>>> op.inputs.indices.connect(my_indices)

Overview#

connect

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

fields_container

Allows to connect fields_container input to the operator.

indices

Allows to connect indices input to the operator.

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.utility.extract_field import InputsExtractField

Property detail#

property InputsExtractField.fields_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field | ansys.dpf.core.fields_container.FieldsContainer]#

Allows to connect fields_container input to the operator.

Fields container or single field. If a field is provided, it is passed through as output

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_field()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)
property InputsExtractField.indices: ansys.dpf.core.inputs.Input#

Allows to connect indices input to the operator.

Indices of fields to extract. Default is [0] (first field). Single index returns a field, multiple indices return a fields container

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_field()
>>> op.inputs.indices.connect(my_indices)
>>> # or
>>> op.inputs.indices(my_indices)

Method detail#

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

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