averaging:to elemental (fields container)

Version: 0.0.0

Description

Transforms Input fields into Elemental fields using an averaging process. The result is computed on a given element's scoping.

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.

fields_container (Pin 0)

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

mesh (Pin 1)

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

mesh_scoping (Pin 3)

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

smoothen_values (Pin 7)

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

if it is set to true, Elemental Nodal fields are first averaged on nodes and then averaged on elements (default is false).

collapse_shell_layers (Pin 10)

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

If true, the data across different shell layers is averaged as well (default is false).

merge_solid_shell (Pin 26)

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

For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified.

shell_layer (Pin 27)

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

0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

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

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.

Scripting

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

Category: averaging

Plugin: core

Scripting name: to_elemental_fc

Full name: averaging.to_elemental_fc

Internal name: to_elemental_fc

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("to_elemental_fc"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_mesh);
op.connect(3, my_mesh_scoping);
op.connect(7, my_smoothen_values);
op.connect(10, my_collapse_shell_layers);
op.connect(26, my_merge_solid_shell);
op.connect(27, my_shell_layer);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.averaging.to_elemental_fc() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.mesh.connect(my_mesh)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.smoothen_values.connect(my_smoothen_values)
op.inputs.collapse_shell_layers.connect(my_collapse_shell_layers)
op.inputs.merge_solid_shell.connect(my_merge_solid_shell)
op.inputs.shell_layer.connect(my_shell_layer)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.averaging.to_elemental_fc() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.mesh.Connect(my_mesh)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.smoothen_values.Connect(my_smoothen_values)
op.inputs.collapse_shell_layers.Connect(my_collapse_shell_layers)
op.inputs.merge_solid_shell.Connect(my_merge_solid_shell)
op.inputs.shell_layer.Connect(my_shell_layer)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.