InputsMeshesProvider

class ansys.dpf.core.operators.mesh.meshes_provider.InputsMeshesProvider(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to meshes_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshes_provider()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_read_cyclic = int()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> my_region_scoping = dpf.Scoping()
>>> op.inputs.region_scoping.connect(my_region_scoping)

Overview

Methods

connect

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

Properties

time_scoping	Allows to connect time_scoping input to the operator.
streams_container	Allows to connect streams_container input to the operator.
data_sources	Allows to connect data_sources input to the operator.
read_cyclic	Allows to connect read_cyclic input to the operator.
region_scoping	Allows to connect region_scoping input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.mesh.meshes_provider import InputsMeshesProvider

Property detail

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

Allows to connect time_scoping input to the operator.

Time/frequency set IDs required in output.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

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

Allows to connect streams_container 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.mesh.meshes_provider()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

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

Allows to connect data_sources input to the operator.

Data sources describing one or more result files.

Error conditions when `permissive` config is disabled: - Throws std::runtime_error with message “StreamProvider: empty namespace for result key ‘’” if a result file has no namespace. - Throws std::runtime_error with message “StreamProvider: operator ::stream_provider not found.” if the namespace is not supported. - If all result files are invalid, throws an error even in permissive mode.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsMeshesProvider.read_cyclic: ansys.dpf.core.inputs.Input[int]

Allows to connect read_cyclic input to the operator.

if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshes_provider()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> # or
>>> op.inputs.read_cyclic(my_read_cyclic)

property InputsMeshesProvider.region_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping | int]

Allows to connect region_scoping input to the operator.

region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mesh.meshes_provider()
>>> op.inputs.region_scoping.connect(my_region_scoping)
>>> # or
>>> op.inputs.region_scoping(my_region_scoping)

Method detail

InputsMeshesProvider.__str__()

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

InputsMeshesProvider.__call__(inpt)

InputsMeshesProvider.__getitem__(item) → Input