mapping:create mechanical native mapping for kriging workflow
Last update: 31.07.2026Version: 0.0.0
Description
Prepares a workflow able to map data from an input mesh to a target 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 | source_mesh | abstract_meshed_region |
|
| 1 | target_mesh | abstract_meshed_region |
|
| 6 | target_scoping | scoping |
|
| 10 | options_data_tree | data_tree |
source_mesh (Pin 0)
- Required: No
- Expected type(s):
abstract_meshed_region
Mesh where the source data is defined.
target_mesh (Pin 1)
- Required: No
- Expected type(s):
abstract_meshed_region
Mesh the data should be mapped on.
target_scoping (Pin 6)
- Required: No
- Expected type(s):
scoping
Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh.
options_data_tree (Pin 10)
- Required: No
- Expected type(s):
data_tree
DataTree that contains a 'mapping_options' subtree with the mapping options, and a 'data_definition' subtree with 'dimensionality' int and 'location' string attributes that are required by the 'prepare mechanical native mapping' operator (see documentation of this operator to know more about the supported options).
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 | mapping_workflow | workflow |
mapping_workflow (Pin 0)
- Expected type(s):
workflow
Workflow with input pin 'source_data'; optionally 'source_mesh', 'target_mesh', 'target_scoping', and 'options_data_tree'; and output pins 'target_data','unmapped_nodes_data','outside_nodes_data','mapping_error_codes', 'source_mesh_id' and 'target_mesh_id.
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: create_mech_kriging_workflow
Full name: mapping.create_mech_kriging_workflow
Internal name: mech_kriging_wf
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("mech_kriging_wf"); // operator instantiation
op.connect(0, my_source_mesh);
op.connect(1, my_target_mesh);
op.connect(6, my_target_scoping);
op.connect(10, my_options_data_tree);
ansys::dpf::Workflow my_mapping_workflow = op.getOutput<ansys::dpf::Workflow>(0);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.mapping.create_mech_kriging_workflow() # operator instantiation
op.inputs.source_mesh.connect(my_source_mesh)
op.inputs.target_mesh.connect(my_target_mesh)
op.inputs.target_scoping.connect(my_target_scoping)
op.inputs.options_data_tree.connect(my_options_data_tree)
my_mapping_workflow = op.outputs.mapping_workflow()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.mapping.create_mech_kriging_workflow() # operator instantiation
op.inputs.source_mesh.Connect(my_source_mesh)
op.inputs.target_mesh.Connect(my_target_mesh)
op.inputs.target_scoping.Connect(my_target_scoping)
op.inputs.options_data_tree.Connect(my_options_data_tree)
my_mapping_workflow = op.outputs.mapping_workflow.GetData()
Changelog
- Version 0.0.0: Initial release.