DPF Framework 2026 R1

averaging:elemental mean (field)

Last update: 31.07.2026

Version: 0.0.0

Description

Computes the average of a multi-entity field, (ElementalNodal -> Elemental), (NodalElemental -> Nodal).

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 number Name Status Expected type(s)
0 field Required field
1 collapse_shell_layers bool
2 force_averaging bool
3 scoping scoping

field (Pin 0)

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

collapse_shell_layers (Pin 1)

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

If true, shell layers are 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

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

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 number Name Expected type(s)
0 field field

field (Pin 0)

  • Expected type(s): field

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

Full name: averaging.elemental_mean

Internal name: entity_average

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++ 
#include "dpf_api.h"

ansys::dpf::Operator op("entity_average"); // operator instantiation
op.connect(0, my_field);
op.connect(1, my_collapse_shell_layers);
op.connect(2, my_force_averaging);
op.connect(3, my_scoping);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.averaging.elemental_mean() # operator instantiation
op.inputs.field.connect(my_field)
op.inputs.collapse_shell_layers.connect(my_collapse_shell_layers)
op.inputs.force_averaging.connect(my_force_averaging)
op.inputs.scoping.connect(my_scoping)
my_field = op.outputs.field()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.averaging.elemental_mean() # operator instantiation
op.inputs.field.Connect(my_field)
op.inputs.collapse_shell_layers.Connect(my_collapse_shell_layers)
op.inputs.force_averaging.Connect(my_force_averaging)
op.inputs.scoping.Connect(my_scoping)
my_field = op.outputs.field.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys