Skip to content

Commit a79c0e9

Browse files
author
4rmuuser
committed
DPF doc update for 261 (2025.10.14)
1 parent 7f86d4b commit a79c0e9

21 files changed

+216
-210
lines changed

2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ license: any_dpf_supported_increments
1010

1111
## Description
1212

13-
Applies scaling to precision to all the values from field input, then rounding to the unit.
13+
Scales a field to a given precision threshold, then rounds all the values to the unit.
1414

1515
## Inputs
1616

1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
19-
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| input_field |[`field`](../../core-concepts/dpf-types.md#field) | Input field |
20-
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types) | Threshold (precision) desired. |
19+
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| input_field |[`field`](../../core-concepts/dpf-types.md#field) | Field to quantize. |
20+
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | Precision threshold desired.<br>Case double : the threshold is applied on all the input field.<br>Case field with one value : the threshold is applied on all the input field.<br>Case field with "numComp" values : each threhsold is applied to the corresponding component of the input field.<br>Case field with the same number of values than the input field : quantization is performed component-wise.<br> |
2121

2222
## Outputs
2323

2026R1/dpf-framework-26-r1/operator-specifications/compression/quantization_fc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ license: any_dpf_supported_increments
1010

1111
## Description
1212

13-
Applies scaling to precision to all the values from fields container input, then rounding to the unit.
13+
Scales all the fields of a fields container to a given precision threshold, then rounds all the values to the unit.
1414

1515
## Inputs
1616

1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
19-
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| input_fc |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Input fields container |
20-
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Threshold (precision) desired. |
19+
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| input_fc |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container to be quantized. |
20+
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| threshold |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Precision threshold desired.<br>Case double : the threshold is applied on all the fields of the input fields container.<br>Case field with one, numComp or input size values : the threshold is used for each field of the input fields container.<br>Case fields container : the corresponding threshold field is found by matching label.<br> |
2121

2222
## Outputs
2323

2424
| Output | Name | Expected type(s) | Description |
2525
|-------|------|------------------|-------------|
26-
| **Pin 0**| output_fc |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Scaled and rounded fields container |
26+
| **Pin 0**| output_fc |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Quantized fields container. |
2727

2828
## Configurations
2929

2026R1/dpf-framework-26-r1/operator-specifications/mapping/apply_mechanical_native_mapping.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@ Maps source data from source mesh to target mesh (computes interpolation).This o
1616

1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
19-
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| source_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Source mesh |
20-
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| source_mesh_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Source mesh id |
21-
| <strong>Pin 2</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| target_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Target mesh |
22-
| <strong>Pin 3</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| target_mesh_id |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | Target mesh id |
19+
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| source_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Source mesh |
20+
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| source_mesh_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Source mesh id |
21+
| <strong>Pin 2</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| target_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Target mesh |
22+
| <strong>Pin 3</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| target_mesh_id |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Target mesh id |
2323
| <strong>Pin 4</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| mapping_manager_data | | |
24-
| <strong>Pin 5</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| source_data |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Source data |
25-
| <strong>Pin 6</strong>| target_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Target scoping the result will be scoped on |
24+
| <strong>Pin 5</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| source_data |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Source data |
25+
| <strong>Pin 6</strong>| target_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Target scoping the result will be scoped on |
2626

2727
## Outputs
2828

2929
| Output | Name | Expected type(s) | Description |
3030
|-------|------|------------------|-------------|
31-
| **Pin 0**| mapped_data |[`fields_container`](./../../core-concepts/dpf-types.md#fields-container) | Mapped data |
32-
| **Pin 1**| mapping_warning_codes |[`int32`](./../../core-concepts/dpf-types.md#standard-types) | contains the warning codes from the mapping manager kernel |
31+
| **Pin 0**| mapped_data |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Mapped data |
32+
| **Pin 1**| apply_output | | A Map containing the outputs of the interpolation as a key value pair |
3333

3434
## Configurations
3535

3636
| Name| Expected type(s) | Default value | Description |
3737
|-----|------|----------|-------------|
38-
| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
38+
| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
3939

4040
## Scripting
4141

2026R1/dpf-framework-26-r1/operator-specifications/mapping/create_mech_kriging_workflow.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ Prepares a workflow able to map data from an input mesh to a target mesh.
1616

1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
19-
| <strong>Pin 0</strong>| source_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh where the source data is defined. |
20-
| <strong>Pin 1</strong>| target_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh the data should be mapped on. |
21-
| <strong>Pin 6</strong>| target_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh. |
22-
| <strong>Pin 10</strong>| options_data_tree |[`data_tree`](./../../core-concepts/dpf-types.md#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). |
19+
| <strong>Pin 0</strong>| source_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh where the source data is defined. |
20+
| <strong>Pin 1</strong>| target_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh the data should be mapped on. |
21+
| <strong>Pin 6</strong>| target_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh. |
22+
| <strong>Pin 10</strong>| options_data_tree |[`data_tree`](../../core-concepts/dpf-types.md#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). |
2323

2424
## Outputs
2525

2626
| Output | Name | Expected type(s) | Description |
2727
|-------|------|------------------|-------------|
28-
| **Pin 0**| mapping_workflow |[`workflow`](./../../core-concepts/dpf-types.md#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. |
28+
| **Pin 0**| mapping_workflow |[`workflow`](../../core-concepts/dpf-types.md#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. |
2929

3030
## Configurations
3131

3232
| Name| Expected type(s) | Default value | Description |
3333
|-----|------|----------|-------------|
34-
| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
34+
| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
3535

3636
## Scripting
3737

2026R1/dpf-framework-26-r1/operator-specifications/mapping/create_mech_point_cloud_workflow.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ Prepares a workflow able to map data from an input mesh to a target mesh.
1616

1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
19-
| <strong>Pin 0</strong>| source_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`field`](./../../core-concepts/dpf-types.md#field) | Source mesh. Can be a meshed region or a node coordinates field. |
20-
| <strong>Pin 1</strong>| target_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region), [`field`](./../../core-concepts/dpf-types.md#field) | Target mesh. Can be a meshed region or a node coordinates field. |
21-
| <strong>Pin 6</strong>| target_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh. |
22-
| <strong>Pin 10</strong>| options_data_tree |[`data_tree`](./../../core-concepts/dpf-types.md#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). |
19+
| <strong>Pin 0</strong>| source_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | Source mesh. Can be a meshed region or a node coordinates field. |
20+
| <strong>Pin 1</strong>| target_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | Target mesh. Can be a meshed region or a node coordinates field. |
21+
| <strong>Pin 6</strong>| target_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh. |
22+
| <strong>Pin 10</strong>| options_data_tree |[`data_tree`](../../core-concepts/dpf-types.md#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). |
2323

2424
## Outputs
2525

2626
| Output | Name | Expected type(s) | Description |
2727
|-------|------|------------------|-------------|
28-
| **Pin 0**| mapping_workflow |[`workflow`](./../../core-concepts/dpf-types.md#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. |
28+
| **Pin 0**| mapping_workflow |[`workflow`](../../core-concepts/dpf-types.md#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. |
2929

3030
## Configurations
3131

3232
| Name| Expected type(s) | Default value | Description |
3333
|-----|------|----------|-------------|
34-
| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
34+
| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
3535

3636
## Scripting
3737

2026R1/dpf-framework-26-r1/operator-specifications/mapping/create_mech_shape_func_surf_workflow.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ Prepares a workflow able to map data from an input mesh to a target mesh.
1616

1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
19-
| <strong>Pin 0</strong>| source_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh where the source data is defined. |
20-
| <strong>Pin 1</strong>| target_mesh |[`abstract_meshed_region`](./../../core-concepts/dpf-types.md#meshed-region) | Mesh the data should be mapped on. |
21-
| <strong>Pin 6</strong>| target_scoping |[`scoping`](./../../core-concepts/dpf-types.md#scoping) | Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh. |
22-
| <strong>Pin 10</strong>| options_data_tree |[`data_tree`](./../../core-concepts/dpf-types.md#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). |
19+
| <strong>Pin 0</strong>| source_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh where the source data is defined. |
20+
| <strong>Pin 1</strong>| target_mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | Mesh the data should be mapped on. |
21+
| <strong>Pin 6</strong>| target_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping) | Scoping that restricts the interpolation to a given set of nodes/elements in the target mesh. |
22+
| <strong>Pin 10</strong>| options_data_tree |[`data_tree`](../../core-concepts/dpf-types.md#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). |
2323

2424
## Outputs
2525

2626
| Output | Name | Expected type(s) | Description |
2727
|-------|------|------------------|-------------|
28-
| **Pin 0**| mapping_workflow |[`workflow`](./../../core-concepts/dpf-types.md#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. |
28+
| **Pin 0**| mapping_workflow |[`workflow`](../../core-concepts/dpf-types.md#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. |
2929

3030
## Configurations
3131

3232
| Name| Expected type(s) | Default value | Description |
3333
|-----|------|----------|-------------|
34-
| **mutex** |[`bool`](./../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
34+
| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
3535

3636
## Scripting
3737

0 commit comments

Comments
 (0)