mapping:on coordinates
Last update: 31.07.2026Version: 0.0.0
Description
Evaluates a result on specified coordinates (interpolates results inside elements with shape functions).
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 | fields_container | Required | fields_container |
| 1 | coordinates | Required | field, fields_container, abstract_meshed_region, meshes_container |
| 2 | create_support | bool |
|
| 3 | mapping_on_scoping | bool |
|
| 5 | tolerance | double |
|
| 7 | mesh | abstract_meshed_region, meshes_container |
|
| 200 | use_quadratic_elements | bool |
fields_container (Pin 0)
- Required: Yes
- Expected type(s):
fields_container
coordinates (Pin 1)
- Required: Yes
- Expected type(s):
field,fields_container,abstract_meshed_region,meshes_container
create_support (Pin 2)
- Required: No
- Expected type(s):
bool
if this pin is set to true, then, a support associated to the fields consisting of points is created
mapping_on_scoping (Pin 3)
- Required: No
- Expected type(s):
bool
if this pin is set to true, then the mapping between the coordinates and the fields is created only on the first field scoping
tolerance (Pin 5)
- Required: No
- Expected type(s):
double
Tolerance used in the iterative algorithm to locate coordinates inside the mesh. Default value: 5e-5.
mesh (Pin 7)
- Required: No
- Expected type(s):
abstract_meshed_region,meshes_container
if the first field in input has no mesh in support, then the mesh in this pin is expected (default is false), if a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container
use_quadratic_elements (Pin 200)
- Required: No
- Expected type(s):
bool
If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). Default 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.
| Pin number | Name | Expected type(s) |
|---|---|---|
| 0 | fields_container | fields_container |
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: mapping
Plugin: core
Scripting name: on_coordinates
Full name: mapping.on_coordinates
Internal name: mapping
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("mapping"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_coordinates);
op.connect(2, my_create_support);
op.connect(3, my_mapping_on_scoping);
op.connect(5, my_tolerance);
op.connect(7, my_mesh);
op.connect(200, my_use_quadratic_elements);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.mapping.on_coordinates() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.coordinates.connect(my_coordinates)
op.inputs.create_support.connect(my_create_support)
op.inputs.mapping_on_scoping.connect(my_mapping_on_scoping)
op.inputs.tolerance.connect(my_tolerance)
op.inputs.mesh.connect(my_mesh)
op.inputs.use_quadratic_elements.connect(my_use_quadratic_elements)
my_fields_container = op.outputs.fields_container()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.mapping.on_coordinates() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.coordinates.Connect(my_coordinates)
op.inputs.create_support.Connect(my_create_support)
op.inputs.mapping_on_scoping.Connect(my_mapping_on_scoping)
op.inputs.tolerance.Connect(my_tolerance)
op.inputs.mesh.Connect(my_mesh)
op.inputs.use_quadratic_elements.Connect(my_use_quadratic_elements)
my_fields_container = op.outputs.fields_container.GetData()
Changelog
- Version 0.0.0: Initial release.