## On this page

  

 

 # 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 numberNameStatusExpected type(s)0[source\_mesh](#input_0)Required[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)**1**[target\_mesh](#input_1)Required[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field)**3**[target\_mesh\_scoping](#input_3)[`scoping`](../../core-concepts/dpf-types.md#scoping)**4**[unit](#input_4)[`string`](../../core-concepts/dpf-types.md#standard-types)**5**[location](#input_5)Required[`string`](../../core-concepts/dpf-types.md#standard-types)**6**[dimensionality](#input_6)Required[`int32`](../../core-concepts/dpf-types.md#standard-types)**7**[e\_shell\_layers](#input_7)[`int32`](../../core-concepts/dpf-types.md#standard-types)**8**[html\_report\_path](#input_8)[`string`](../../core-concepts/dpf-types.md#standard-types)**9**[threads\_user\_requested](#input_9)[`int32`](../../core-concepts/dpf-types.md#standard-types)**10**[samples\_limit](#input_10)[`int32`](../../core-concepts/dpf-types.md#standard-types)**11**[correlation\_function\_type](#input_11)[`string`](../../core-concepts/dpf-types.md#standard-types)**12**[polynomial\_type](#input_12)[`string`](../../core-concepts/dpf-types.md#standard-types)**13**[outside\_distance\_checking](#input_13)[`bool`](../../core-concepts/dpf-types.md#standard-types)**14**[bounding\_box\_tolerance](#input_14)[`double`](../../core-concepts/dpf-types.md#standard-types)**15**[adaptive\_tolerance\_percent](#input_15)[`double`](../../core-concepts/dpf-types.md#standard-types)**16**[geometry\_type](#input_16)[`string`](../../core-concepts/dpf-types.md#standard-types)**100**[is\_element\_centroidal\_data\_mapping](#input_100)[`bool`](../../core-concepts/dpf-types.md#standard-types)**101**[projection\_options](#input_101)[`data_tree`](../../core-concepts/dpf-types.md#data-tree)**102**[dynamic\_coordinate\_system](#input_102)[`data_tree`](../../core-concepts/dpf-types.md#data-tree)**103**[source\_dimension](#input_103)[`string`](../../core-concepts/dpf-types.md#standard-types)**104**[wb\_external\_data\_info](#input_104)[`data_tree`](../../core-concepts/dpf-types.md#data-tree)**105**[target\_dimension](#input_105)[`string`](../../core-concepts/dpf-types.md#standard-types)<a id="input_0"></a>

### source\_mesh (Pin 0)

- **Required:** Yes
- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)

Source mesh

<a id="input_1"></a>

### target\_mesh (Pin 1)

- **Required:** Yes
- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field)

Target mesh/coordinates

<a id="input_3"></a>

### target\_mesh\_scoping (Pin 3)

- **Required:** No
- **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping)

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

<a id="input_4"></a>

### unit (Pin 4)

- **Required:** No
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

Unit of the result to map

<a id="input_5"></a>

### location (Pin 5)

- **Required:** Yes
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

Location of the result to map

<a id="input_6"></a>

### dimensionality (Pin 6)

- **Required:** Yes
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)

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

<a id="input_7"></a>

### e\_shell\_layers (Pin 7)

- **Required:** No
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)

EShellLayers enum value if field has shell layers

<a id="input_8"></a>

### html\_report\_path (Pin 8)

- **Required:** No
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

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.

<a id="input_9"></a>

### threads\_user\_requested (Pin 9)

- **Required:** No
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)

Number of threads to be used to parallelize apply operations.

<a id="input_10"></a>

### samples\_limit (Pin 10)

- **Required:** No
- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)

Default is 20

<a id="input_11"></a>

### correlation\_function\_type (Pin 11)

- **Required:** No
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

Default is 'gaussian'. Can also be 'exponential', 'linear', 'none', 'spherical', 'cubic', 'multi\_quadratic', 'thin\_plate\_spline'.

<a id="input_12"></a>

### polynomial\_type (Pin 12)

- **Required:** No
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

Default is 'adaptive'. Can also be 'pure\_quadratic', 'linear', 'constant', 'none'.

<a id="input_13"></a>

### outside\_distance\_checking (Pin 13)

- **Required:** No
- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)

Default is false

<a id="input_14"></a>

### bounding\_box\_tolerance (Pin 14)

- **Required:** No
- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)

Default is 0.0

<a id="input_15"></a>

### adaptive\_tolerance\_percent (Pin 15)

- **Required:** No
- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types)

Default is 0.1 (corresponds to 10%)

<a id="input_16"></a>

### geometry\_type (Pin 16)

- **Required:** No
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

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

<a id="input_100"></a>

### is\_element\_centroidal\_data\_mapping (Pin 100)

- **Required:** No
- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)

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

<a id="input_101"></a>

### projection\_options (Pin 101)

- **Required:** No
- **Expected type(s):** [`data_tree`](../../core-concepts/dpf-types.md#data-tree)

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

<a id="input_102"></a>

### dynamic\_coordinate\_system (Pin 102)

- **Required:** No
- **Expected type(s):** [`data_tree`](../../core-concepts/dpf-types.md#data-tree)

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

<a id="input_103"></a>

### source\_dimension (Pin 103)

- **Required:** No
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

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

<a id="input_104"></a>

### wb\_external\_data\_info (Pin 104)

- **Required:** No
- **Expected type(s):** [`data_tree`](../../core-concepts/dpf-types.md#data-tree)

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

<a id="input_105"></a>

### target\_dimension (Pin 105)

- **Required:** No
- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types)

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 numberNameExpected type(s)0[source\_mesh](#output_0)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)**1**[source\_mesh\_id](#output_1)[`int32`](../../core-concepts/dpf-types.md#standard-types)**2**[target\_mesh](#output_2)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)**3**[target\_mesh\_id](#output_3)[`int32`](../../core-concepts/dpf-types.md#standard-types)**4**[mapping\_manager\_data](#output_4)**6**[target\_scoping](#output_6)[`scoping`](../../core-concepts/dpf-types.md#scoping)**7**[prepare\_output](#output_7)<a id="output_0"></a>

### source\_mesh (Pin 0)

- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)

Source mesh

<a id="output_1"></a>

### source\_mesh\_id (Pin 1)

- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)

Source mesh id

<a id="output_2"></a>

### target\_mesh (Pin 2)

- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region)

Target mesh

<a id="output_3"></a>

### target\_mesh\_id (Pin 3)

- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)

Target mesh id

<a id="output_4"></a>

### mapping\_manager\_data (Pin 4)

- **Expected type(s):**

<a id="output_6"></a>

### target\_scoping (Pin 6)

- **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping)

Target scoping

<a id="output_7"></a>

### 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](../../core-concepts/operator-configurations.md) that modify its behavior.

### [mutex](../../core-concepts/operator-configurations.md#mutex)

- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **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++```cpp
#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```python
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```python
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.