utility:hdf5dpf workflow provider

Version: 0.0.0

Description

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

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

time_scoping (Pin 0)

• Required: No
• Expected type(s): scoping

mesh_scoping (Pin 1)

• Required: No
• Expected type(s): scoping

streams (Pin 3)

• Required: No
• Expected type(s): streams_container

Hdf5df file stream.

data_sources (Pin 4)

• Required: No
• Expected type(s): data_sources

Hdf5df file data source.

meta_data (Pin 24)

• Required: No
• Expected type(s): abstract_data_tree

meta_data that may be used to evaluate results or extract workflows.

result_name (Pin 60)

• Required: Yes
• Expected type(s):

Name of the result that must be extracted from the hdf5dpf file

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

field_or_fields_container (Pin 0)

• Expected type(s): workflow

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: utility

Plugin: core

Scripting name: hdf5dpf_workglow_provider

Full name: utility.hdf5dpf_workglow_provider

Internal name: hdf5::h5dpf::workflow_provider

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("hdf5::h5dpf::workflow_provider"); // operator instantiation
op.connect(0, my_time_scoping);
op.connect(1, my_mesh_scoping);
op.connect(3, my_streams);
op.connect(4, my_data_sources);
op.connect(24, my_meta_data);
op.connect(60, my_result_name);
ansys::dpf::Workflow my_field_or_fields_container = op.getOutput<ansys::dpf::Workflow>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.hdf5dpf_workglow_provider() # operator instantiation
op.inputs.time_scoping.connect(my_time_scoping)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.streams.connect(my_streams)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.meta_data.connect(my_meta_data)
op.inputs.result_name.connect(my_result_name)
my_field_or_fields_container = op.outputs.field_or_fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.hdf5dpf_workglow_provider() # operator instantiation
op.inputs.time_scoping.Connect(my_time_scoping)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.streams.Connect(my_streams)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.meta_data.Connect(my_meta_data)
op.inputs.result_name.Connect(my_result_name)
my_field_or_fields_container = op.outputs.field_or_fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.