ansys.dpf.core.operators.mesh.meshes_provider#

class ansys.dpf.core.operators.mesh.meshes_provider(time_scoping=None, streams_container=None, data_sources=None, read_cyclic=None, region_scoping=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Reads meshes from result files. Meshes can be spatially or temporally varying.

Parameters:

  • time_scoping (Scoping or int, optional) – Time/frequency set IDs required in output.

  • streams_container (StreamsContainer, optional) – result file container allowed to be kept open to cache data

  • data_sources (DataSources) – result file path container, used if no streams are set

  • read_cyclic (int, optional) – if 1, cyclic symmetry is ignored. If 2, cyclic expansion is done (default is 1).

  • region_scoping (Scoping or int, optional) – 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:

meshes

Return type:

MeshesContainer

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.mesh.meshes_provider()

>>> # Make input connections
>>> 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)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.mesh.meshes_provider(
...     time_scoping=my_time_scoping,
...     streams_container=my_streams_container,
...     data_sources=my_data_sources,
...     read_cyclic=my_read_cyclic,
...     region_scoping=my_region_scoping,
... )

>>> # Get output data
>>> result_meshes = op.outputs.meshes()
_inputs#
_outputs#
static _spec() → ansys.dpf.core.operators.specification.Specification#
static default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config#

Returns the default config of the operator.

This config can then be changed to the user needs and be used to instantiate the operator. The Configuration allows to customize how the operation will be processed by the operator.

Parameters:

server – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

Returns:

A new Config instance equivalent to the default config for this operator.

Return type:

config

property inputs: InputsMeshesProvider#

Enables to connect inputs to the operator

Returns:

An instance of InputsMeshesProvider.

Return type:

inputs

property outputs: OutputsMeshesProvider#

Enables to get outputs of the operator by evaluating it

Returns:

An instance of OutputsMeshesProvider.

Return type:

outputs