`hdf5dpf_workglow_provider`#

class ansys.dpf.core.operators.utility.hdf5dpf_workglow_provider.hdf5dpf_workglow_provider(time_scoping=None, mesh_scoping=None, streams=None, data_sources=None, meta_data=None, result_name=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Extract a custom result from an hdf5dpf file as an executable workflow.

Inputs#

time_scoping: Scoping, optional mesh_scoping: Scoping, optional streams: StreamsContainer, optional

Hdf5df file stream.

data_sources: DataSources, optional: Hdf5df file data source.
meta_data: DataTree, optional: meta_data that may be used to evaluate results or extract workflows.
result_name:: Name of the result that must be extracted from the hdf5dpf file

Outputs#

field_or_fields_container: Workflow

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.utility.hdf5dpf_workglow_provider()

>>> # Make input connections
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.Scoping()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> my_streams = dpf.StreamsContainer()
>>> op.inputs.streams.connect(my_streams)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> my_meta_data = dpf.DataTree()
>>> op.inputs.meta_data.connect(my_meta_data)
>>> my_result_name = dpf.()
>>> op.inputs.result_name.connect(my_result_name)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.utility.hdf5dpf_workglow_provider(
...     time_scoping=my_time_scoping,
...     mesh_scoping=my_mesh_scoping,
...     streams=my_streams,
...     data_sources=my_data_sources,
...     meta_data=my_meta_data,
...     result_name=my_result_name,
... )

>>> # Get output data
>>> result_field_or_fields_container = op.outputs.field_or_fields_container()

Overview#

Methods

`connect`	Connect an input on the operator using a pin number.
`connect_operator_as_input`	Connect an operator as an input on a pin.
`get_output`	Retrieve the output of the operator on the pin number.
`run`	Evaluate this operator.
`eval`	Evaluate this operator.

Properties

`inputs`	Enables to connect inputs to the operator
`outputs`	Enables to get outputs of the operator by evaluating it
`progress_bar`	Enable or disable progress bar display when requesting the operator’s output.
`config`	Copy of the operator’s current configuration.
`id`	Retrieve the unique identifier of the operator.
`specification`	Returns the Specification (or documentation) of this Operator.
`changelog`	Return the changelog of this operator.
`version`	Return the current version of the operator.

Attributes

name

Static methods

`default_config`	Returns the default config of the operator.
`operator_specification`	Documents an Operator with its description (what the Operator does),its inputs and outputs and some properties.

Special methods

`__del__`	Delete this instance.
`__str__`	Describe the entity.
`__add__`	Add two fields or two fields containers.
`__sub__`	Subtract two fields or two fields containers.
`__pow__`	Raise each element of a field or a fields container to power 2.
`__mul__`	Multiply two fields or two fields containers.
`__truediv__`	Perform division with another operator or a scalar.

Import detail#

from ansys.dpf.core.operators.utility.hdf5dpf_workglow_provider import hdf5dpf_workglow_provider

Property detail#

property hdf5dpf_workglow_provider.inputs: InputsHdf5DpfWorkglowProvider#

Enables to connect inputs to the operator

Returns:: An instance of InputsHdf5DpfWorkglowProvider.
Return type:: inputs

property hdf5dpf_workglow_provider.outputs: OutputsHdf5DpfWorkglowProvider#

Enables to get outputs of the operator by evaluating it

Returns:: An instance of OutputsHdf5DpfWorkglowProvider.
Return type:: outputs

property hdf5dpf_workglow_provider.progress_bar: bool#

Enable or disable progress bar display when requesting the operator’s output.

With this property, the user can choose to print a progress bar when the operator’s output is requested, default is False

property hdf5dpf_workglow_provider.config#

Copy of the operator’s current configuration.

You can modify the copy of the configuration and then use operator.config = new_config or instantiate an operator with the new configuration as a parameter.

For information on an operator’s options, see the documentation for that operator.

Returns:: Copy of the operator’s current configuration.
Return type:: ansys.dpf.core.config.Config

Examples

Modify the copy of an operator’s configuration and set it as current config of the operator.

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.math.add()
>>> config_add = op.config
>>> config_add.set_work_by_index_option(True)
>>> op.config = config_add

property hdf5dpf_workglow_provider.id: int#

Retrieve the unique identifier of the operator.

This property returns the unique ID associated with the operator. This property is lazily initialized.

Returns:: The unique identifier of the operator.
Return type:: int

Notes

Property available with server’s version starting at 10.0.

property hdf5dpf_workglow_provider.specification#

Returns the Specification (or documentation) of this Operator.

Return type:: Specification

property hdf5dpf_workglow_provider.changelog: ansys.dpf.core.changelog.Changelog#

Return the changelog of this operator.

Requires DPF 11.0 (2026 R1) or above.

Returns:: Changelog of the operator.
Return type:: changelog

property hdf5dpf_workglow_provider.version: packaging.version.Version#

Return the current version of the operator.

Requires DPF 11.0 (2026 R1) or above.

Attribute detail#

hdf5dpf_workglow_provider.name = None#

Method detail#

static hdf5dpf_workglow_provider.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

hdf5dpf_workglow_provider.connect(pin, inpt, pin_out=0)#

Connect an input on the operator using a pin number.

Parameters:

pin (int) – Number of the input pin.
inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping,)
ScopingsContainer – Operator, os.PathLike Object to connect to.
MeshedRegion – Operator, os.PathLike Object to connect to.
MeshesContainer – Operator, os.PathLike Object to connect to.
DataSources – Operator, os.PathLike Object to connect to.
CyclicSupport – Operator, os.PathLike Object to connect to.
dict – Operator, os.PathLike Object to connect to.
Outputs – Operator, os.PathLike Object to connect to.
pin_out (int, optional) – If the input is an operator, the output pin of the input operator. The default is 0.

Examples

Compute the minimum of displacement by chaining the "U" and "min_max_fc" operators.

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> max_fc_op = dpf.operators.min_max.min_max_fc()
>>> max_fc_op.inputs.connect(disp_op.outputs)
>>> max_field = max_fc_op.outputs.field_max()
>>> max_field.data
DPFArray([[0.59428386, 0.00201751, 0.0006032 ]]...

hdf5dpf_workglow_provider.connect_operator_as_input(pin, op)#

Connect an operator as an input on a pin.

Parameters:

pin (int) – Number of the output pin. The default is 0.
op (ansys.dpf.core.dpf_operator.Operator) – Requested type of the output. The default is None.

hdf5dpf_workglow_provider.get_output(pin=0, output_type=None)#

Retrieve the output of the operator on the pin number.

To activate the progress bar for server version higher or equal to 3.0, use my_op.progress_bar=True

Parameters:

pin (int, optional) – Number of the output pin. The default is 0.
output_type (ansys.dpf.core.common.types, type, optional) – Requested type of the output. The default is None.

Returns:

Output of the operator.

Return type:

type

hdf5dpf_workglow_provider.__del__()#: Delete this instance.

hdf5dpf_workglow_provider.__str__()#

Describe the entity.

Returns:: Description of the entity.
Return type:: str

hdf5dpf_workglow_provider.run()#: Evaluate this operator.

hdf5dpf_workglow_provider.eval(pin=None)#

Evaluate this operator.

Parameters:: pin (int) – Number of the output pin. The default is None.
Returns:: output – Returns the first output of the operator by default and the output of a given pin when specified. Or, it only evaluates the operator without output.
Return type:: FieldsContainer, Field, MeshedRegion, Scoping

Examples

Use the eval method.

>>> from ansys.dpf import core as dpf
>>> import ansys.dpf.core.operators.math as math
>>> from ansys.dpf.core import examples
>>> data_src = dpf.DataSources(examples.find_multishells_rst())
>>> disp_op = dpf.operators.result.displacement()
>>> disp_op.inputs.data_sources(data_src)
>>> normfc = math.norm_fc(disp_op).eval()

hdf5dpf_workglow_provider.__add__(fields_b)#

Add two fields or two fields containers.

Returns:: add
Return type:: operators.math.add_fc

hdf5dpf_workglow_provider.__sub__(fields_b)#

Subtract two fields or two fields containers.

Returns:: minus
Return type:: operators.math.minus_fc

hdf5dpf_workglow_provider.__pow__(value)#: Raise each element of a field or a fields container to power 2.

hdf5dpf_workglow_provider.__mul__(value)#

Multiply two fields or two fields containers.

Returns:: mul
Return type:: operators.math.generalized_inner_product_fc

static hdf5dpf_workglow_provider.operator_specification(op_name, server=None)#: Documents an Operator with its description (what the Operator does),its inputs and outputs and some properties.

hdf5dpf_workglow_provider.__truediv__(inpt)#

Perform division with another operator or a scalar.

This method allows the use of the division operator (/) between an Operator instance and either another Operator or a scalar value (float).

hdf5dpf_workglow_provider#

Inputs#

Outputs#

Overview#

Import detail#

Property detail#

Attribute detail#

Method detail#

`hdf5dpf_workglow_provider`#