InputsMergeToFieldMatrix

class ansys.dpf.core.operators.utility.merge_to_field_matrix.InputsMergeToFieldMatrix(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to merge_to_field_matrix operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_to_field_matrix()
>>> 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

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_to_field_matrix import InputsMergeToFieldMatrix

Property detail

property InputsMergeToFieldMatrix.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_to_field_matrix()
>>> op.inputs.fields1.connect(my_fields1)
>>> # or
>>> op.inputs.fields1(my_fields1)

property InputsMergeToFieldMatrix.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_to_field_matrix()
>>> op.inputs.fields2.connect(my_fields2)
>>> # or
>>> op.inputs.fields2(my_fields2)

Method detail

InputsMergeToFieldMatrix.__str__()

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

InputsMergeToFieldMatrix.__call__(inpt)

InputsMergeToFieldMatrix.__getitem__(item) → Input