Skip to main content

DPF Framework 2026 R1

utility:cyclic support get attribute

Last update: 31.07.2026

Version: 0.0.0

Description

A CyclicSupport in pin 0 and a property name (string) in pin 1 are expected in input.

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.

Pin number Name Status Expected type(s)
0 cyclic_support Required cyclic_support
1 property_name Required string

cyclic_support (Pin 0)

property_name (Pin 1)

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

Accepted inputs are: 'element_duplicate_offset' and 'node_duplicate_offset' (returns int).

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.

Pin number Name Expected type(s)
0 property string, int32

property (Pin 0)

Property value.

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

Full name: utility.cyclic_support_get_attribute

Internal name: cyclic_support::get_attribute

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.

C++
#include "dpf_api.h"

ansys::dpf::Operator op("cyclic_support::get_attribute"); // operator instantiation
op.connect(0, my_cyclic_support);
op.connect(1, my_property_name);
std::string my_property = op.getOutput<std::string>(0);
CPython
import ansys.dpf.core as dpf

op = dpf.operators.utility.cyclic_support_get_attribute() # operator instantiation
op.inputs.cyclic_support.connect(my_cyclic_support)
op.inputs.property_name.connect(my_property_name)
my_property_as_string = op.outputs.property_as_string()
IPython
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.cyclic_support_get_attribute() # operator instantiation
op.inputs.cyclic_support.Connect(my_cyclic_support)
op.inputs.property_name.Connect(my_property_name)
my_property = op.outputs.property.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys