metadata:real constants provider

Version: 0.0.0

Description

Reads real constants from the result files contained in the streams or data sources.

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.

solver_real_constants_ids (Pin 1)

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

Real Constant ids to recover used by the solver. If not set, all available real constants to be recovered.

streams (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.

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.

real_constants (Pin 0)

• Expected type(s): field

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.

num_threads

• Expected type(s): int32
• Default value: 0

Number of threads to use to run in parallel

run_in_parallel

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

Loops are allowed to run in parallel if the value of this config is set to true.

Scripting

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

Category: metadata

Plugin: core

Scripting name: real_constants_provider

Full name: metadata.real_constants_provider

Internal name: real_constants_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("real_constants_provider"); // operator instantiation
op.connect(1, my_solver_real_constants_ids);
op.connect(3, my_streams);
op.connect(4, my_data_sources);
ansys::dpf::Field my_real_constants = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.metadata.real_constants_provider() # operator instantiation
op.inputs.solver_real_constants_ids.connect(my_solver_real_constants_ids)
op.inputs.streams.connect(my_streams)
op.inputs.data_sources.connect(my_data_sources)
my_real_constants = op.outputs.real_constants()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.metadata.real_constants_provider() # operator instantiation
op.inputs.solver_real_constants_ids.Connect(my_solver_real_constants_ids)
op.inputs.streams.Connect(my_streams)
op.inputs.data_sources.Connect(my_data_sources)
my_real_constants = op.outputs.real_constants.GetData()

Changelog

• Version 0.0.0: Initial release.