InputsMergeFields

class ansys.dpf.core.operators.utility.merge_fields.InputsMergeFields(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to merge_fields operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> my_sum_merge = bool()
>>> op.inputs.sum_merge.connect(my_sum_merge)
>>> my_merged_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_support.connect(my_merged_support)
>>> my_fields1 = dpf.Field()
>>> op.inputs.fields1.connect(my_fields1)
>>> my_fields2 = dpf.Field()
>>> op.inputs.fields2.connect(my_fields2)

Overview

Methods

connect

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

Properties

sum_merge	Allows to connect sum_merge input to the operator.
merged_support	Allows to connect merged_support input to the operator.
fields1	Allows to connect fields1 input to the operator.
fields2	Allows to connect fields2 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.merge_fields import InputsMergeFields

Property detail

property InputsMergeFields.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()
>>> op.inputs.sum_merge.connect(my_sum_merge)
>>> # or
>>> op.inputs.sum_merge(my_sum_merge)

property InputsMergeFields.merged_support: ansys.dpf.core.inputs.Input

Allows to connect merged_support input to the operator.

Already merged field support.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> op.inputs.merged_support.connect(my_merged_support)
>>> # or
>>> op.inputs.merged_support(my_merged_support)

property InputsMergeFields.fields1: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field | ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect fields1 input to the operator.

Either a fields container, a vector of fields to merge, or fields from pin 0 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> op.inputs.fields1.connect(my_fields1)
>>> # or
>>> op.inputs.fields1(my_fields1)

property InputsMergeFields.fields2: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field | ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect fields2 input to the operator.

Either a fields container, a vector of fields to merge, or fields from pin 0 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields()
>>> op.inputs.fields2.connect(my_fields2)
>>> # or
>>> op.inputs.fields2(my_fields2)

Method detail

InputsMergeFields.__str__()

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

InputsMergeFields.__call__(inpt)

InputsMergeFields.__getitem__(item) → Input