InputsMergeWeightedFieldsContainers

class ansys.dpf.core.operators.utility.merge_weighted_fields_containers.InputsMergeWeightedFieldsContainers(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to merge_weighted_fields_containers operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_weighted_fields_containers()
>>> 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)
>>> my_weights1 = dpf.PropertyFieldsContainer()
>>> op.inputs.weights1.connect(my_weights1)
>>> my_weights2 = dpf.PropertyFieldsContainer()
>>> op.inputs.weights2.connect(my_weights2)

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_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.
weights1	Allows to connect weights1 input to the operator.
weights2	Allows to connect weights2 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.merge_weighted_fields_containers import InputsMergeWeightedFieldsContainers

Property detail

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

property InputsMergeWeightedFieldsContainers.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_weighted_fields_containers()
>>> op.inputs.merged_fields_support.connect(my_merged_fields_support)
>>> # or
>>> op.inputs.merged_fields_support(my_merged_fields_support)

property InputsMergeWeightedFieldsContainers.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_weighted_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 InputsMergeWeightedFieldsContainers.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_weighted_fields_containers()
>>> op.inputs.fields_containers1.connect(my_fields_containers1)
>>> # or
>>> op.inputs.fields_containers1(my_fields_containers1)

property InputsMergeWeightedFieldsContainers.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_weighted_fields_containers()
>>> op.inputs.fields_containers2.connect(my_fields_containers2)
>>> # or
>>> op.inputs.fields_containers2(my_fields_containers2)

property InputsMergeWeightedFieldsContainers.weights1: ansys.dpf.core.inputs.Input[ansys.dpf.core.property_fields_container.PropertyFieldsContainer]

Allows to connect weights1 input to the operator.

Weights to apply to each field from pin 1000 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_weighted_fields_containers()
>>> op.inputs.weights1.connect(my_weights1)
>>> # or
>>> op.inputs.weights1(my_weights1)

property InputsMergeWeightedFieldsContainers.weights2: ansys.dpf.core.inputs.Input[ansys.dpf.core.property_fields_container.PropertyFieldsContainer]

Allows to connect weights2 input to the operator.

Weights to apply to each field from pin 1000 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_weighted_fields_containers()
>>> op.inputs.weights2.connect(my_weights2)
>>> # or
>>> op.inputs.weights2(my_weights2)

Method detail

InputsMergeWeightedFieldsContainers.__str__()

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

InputsMergeWeightedFieldsContainers.__call__(inpt)

InputsMergeWeightedFieldsContainers.__getitem__(item) → Input