DPF Framework 2026 R1

mapping:prepare mechanical native mapping with kriging

Last update: 31.07.2026

Version: 0.0.0

Description

Prepare mapping of source data from source mesh to target mesh by operating the source_mesh/target_mesh weights computation. This operator will use a point kriging algorithm. This operator needs to be used with the apply mechanical native mapping associated one.

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 source_mesh Required abstract_meshed_region
1 target_mesh Required abstract_meshed_region, field
3 target_mesh_scoping scoping
4 unit string
5 location Required string
6 dimensionality Required int32
7 e_shell_layers int32
8 html_report_path string
9 threads_user_requested int32
10 samples_limit int32
11 correlation_function_type string
12 polynomial_type string
13 outside_distance_checking bool
14 bounding_box_tolerance double
15 adaptive_tolerance_percent double
16 geometry_type string
100 is_element_centroidal_data_mapping bool
101 projection_options data_tree
102 dynamic_coordinate_system data_tree
103 source_dimension string
104 wb_external_data_info data_tree
105 target_dimension string

source_mesh (Pin 0)

Source mesh

target_mesh (Pin 1)

Target mesh/coordinates

target_mesh_scoping (Pin 3)

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

Target mesh scoping. If used, ensure to give only the elements where results are expected into source mesh input to have optimized computation.

unit (Pin 4)

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

Unit of the result to map

location (Pin 5)

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

Location of the result to map

dimensionality (Pin 6)

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

Dimensionality of the result to map (for example it will be 3 for a displacement along (x, y, z) axes).

e_shell_layers (Pin 7)

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

EShellLayers enum value if field has shell layers

html_report_path (Pin 8)

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

Path for html report (for example 'my_disk/my_report.html'). If set, an html report will be generated and exported to the html file. If not set, nothing will be generated.

threads_user_requested (Pin 9)

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

Number of threads to be used to parallelize apply operations.

samples_limit (Pin 10)

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

Default is 20

correlation_function_type (Pin 11)

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

Default is 'gaussian'. Can also be 'exponential', 'linear', 'none', 'spherical', 'cubic', 'multi_quadratic', 'thin_plate_spline'.

polynomial_type (Pin 12)

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

Default is 'adaptive'. Can also be 'pure_quadratic', 'linear', 'constant', 'none'.

outside_distance_checking (Pin 13)

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

Default is false

bounding_box_tolerance (Pin 14)

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

Default is 0.0

adaptive_tolerance_percent (Pin 15)

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

Default is 0.1 (corresponds to 10%)

geometry_type (Pin 16)

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

Default is 'volume'. Can also be 'surface'.

is_element_centroidal_data_mapping (Pin 100)

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

Default is 'false'. Set to 'true' if the source elemental data is representing as element centroidal nodal data

projection_options (Pin 101)

Default is empty. This data tree contains 2D projection options for mapping 2D to 3D

dynamic_coordinate_system (Pin 102)

Default is empty. This data tree contains the dynamic coordinate system for performing rigid body transformation on the source mesh

source_dimension (Pin 103)

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

Default is empty string. The string contains either "2D" or "3D" which specifies the source dimension

wb_external_data_info (Pin 104)

Default is empty. This data tree contains the Rigid & Analytical transformations specified in the workbench external data system

target_dimension (Pin 105)

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

Default is empty string. The string contains either "2D" or "3D" which specifies the target dimension

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 source_mesh abstract_meshed_region
1 source_mesh_id int32
2 target_mesh abstract_meshed_region
3 target_mesh_id int32
4 mapping_manager_data
6 target_scoping scoping
7 prepare_output

source_mesh (Pin 0)

Source mesh

source_mesh_id (Pin 1)

  • Expected type(s): int32

Source mesh id

target_mesh (Pin 2)

Target mesh

target_mesh_id (Pin 3)

  • Expected type(s): int32

Target mesh id

mapping_manager_data (Pin 4)

  • Expected type(s):

target_scoping (Pin 6)

Target scoping

prepare_output (Pin 7)

  • Expected type(s):

A Map containing the outputs of the mapping as a key value pair

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: N/A

Scripting name: prepare_mechanical_native_mapping_kriging

Full name: mapping.prepare_mechanical_native_mapping_kriging

Internal name: mechanical_native_mapping::prepare::kriging

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("mechanical_native_mapping::prepare::kriging"); // operator instantiation
op.connect(0, my_source_mesh);
op.connect(1, my_target_mesh);
op.connect(3, my_target_mesh_scoping);
op.connect(4, my_unit);
op.connect(5, my_location);
op.connect(6, my_dimensionality);
op.connect(7, my_e_shell_layers);
op.connect(8, my_html_report_path);
op.connect(9, my_threads_user_requested);
op.connect(10, my_samples_limit);
op.connect(11, my_correlation_function_type);
op.connect(12, my_polynomial_type);
op.connect(13, my_outside_distance_checking);
op.connect(14, my_bounding_box_tolerance);
op.connect(15, my_adaptive_tolerance_percent);
op.connect(16, my_geometry_type);
op.connect(100, my_is_element_centroidal_data_mapping);
op.connect(101, my_projection_options);
op.connect(102, my_dynamic_coordinate_system);
op.connect(103, my_source_dimension);
op.connect(104, my_wb_external_data_info);
op.connect(105, my_target_dimension);
ansys::dpf::MeshedRegion my_source_mesh = op.getOutput<ansys::dpf::MeshedRegion>(0);
int my_source_mesh_id = op.getOutput<int>(1);
ansys::dpf::MeshedRegion my_target_mesh = op.getOutput<ansys::dpf::MeshedRegion>(2);
int my_target_mesh_id = op.getOutput<int>(3);
 my_mapping_manager_data = op.getOutput<>(4);
ansys::dpf::Scoping my_target_scoping = op.getOutput<ansys::dpf::Scoping>(6);
 my_prepare_output = op.getOutput<>(7);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.mapping.prepare_mechanical_native_mapping_kriging() # operator instantiation
op.inputs.source_mesh.connect(my_source_mesh)
op.inputs.target_mesh.connect(my_target_mesh)
op.inputs.target_mesh_scoping.connect(my_target_mesh_scoping)
op.inputs.unit.connect(my_unit)
op.inputs.location.connect(my_location)
op.inputs.dimensionality.connect(my_dimensionality)
op.inputs.e_shell_layers.connect(my_e_shell_layers)
op.inputs.html_report_path.connect(my_html_report_path)
op.inputs.threads_user_requested.connect(my_threads_user_requested)
op.inputs.samples_limit.connect(my_samples_limit)
op.inputs.correlation_function_type.connect(my_correlation_function_type)
op.inputs.polynomial_type.connect(my_polynomial_type)
op.inputs.outside_distance_checking.connect(my_outside_distance_checking)
op.inputs.bounding_box_tolerance.connect(my_bounding_box_tolerance)
op.inputs.adaptive_tolerance_percent.connect(my_adaptive_tolerance_percent)
op.inputs.geometry_type.connect(my_geometry_type)
op.inputs.is_element_centroidal_data_mapping.connect(my_is_element_centroidal_data_mapping)
op.inputs.projection_options.connect(my_projection_options)
op.inputs.dynamic_coordinate_system.connect(my_dynamic_coordinate_system)
op.inputs.source_dimension.connect(my_source_dimension)
op.inputs.wb_external_data_info.connect(my_wb_external_data_info)
op.inputs.target_dimension.connect(my_target_dimension)
my_source_mesh = op.outputs.source_mesh()
my_source_mesh_id = op.outputs.source_mesh_id()
my_target_mesh = op.outputs.target_mesh()
my_target_mesh_id = op.outputs.target_mesh_id()
my_mapping_manager_data = op.outputs.mapping_manager_data()
my_target_scoping = op.outputs.target_scoping()
my_prepare_output = op.outputs.prepare_output()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.mapping.prepare_mechanical_native_mapping_kriging() # operator instantiation
op.inputs.source_mesh.Connect(my_source_mesh)
op.inputs.target_mesh.Connect(my_target_mesh)
op.inputs.target_mesh_scoping.Connect(my_target_mesh_scoping)
op.inputs.unit.Connect(my_unit)
op.inputs.location.Connect(my_location)
op.inputs.dimensionality.Connect(my_dimensionality)
op.inputs.e_shell_layers.Connect(my_e_shell_layers)
op.inputs.html_report_path.Connect(my_html_report_path)
op.inputs.threads_user_requested.Connect(my_threads_user_requested)
op.inputs.samples_limit.Connect(my_samples_limit)
op.inputs.correlation_function_type.Connect(my_correlation_function_type)
op.inputs.polynomial_type.Connect(my_polynomial_type)
op.inputs.outside_distance_checking.Connect(my_outside_distance_checking)
op.inputs.bounding_box_tolerance.Connect(my_bounding_box_tolerance)
op.inputs.adaptive_tolerance_percent.Connect(my_adaptive_tolerance_percent)
op.inputs.geometry_type.Connect(my_geometry_type)
op.inputs.is_element_centroidal_data_mapping.Connect(my_is_element_centroidal_data_mapping)
op.inputs.projection_options.Connect(my_projection_options)
op.inputs.dynamic_coordinate_system.Connect(my_dynamic_coordinate_system)
op.inputs.source_dimension.Connect(my_source_dimension)
op.inputs.wb_external_data_info.Connect(my_wb_external_data_info)
op.inputs.target_dimension.Connect(my_target_dimension)
my_source_mesh = op.outputs.source_mesh.GetData()
my_source_mesh_id = op.outputs.source_mesh_id.GetData()
my_target_mesh = op.outputs.target_mesh.GetData()
my_target_mesh_id = op.outputs.target_mesh_id.GetData()
my_mapping_manager_data = op.outputs.mapping_manager_data.GetData()
my_target_scoping = op.outputs.target_scoping.GetData()
my_prepare_output = op.outputs.prepare_output.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys