InputsElementTypesProvider

class ansys.dpf.core.operators.metadata.element_types_provider.InputsElementTypesProvider(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to element_types_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.element_types_provider()
>>> my_solver_element_types_ids = int()
>>> op.inputs.solver_element_types_ids.connect(my_solver_element_types_ids)
>>> my_streams = dpf.StreamsContainer()
>>> op.inputs.streams.connect(my_streams)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_output_type = int()
>>> op.inputs.output_type.connect(my_output_type)

Overview

Methods

connect

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

Properties

solver_element_types_ids	Allows to connect solver_element_types_ids input to the operator.
streams	Allows to connect streams input to the operator.
data_sources	Allows to connect data_sources input to the operator.
output_type	Allows to connect output_type input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.metadata.element_types_provider import InputsElementTypesProvider

Property detail

property InputsElementTypesProvider.solver_element_types_ids: ansys.dpf.core.inputs.Input[int]

Allows to connect solver_element_types_ids input to the operator.

Element Type ids to recover used by the solver. If not set, all available element types are recovered.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.element_types_provider()
>>> op.inputs.solver_element_types_ids.connect(my_solver_element_types_ids)
>>> # or
>>> op.inputs.solver_element_types_ids(my_solver_element_types_ids)

property InputsElementTypesProvider.streams: ansys.dpf.core.inputs.Input[ansys.dpf.core.streams_container.StreamsContainer]

Allows to connect streams input to the operator.

Result file container allowed to be kept open to cache data.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.element_types_provider()
>>> op.inputs.streams.connect(my_streams)
>>> # or
>>> op.inputs.streams(my_streams)

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

Allows to connect data_sources input to the operator.

Result file path container, used if no streams are set.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsElementTypesProvider.output_type: ansys.dpf.core.inputs.Input[int]

Allows to connect output_type input to the operator.

Get the output as a GenericDataContainer (pin value 1, default) or as a PropertyField (pin value 2).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.element_types_provider()
>>> op.inputs.output_type.connect(my_output_type)
>>> # or
>>> op.inputs.output_type(my_output_type)

Method detail

InputsElementTypesProvider.__str__()

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

InputsElementTypesProvider.__call__(inpt)

InputsElementTypesProvider.__getitem__(item) → Input