averaging:nodal difference (field)
Last update: 31.07.2026Version: 0.0.0
Description
Transforms an Elemental Nodal field into a Nodal field. Each nodal value is the maximum difference between the unaveraged computed result for all elements that share this particular node. The result is computed on a given node'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.
| Pin number | Name | Status | Expected type(s) |
|---|---|---|---|
| 0 | field | Required | field, fields_container |
| 1 | mesh_scoping | scoping |
|
| 7 | mesh | abstract_meshed_region |
field (Pin 0)
- Required: Yes
- Expected type(s):
field,fields_container
field or fields container with only one field is expected
mesh_scoping (Pin 1)
- Required: No
- Expected type(s):
scoping
average only on these entities
mesh (Pin 7)
- Required: No
- Expected type(s):
abstract_meshed_region
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: nodal_difference
Full name: averaging.nodal_difference
Internal name: nodal_difference
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("nodal_difference"); // operator instantiation
op.connect(0, my_field);
op.connect(1, my_mesh_scoping);
op.connect(7, my_mesh);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.averaging.nodal_difference() # operator instantiation
op.inputs.field.connect(my_field)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.mesh.connect(my_mesh)
my_field = op.outputs.field()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.averaging.nodal_difference() # operator instantiation
op.inputs.field.Connect(my_field)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.mesh.Connect(my_mesh)
my_field = op.outputs.field.GetData()
Changelog
- Version 0.0.0: Initial release.