## On this page

  

 

 # metadata:cyclic support provider

 Last update: 31.07.2026 

**Version: 0.0.0**

## Description

Read the cyclic support (DPF entity containing necessary information for expansions) and expands the mesh.

## Supported file types

This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) 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.

Pin numberNameStatusExpected type(s)**3**[streams\_container](#input_3)[`streams_container`](../../core-concepts/dpf-types.md#streams-container)**4**[data\_sources](#input_4)Required[`data_sources`](../../core-concepts/dpf-types.md#data-sources)**7**[sector\_meshed\_region](#input_7)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container)**15**[expanded\_meshed\_region](#input_15)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container)**18**[sectors\_to\_expand](#input_18)[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types)<a id="input_3"></a>

### streams\_container (Pin 3)

- **Required:** No
- **Expected type(s):** [`streams_container`](../../core-concepts/dpf-types.md#streams-container)

Streams containing the result file.

<a id="input_4"></a>

### data\_sources (Pin 4)

- **Required:** Yes
- **Expected type(s):** [`data_sources`](../../core-concepts/dpf-types.md#data-sources)

data sources containing the result file.

<a id="input_7"></a>

### sector\_meshed\_region (Pin 7)

- **Required:** No
- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container)

mesh of the first sector.

<a id="input_15"></a>

### expanded\_meshed\_region (Pin 15)

- **Required:** No
- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container)

if this pin is set, expanding the mesh is not necessary.

<a id="input_18"></a>

### sectors\_to\_expand (Pin 18)

- **Required:** No
- **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types)

sectors to expand (start at 0), for multistage: use scopings container with 'stage' label.

## 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 numberNameExpected type(s)0[cyclic\_support](#output_0)[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support)**1**[sector\_meshes](#output_1)[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container)<a id="output_0"></a>

### cyclic\_support (Pin 0)

- **Expected type(s):** [`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support)

<a id="output_1"></a>

### sector\_meshes (Pin 1)

- **Expected type(s):** [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container)

## Configurations

This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior.

### [mutex](../../core-concepts/operator-configurations.md#mutex)

- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

### [num\_threads](../../core-concepts/operator-configurations.md#num_threads)

- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** 0

Number of threads to use to run in parallel

### [run\_in\_parallel](../../core-concepts/operator-configurations.md#run_in_parallel)

- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **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**: cyclic\_support\_provider

**Full name**: metadata.cyclic\_support\_provider

**Internal name**: support\_provider\_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.

C++```cpp
#include "dpf_api.h"

ansys::dpf::Operator op("support_provider_cyclic"); // operator instantiation
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(7, my_sector_meshed_region);
op.connect(15, my_expanded_meshed_region);
op.connect(18, my_sectors_to_expand);
ansys::dpf::CyclicSupport my_cyclic_support = op.getOutput<ansys::dpf::CyclicSupport>(0);
ansys::dpf::MeshesContainer my_sector_meshes = op.getOutput<ansys::dpf::MeshesContainer>(1);

```

CPython```python
import ansys.dpf.core as dpf

op = dpf.operators.metadata.cyclic_support_provider() # operator instantiation
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.sector_meshed_region.connect(my_sector_meshed_region)
op.inputs.expanded_meshed_region.connect(my_expanded_meshed_region)
op.inputs.sectors_to_expand.connect(my_sectors_to_expand)
my_cyclic_support = op.outputs.cyclic_support()
my_sector_meshes = op.outputs.sector_meshes()

```

IPython```python
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.metadata.cyclic_support_provider() # operator instantiation
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.sector_meshed_region.Connect(my_sector_meshed_region)
op.inputs.expanded_meshed_region.Connect(my_expanded_meshed_region)
op.inputs.sectors_to_expand.Connect(my_sectors_to_expand)
my_cyclic_support = op.outputs.cyclic_support.GetData()
my_sector_meshes = op.outputs.sector_meshes.GetData()

```

  
## Changelog

- Version 0.0.0: Initial release.