result:cyclic expansion

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.

time_scoping (Pin 0)

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

mesh_scoping (Pin 1)

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

fields_container (Pin 2)

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

field container with the base and duplicate sectors

harmonic_index (Pin 3)

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

bool_rotate_to_global (Pin 5)

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

default is true

map_size_scoping_out (Pin 6)

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

map provider by scoping adapter

normalization_factor (Pin 7)

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

merge_stages (Pin 14)

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

cyclic_support (Pin 16)

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

sectors_to_expand (Pin 18)

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

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

phi (Pin 19)

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

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.

fields_container (Pin 0)

• Expected type(s): fields_container

FieldsContainer filled in

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.

use_cache

• Expected type(s): bool
• 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.

#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);

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()

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.