result:cgns result provider

Version: 0.0.0

Description

Read/compute names result from result streams.

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, vector<int32>

time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output

mesh_scoping (Pin 1)

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

nodes or elements scoping required in output. The scoping's location indicates whether nodes or elements are asked. Using scopings container enables to split the result fields container in domains

streams_container (Pin 3)

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

result file container allowed to be kept open to cache data

data_sources (Pin 4)

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

result file path container, used if no streams are set

result_name (Pin 17)

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

name of the result to read. By default the name of the operator is taken.

region_scoping (Pin 25)

• Required: No
• Expected type(s): scoping, vector<int32>, int32

Optional zone name/Id of the mesh.

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.

fields (Pin 0)

• Expected type(s): fields_container

Results

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: result

Plugin: cgns

Scripting name: cgns_result_provider

Full name: result.cgns_result_provider

Internal name: cgns::cgns::result_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("cgns::cgns::result_provider"); // operator instantiation
op.connect(0, my_time_scoping);
op.connect(1, my_mesh_scoping);
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(17, my_result_name);
op.connect(25, my_region_scoping);
ansys::dpf::FieldsContainer my_fields = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.result.cgns_result_provider() # operator instantiation
op.inputs.time_scoping.connect(my_time_scoping)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.result_name.connect(my_result_name)
op.inputs.region_scoping.connect(my_region_scoping)
my_fields = op.outputs.fields()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.cgns_result_provider() # operator instantiation
op.inputs.time_scoping.Connect(my_time_scoping)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.result_name.Connect(my_result_name)
op.inputs.region_scoping.Connect(my_region_scoping)
my_fields = op.outputs.fields.GetData()

Changelog

• Version 0.0.0: Initial release.