result:record reader

Version: 0.0.0

Description

Extracts a record from a file.

Supported file types

This operator supports the following keys (file formats) for each listed namespace (plugin/solver):

• mapdl: rst, rstp, rth

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.

streams (Pin 3)

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

data_sources (Pin 4)

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

record_name (Pin 60)

• Required: Yes
• Expected type(s):

Name of the record that must be extracted from the file.

For example to read the nodal solution of the 4th set, input should be RST::DSI::SET4::NSL

The MAPDL records tree can be found in the following links:

• Ansys Help - Retrieving Data from the Results File

• Ansys Help - Description of the Results 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 (Pin 0)

• Expected type(s): property_field, field

Output is of type property_field for integer records and of type field for double records.

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

Scripting name: record_reader

Full name: result.record_reader

Internal name: record_reader

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("record_reader"); // operator instantiation
op.connect(3, my_streams);
op.connect(4, my_data_sources);
op.connect(60, my_record_name);
ansys::dpf::PropertyField my_field = op.getOutput<ansys::dpf::PropertyField>(0);

import ansys.dpf.core as dpf

op = dpf.operators.result.record_reader() # operator instantiation
op.inputs.streams.connect(my_streams)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.record_name.connect(my_record_name)
my_field_as_property_field = op.outputs.field_as_property_field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.record_reader() # operator instantiation
op.inputs.streams.Connect(my_streams)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.record_name.Connect(my_record_name)
my_field = op.outputs.field.GetData()

Changelog

• Version 0.0.0: Initial release.