InputsMergeFieldsByLabel

class ansys.dpf.core.operators.utility.merge_fields_by_label.InputsMergeFieldsByLabel(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to merge_fields_by_label operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields_by_label()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_label = str()
>>> op.inputs.label.connect(my_label)
>>> my_merged_field_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_field_support.connect(my_merged_field_support)
>>> my_sum_merge = bool()
>>> op.inputs.sum_merge.connect(my_sum_merge)

Overview

Methods

connect

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

Properties

fields_container	Allows to connect fields_container input to the operator.
label	Allows to connect label input to the operator.
merged_field_support	Allows to connect merged_field_support input to the operator.
sum_merge	Allows to connect sum_merge input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.merge_fields_by_label import InputsMergeFieldsByLabel

Property detail

property InputsMergeFieldsByLabel.fields_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect fields_container 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.merge_fields_by_label()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)

property InputsMergeFieldsByLabel.label: ansys.dpf.core.inputs.Input[str]

Allows to connect label input to the operator.

Label identifier that should be merged.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsMergeFieldsByLabel.merged_field_support: ansys.dpf.core.inputs.Input

Allows to connect merged_field_support input to the operator.

The FieldsContainer’s support that has already been merged.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields_by_label()
>>> op.inputs.merged_field_support.connect(my_merged_field_support)
>>> # or
>>> op.inputs.merged_field_support(my_merged_field_support)

property InputsMergeFieldsByLabel.sum_merge: ansys.dpf.core.inputs.Input[bool]

Allows to connect sum_merge input to the operator.

Default is false. If true, redundant quantities are summed instead of being ignored.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields_by_label()
>>> op.inputs.sum_merge.connect(my_sum_merge)
>>> # or
>>> op.inputs.sum_merge(my_sum_merge)

Method detail

InputsMergeFieldsByLabel.__str__()

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

InputsMergeFieldsByLabel.__call__(inpt)

InputsMergeFieldsByLabel.__getitem__(item) → Input