DPF Framework 2026 R1

geo:integrate over elements

Last update: 31.07.2026

Version: 0.0.0

Description

Integration of an input field over mesh.

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 scoping scoping
2 mesh abstract_meshed_region

field (Pin 0)

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

scoping (Pin 1)

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

Integrate the input field over a specific scoping.

mesh (Pin 2)

Mesh to integrate on. If not provided, the one from input field is employed.

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.

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: geo

Plugin: core

Scripting name: integrate_over_elements

Full name: geo.integrate_over_elements

Internal name: element::integrate

License: any_dpf_supported_increments

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("element::integrate"); // operator instantiation
op.connect(0, my_field);
op.connect(1, my_scoping);
op.connect(2, my_mesh);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.geo.integrate_over_elements() # operator instantiation
op.inputs.field.connect(my_field)
op.inputs.scoping.connect(my_scoping)
op.inputs.mesh.connect(my_mesh)
my_field = op.outputs.field()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.geo.integrate_over_elements() # operator instantiation
op.inputs.field.Connect(my_field)
op.inputs.scoping.Connect(my_scoping)
op.inputs.mesh.Connect(my_mesh)
my_field = op.outputs.field.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys