averaging:elemental mean (fields container)

Version: 0.0.0

Description

Computes the average of a multi-entity container of fields, (ElementalNodal -> Elemental), (NodalElemental -> Nodal). If the input fields are mixed shell/solid and collapseShellLayers is false, then the fields could be split by element shape and the output fields container would have an elshape label depending on the e_shell_layer and merge_solid_shell inputs (if e_shell_layer is not specified, the fields are split; if it is specified, the fields can be split based on merge_solid_shell).If collapseShellLayers is true, all available shell layers are collapsed and shells and solid fields are always merged.

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

collapse_shell_layers (Pin 1)

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

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

force_averaging (Pin 2)

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

If true you average, if false you just sum.

scoping (Pin 3)

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

Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields container.

abstract_meshed_region (Pin 4)

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

The mesh region in this pin is used to perform the averaging. It is used if there is no fields support.

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). This pin only has an effect when collapse_shell_layers is false and a value for e_shell_layer is provided.

e_shell_layer (Pin 27)

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

0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.

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.

Scripting

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

Category: averaging

Plugin: core

Scripting name: elemental_mean_fc

Full name: averaging.elemental_mean_fc

Internal name: entity_average_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("entity_average_fc"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_collapse_shell_layers);
op.connect(2, my_force_averaging);
op.connect(3, my_scoping);
op.connect(4, my_abstract_meshed_region);
op.connect(26, my_merge_solid_shell);
op.connect(27, my_e_shell_layer);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.averaging.elemental_mean_fc() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.collapse_shell_layers.connect(my_collapse_shell_layers)
op.inputs.force_averaging.connect(my_force_averaging)
op.inputs.scoping.connect(my_scoping)
op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
op.inputs.merge_solid_shell.connect(my_merge_solid_shell)
op.inputs.e_shell_layer.connect(my_e_shell_layer)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.averaging.elemental_mean_fc() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.collapse_shell_layers.Connect(my_collapse_shell_layers)
op.inputs.force_averaging.Connect(my_force_averaging)
op.inputs.scoping.Connect(my_scoping)
op.inputs.abstract_meshed_region.Connect(my_abstract_meshed_region)
op.inputs.merge_solid_shell.Connect(my_merge_solid_shell)
op.inputs.e_shell_layer.Connect(my_e_shell_layer)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.