InputsFieldsContainerMatricesLabel

class ansys.dpf.core.operators.utility.fields_container_matrices_label.InputsFieldsContainerMatricesLabel(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to fields_container_matrices_label operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.fields_container_matrices_label()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_label = str()
>>> op.inputs.label.connect(my_label)
>>> my_time_scoping = int()
>>> op.inputs.time_scoping.connect(my_time_scoping)

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.
time_scoping	Allows to connect time_scoping input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.fields_container_matrices_label import InputsFieldsContainerMatricesLabel

Property detail

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

Allows to connect fields_container input to the operator.

fields container to be merged

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.fields_container_matrices_label()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)

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

Allows to connect label input to the operator.

Label where the merge is required

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsFieldsContainerMatricesLabel.time_scoping: ansys.dpf.core.inputs.Input[int | ansys.dpf.core.scoping.Scoping]

Allows to connect time_scoping input to the operator.

if it’s specified, fields container of field matrices is constructed only on the specified time scoping

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.fields_container_matrices_label()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)

Method detail

InputsFieldsContainerMatricesLabel.__str__()

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

InputsFieldsContainerMatricesLabel.__call__(inpt)

InputsFieldsContainerMatricesLabel.__getitem__(item) → Input