## On this page

  

 

 # result:cyclic expansion

 Last update: 31.07.2026 

**Version: 0.0.0**

## Description

Expand cyclic results from a fieldsContainer for given sets, sectors and scoping (optionals).

## 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)0[time\_scoping](#input_0)[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types)**1**[mesh\_scoping](#input_1)[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types)**2**[fields\_container](#input_2)Required[`fields_container`](../../core-concepts/dpf-types.md#fields-container)**3**[harmonic\_index](#input_3)[`int32`](../../core-concepts/dpf-types.md#standard-types)**5**[bool\_rotate\_to\_global](#input_5)[`bool`](../../core-concepts/dpf-types.md#standard-types)**6**[map\_size\_scoping\_out](#input_6)`umap<int32,int32>`**7**[normalization\_factor](#input_7)[`double`](../../core-concepts/dpf-types.md#standard-types)**14**[merge\_stages](#input_14)[`bool`](../../core-concepts/dpf-types.md#standard-types)**16**[cyclic\_support](#input_16)Required[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support)**18**[sectors\_to\_expand](#input_18)[`vector<int32>`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container)**19**[phi](#input_19)[`double`](../../core-concepts/dpf-types.md#standard-types)<a id="input_0"></a>

### time\_scoping (Pin 0)

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

<a id="input_1"></a>

### mesh\_scoping (Pin 1)

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

<a id="input_2"></a>

### fields\_container (Pin 2)

- **Required:** Yes
- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

field container with the base and duplicate sectors

<a id="input_3"></a>

### harmonic\_index (Pin 3)

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

<a id="input_5"></a>

### bool\_rotate\_to\_global (Pin 5)

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

default is true

<a id="input_6"></a>

### map\_size\_scoping\_out (Pin 6)

- **Required:** No
- **Expected type(s):** `umap<int32,int32>`

map provider by scoping adapter

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

### normalization\_factor (Pin 7)

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

<a id="input_14"></a>

### merge\_stages (Pin 14)

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

<a id="input_16"></a>

### cyclic\_support (Pin 16)

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

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

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

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

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

<a id="input_19"></a>

### phi (Pin 19)

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

angle phi in degrees (default value 0.0)

## 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[fields\_container](#output_0)[`fields_container`](../../core-concepts/dpf-types.md#fields-container)<a id="output_0"></a>

### fields\_container (Pin 0)

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

FieldsContainer filled in

## 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.

### [use\_cache](../../core-concepts/operator-configurations.md#use_cache)

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

Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run.

## Scripting

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

**Category**: result

**Plugin**: core

**Scripting name**: cyclic\_expansion

**Full name**: result.cyclic\_expansion

**Internal name**: cyclic\_expansion

**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("cyclic_expansion"); // operator instantiation
op.connect(0, my_time_scoping);
op.connect(1, my_mesh_scoping);
op.connect(2, my_fields_container);
op.connect(3, my_harmonic_index);
op.connect(5, my_bool_rotate_to_global);
op.connect(6, my_map_size_scoping_out);
op.connect(7, my_normalization_factor);
op.connect(14, my_merge_stages);
op.connect(16, my_cyclic_support);
op.connect(18, my_sectors_to_expand);
op.connect(19, my_phi);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

```

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

op = dpf.operators.result.cyclic_expansion() # operator instantiation
op.inputs.time_scoping.connect(my_time_scoping)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.fields_container.connect(my_fields_container)
op.inputs.harmonic_index.connect(my_harmonic_index)
op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
op.inputs.map_size_scoping_out.connect(my_map_size_scoping_out)
op.inputs.normalization_factor.connect(my_normalization_factor)
op.inputs.merge_stages.connect(my_merge_stages)
op.inputs.cyclic_support.connect(my_cyclic_support)
op.inputs.sectors_to_expand.connect(my_sectors_to_expand)
op.inputs.phi.connect(my_phi)
my_fields_container = op.outputs.fields_container()

```

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

op = dpf.operators.result.cyclic_expansion() # operator instantiation
op.inputs.time_scoping.Connect(my_time_scoping)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.harmonic_index.Connect(my_harmonic_index)
op.inputs.bool_rotate_to_global.Connect(my_bool_rotate_to_global)
op.inputs.map_size_scoping_out.Connect(my_map_size_scoping_out)
op.inputs.normalization_factor.Connect(my_normalization_factor)
op.inputs.merge_stages.Connect(my_merge_stages)
op.inputs.cyclic_support.Connect(my_cyclic_support)
op.inputs.sectors_to_expand.Connect(my_sectors_to_expand)
op.inputs.phi.Connect(my_phi)
my_fields_container = op.outputs.fields_container.GetData()

```

  
## Changelog

- Version 0.0.0: Initial release.