metadata:cyclic analysis?

Version: 0.0.0

Description

Reads if the model is cyclic from the result file.

Supported file types

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

• hdf5: h5dpf
• mapdl: cms, dsub, mode, rdsp, rfrq, 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_container (Pin 3)

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

streams (result file container) (optional)

data_sources (Pin 4)

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

If the stream is null, retrieves the file path from the data sources.

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.

file_path (Pin 0)

• Expected type(s): string

returns 'single_stage' or 'multi_stage' or an empty string for non cyclic model

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.

permissive

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

If this option is set to true, warning checks (like unit or data sizes) won't be done.

Scripting

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

Category: metadata

Plugin: core

Scripting name: is_cyclic

Full name: metadata.is_cyclic

Internal name: is_cyclic

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("is_cyclic"); // operator instantiation
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
std::string my_file_path = op.getOutput<std::string>(0);

import ansys.dpf.core as dpf

op = dpf.operators.metadata.is_cyclic() # operator instantiation
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
my_file_path = op.outputs.file_path()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.metadata.is_cyclic() # operator instantiation
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
my_file_path = op.outputs.file_path.GetData()

Changelog

• Version 0.0.0: Initial release.