## On this page

  

 

 # mapping:create system coupling mapping workflow

 Last update: 31.07.2026 

**Version: 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 numberNameStatusExpected type(s)0[source\_mesh](#input_0)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)**1**[target\_mesh](#input_1)[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)**2**[is\_conservative](#input_2)[`bool`](../../core-concepts/dpf-types.md#standard-types)**3**[location](#input_3)[`string`](../../core-concepts/dpf-types.md#standard-types)**4**[dimensionality](#input_4)[`int32`](../../core-concepts/dpf-types.md#standard-types)**5**[is\_pointcloud](#input_5)[`bool`](../../core-concepts/dpf-types.md#standard-types)**6**[target\_scoping](#input_6)[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container)<a id="input_0"></a>

### source\_mesh (Pin 0)

- **Required:** No
- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

Mesh where the source data is defined. PointCloud interpolations support both mesh/meshes\_container and field/fields\_container, whereas mesh-based interpolations only support mesh/meshes\_container. If not set, an input pin named "source\_mesh/source\_coords" is exposed.

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

### target\_mesh (Pin 1)

- **Required:** No
- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

Mesh where the target data is defined. PointCloud interpolations support both mesh/meshes\_container and field/fields\_container, whereas mesh-based interpolations only support mesh/meshes\_container. If not set, an input pin named "source\_mesh/source\_coords" is exposed.

<a id="input_2"></a>

### is\_conservative (Pin 2)

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

Boolean that indicates if the mapped variable is conservative (e.g. force) or not (e.g. pressure). If not set, an input pin named "is\_conservative" is exposed.

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

### location (Pin 3)

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

Mesh support of the mapped variable. Supported options: Nodal and Elemental. If not set, an input pin named "location" is exposed.

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

### dimensionality (Pin 4)

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

Dimensionality of the mapped variable. Supported options: 1 and 3 (scalars or vectors). If not set, an input pin named "dimensionality" is exposed.

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

### is\_pointcloud (Pin 5)

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

Boolean that indicates if the PointCloud interpolation is preferred over the FEM interpolation. Default: false.

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

### target\_scoping (Pin 6)

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

Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh. If not set, an input pin named "target\_scoping" is exposed.

## 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[mapping\_workflow](#output_0)[`workflow`](../../core-concepts/dpf-types.md#workflow)<a id="output_0"></a>

### mapping\_workflow (Pin 0)

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

Workflow with input pin "source\_data"; optionally "source\_mesh/source\_coords", "target\_mesh/target\_coords", "is\_conservative", "location", "dimensionality" and "target\_scoping"; and output pin "target\_data".

## 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.

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

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

If permissive is set to false, the validity of the source and target meshes is checked before performing mapping, raising an error if they are invalid. If permissive is set to true, no check is done. Default is true.

## Scripting

This operator can be accessed through scripting interfaces using these identifiers.

**Category**: mapping

**Plugin**: N/A

**Scripting name**: None

**Full name**: None

**Internal name**: create\_sc\_mapping\_workflow

**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("create_sc_mapping_workflow"); // operator instantiation
op.connect(0, my_source_mesh);
op.connect(1, my_target_mesh);
op.connect(2, my_is_conservative);
op.connect(3, my_location);
op.connect(4, my_dimensionality);
op.connect(5, my_is_pointcloud);
op.connect(6, my_target_scoping);
ansys::dpf::Workflow my_mapping_workflow = op.getOutput<ansys::dpf::Workflow>(0);

```

CPython```python
import ansys.dpf.core as dpf

op = dpf.operators.mapping.None() # operator instantiation
op.inputs.source_mesh.connect(my_source_mesh)
op.inputs.target_mesh.connect(my_target_mesh)
op.inputs.is_conservative.connect(my_is_conservative)
op.inputs.location.connect(my_location)
op.inputs.dimensionality.connect(my_dimensionality)
op.inputs.is_pointcloud.connect(my_is_pointcloud)
op.inputs.target_scoping.connect(my_target_scoping)
my_mapping_workflow = op.outputs.mapping_workflow()

```

IPython```python
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.mapping.None() # operator instantiation
op.inputs.source_mesh.Connect(my_source_mesh)
op.inputs.target_mesh.Connect(my_target_mesh)
op.inputs.is_conservative.Connect(my_is_conservative)
op.inputs.location.Connect(my_location)
op.inputs.dimensionality.Connect(my_dimensionality)
op.inputs.is_pointcloud.Connect(my_is_pointcloud)
op.inputs.target_scoping.Connect(my_target_scoping)
my_mapping_workflow = op.outputs.mapping_workflow.GetData()

```

  
## Changelog

- Version 0.0.0: Initial release.