InputsMergeFieldsContainers

class ansys.dpf.core.operators.utility.merge_fields_containers.InputsMergeFieldsContainers(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to merge_fields_containers operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields_containers()
>>> my_should_merge_named_selections = bool()
>>> op.inputs.should_merge_named_selections.connect(my_should_merge_named_selections)
>>> my_sum_merge = bool()
>>> op.inputs.sum_merge.connect(my_sum_merge)
>>> my_merged_fields_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_fields_support.connect(my_merged_fields_support)
>>> my_merged_fields_containers_support = dpf.AbstractFieldSupport()
>>> op.inputs.merged_fields_containers_support.connect(my_merged_fields_containers_support)
>>> my_fields_containers1 = dpf.FieldsContainer()
>>> op.inputs.fields_containers1.connect(my_fields_containers1)
>>> my_fields_containers2 = dpf.FieldsContainer()
>>> op.inputs.fields_containers2.connect(my_fields_containers2)

Overview

Methods

connect

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

Properties

should_merge_named_selections	Allows to connect should_merge_named_selections input to the operator.
sum_merge	Allows to connect sum_merge input to the operator.
merged_fields_support	Allows to connect merged_fields_support input to the operator.
merged_fields_containers_support	Allows to connect merged_fields_containers_support input to the operator.
fields_containers1	Allows to connect fields_containers1 input to the operator.
fields_containers2	Allows to connect fields_containers2 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.merge_fields_containers import InputsMergeFieldsContainers

Property detail

property InputsMergeFieldsContainers.should_merge_named_selections: ansys.dpf.core.inputs.Input[bool]

Allows to connect should_merge_named_selections input to the operator.

For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_fields_containers()
>>> op.inputs.should_merge_named_selections.connect(my_should_merge_named_selections)
>>> # or
>>> op.inputs.should_merge_named_selections(my_should_merge_named_selections)

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

property InputsMergeFieldsContainers.merged_fields_support: ansys.dpf.core.inputs.Input

Allows to connect merged_fields_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_containers()
>>> op.inputs.merged_fields_support.connect(my_merged_fields_support)
>>> # or
>>> op.inputs.merged_fields_support(my_merged_fields_support)

property InputsMergeFieldsContainers.merged_fields_containers_support: ansys.dpf.core.inputs.Input

Allows to connect merged_fields_containers_support input to the operator.

Already merged fields containers 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_containers()
>>> op.inputs.merged_fields_containers_support.connect(my_merged_fields_containers_support)
>>> # or
>>> op.inputs.merged_fields_containers_support(my_merged_fields_containers_support)

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

Allows to connect fields_containers1 input to the operator.

A vector of fields containers to merge or fields containers 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_containers()
>>> op.inputs.fields_containers1.connect(my_fields_containers1)
>>> # or
>>> op.inputs.fields_containers1(my_fields_containers1)

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

Allows to connect fields_containers2 input to the operator.

A vector of fields containers to merge or fields containers 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_containers()
>>> op.inputs.fields_containers2.connect(my_fields_containers2)
>>> # or
>>> op.inputs.fields_containers2(my_fields_containers2)

Method detail

InputsMergeFieldsContainers.__str__()

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

InputsMergeFieldsContainers.__call__(inpt)

InputsMergeFieldsContainers.__getitem__(item) → Input