InputsCmsMatricesProvider

class ansys.dpf.core.operators.result.cms_matrices_provider.InputsCmsMatricesProvider(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to cms_matrices_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cms_matrices_provider()
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_matrix_form = bool()
>>> op.inputs.matrix_form.connect(my_matrix_form)

Overview

Methods

connect

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

Properties

data_sources	Allows to connect data_sources input to the operator.
matrix_form	Allows to connect matrix_form input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.result.cms_matrices_provider import InputsCmsMatricesProvider

Property detail

property InputsCmsMatricesProvider.data_sources: ansys.dpf.core.inputs.Input[ansys.dpf.core.data_sources.DataSources]

Allows to connect data_sources input to the operator.

Data_sources (must contain at list one subfile).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cms_matrices_provider()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

property InputsCmsMatricesProvider.matrix_form: ansys.dpf.core.inputs.Input[bool]

Allows to connect matrix_form input to the operator.

If this pin i set to true, data are return as matrix form.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.cms_matrices_provider()
>>> op.inputs.matrix_form.connect(my_matrix_form)
>>> # or
>>> op.inputs.matrix_form(my_matrix_form)

Method detail

InputsCmsMatricesProvider.__str__()

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

InputsCmsMatricesProvider.__call__(inpt)

InputsCmsMatricesProvider.__getitem__(item) → Input