Skip to content

Commit 75dacc2

Browse files
author
4rmuuser
committed
DPF doc update for 261 (2025.10.31)
1 parent 2f02d78 commit 75dacc2

File tree

7 files changed

+465
-216
lines changed

7 files changed

+465
-216
lines changed

‎2026R1/dpf-framework-26-r1/changelog/changelog.md‎

Lines changed: 218 additions & 216 deletions
Large diffs are not rendered by default.

‎2026R1/dpf-framework-26-r1/operator-specifications/result/node_orientations.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
category: result
3+
plugin: core
4+
license: None
5+
---
6+
7+
# result:node orientations
8+
9+
**Version: 0.0.0**
10+
11+
## Description
12+
13+
Read/compute node euler angles by calling the readers defined by the datasources.
14+
15+
## Inputs
16+
17+
| Input | Name | Expected type(s) | Description |
18+
|-------|-------|------------------|-------------|
19+
| <strong>Pin 0</strong>| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector<double>`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
20+
| <strong>Pin 1</strong>| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
21+
| <strong>Pin 2</strong>| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | Fields container already allocated modified inplace |
22+
| <strong>Pin 3</strong>| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data |
23+
| <strong>Pin 4</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set |
24+
| <strong>Pin 5</strong>| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect. |
25+
| <strong>Pin 7</strong>| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files |
26+
27+
## Outputs
28+
29+
| Output | Name | Expected type(s) | Description |
30+
|-------|------|------------------|-------------|
31+
| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | |
32+
33+
## Configurations
34+
35+
| Name| Expected type(s) | Default value | Description |
36+
|-----|------|----------|-------------|
37+
| **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+
| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel |
39+
| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. |
40+
41+
## Scripting
42+
43+
**Category**: result
44+
45+
**Plugin**: core
46+
47+
**Scripting name**: node_orientations
48+
49+
**Full name**: result.node_orientations
50+
51+
**Internal name**: EUL_NOD
52+
53+
**License**: None
54+
55+
56+
## Changelog
57+
58+
- Version 0.0.0: Initial release.

‎2026R1/dpf-framework-26-r1/operator-specifications/result/node_orientations_X.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
category: result
3+
plugin: core
4+
license: None
5+
---
6+
7+
# result:node orientations X
8+
9+
**Version: 0.0.0**
10+
11+
## Description
12+
13+
Read/compute node euler angles X component of the vector (1st component) by calling the readers defined by the datasources.
14+
15+
## Inputs
16+
17+
| Input | Name | Expected type(s) | Description |
18+
|-------|-------|------------------|-------------|
19+
| <strong>Pin 0</strong>| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector<double>`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
20+
| <strong>Pin 1</strong>| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
21+
| <strong>Pin 2</strong>| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace |
22+
| <strong>Pin 3</strong>| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data |
23+
| <strong>Pin 4</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set |
24+
| <strong>Pin 5</strong>| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) |
25+
| <strong>Pin 7</strong>| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files |
26+
| <strong>Pin 14</strong>| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
27+
28+
## Outputs
29+
30+
| Output | Name | Expected type(s) | Description |
31+
|-------|------|------------------|-------------|
32+
| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | |
33+
34+
## Configurations
35+
36+
| Name| Expected type(s) | Default value | Description |
37+
|-----|------|----------|-------------|
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. |
39+
| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel |
40+
| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. |
41+
42+
## Scripting
43+
44+
**Category**: result
45+
46+
**Plugin**: core
47+
48+
**Scripting name**: node_orientations_X
49+
50+
**Full name**: result.node_orientations_X
51+
52+
**Internal name**: EUL_NODX
53+
54+
**License**: None
55+
56+
57+
## Changelog
58+
59+
- Version 0.0.0: Initial release.

‎2026R1/dpf-framework-26-r1/operator-specifications/result/node_orientations_Y.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
category: result
3+
plugin: core
4+
license: None
5+
---
6+
7+
# result:node orientations Y
8+
9+
**Version: 0.0.0**
10+
11+
## Description
12+
13+
Read/compute node euler angles Y component of the vector (2nd component) by calling the readers defined by the datasources.
14+
15+
## Inputs
16+
17+
| Input | Name | Expected type(s) | Description |
18+
|-------|-------|------------------|-------------|
19+
| <strong>Pin 0</strong>| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector<double>`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
20+
| <strong>Pin 1</strong>| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
21+
| <strong>Pin 2</strong>| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace |
22+
| <strong>Pin 3</strong>| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data |
23+
| <strong>Pin 4</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set |
24+
| <strong>Pin 5</strong>| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) |
25+
| <strong>Pin 7</strong>| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files |
26+
| <strong>Pin 14</strong>| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
27+
28+
## Outputs
29+
30+
| Output | Name | Expected type(s) | Description |
31+
|-------|------|------------------|-------------|
32+
| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | |
33+
34+
## Configurations
35+
36+
| Name| Expected type(s) | Default value | Description |
37+
|-----|------|----------|-------------|
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. |
39+
| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel |
40+
| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. |
41+
42+
## Scripting
43+
44+
**Category**: result
45+
46+
**Plugin**: core
47+
48+
**Scripting name**: node_orientations_Y
49+
50+
**Full name**: result.node_orientations_Y
51+
52+
**Internal name**: EUL_NODY
53+
54+
**License**: None
55+
56+
57+
## Changelog
58+
59+
- Version 0.0.0: Initial release.

‎2026R1/dpf-framework-26-r1/operator-specifications/result/node_orientations_Z.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
category: result
3+
plugin: core
4+
license: None
5+
---
6+
7+
# result:node orientations Z
8+
9+
**Version: 0.0.0**
10+
11+
## Description
12+
13+
Read/compute node euler angles Z component of the vector (3rd component) by calling the readers defined by the datasources.
14+
15+
## Inputs
16+
17+
| Input | Name | Expected type(s) | Description |
18+
|-------|-------|------------------|-------------|
19+
| <strong>Pin 0</strong>| time_scoping |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector<double>`](../../core-concepts/dpf-types.md#standard-types) | time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
20+
| <strong>Pin 1</strong>| mesh_scoping |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
21+
| <strong>Pin 2</strong>| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | FieldsContainer already allocated modified inplace |
22+
| <strong>Pin 3</strong>| streams_container |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | result file container allowed to be kept open to cache data |
23+
| <strong>Pin 4</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| data_sources |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | result file path container, used if no streams are set |
24+
| <strong>Pin 5</strong>| bool_rotate_to_global |[`bool`](../../core-concepts/dpf-types.md#standard-types) | if true the field is rotated to global coordinate system (default true) |
25+
| <strong>Pin 7</strong>| mesh |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | prevents from reading the mesh in the result files |
26+
| <strong>Pin 14</strong>| read_cyclic |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
27+
28+
## Outputs
29+
30+
| Output | Name | Expected type(s) | Description |
31+
|-------|------|------------------|-------------|
32+
| **Pin 0**| fields_container |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | |
33+
34+
## Configurations
35+
36+
| Name| Expected type(s) | Default value | Description |
37+
|-----|------|----------|-------------|
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. |
39+
| **num_threads** |[`int32`](../../core-concepts/dpf-types.md#standard-types) | 0 | Number of threads to use to run in parallel |
40+
| **run_in_parallel** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | true | Loops are allowed to run in parallel if the value of this config is set to true. |
41+
42+
## Scripting
43+
44+
**Category**: result
45+
46+
**Plugin**: core
47+
48+
**Scripting name**: node_orientations_Z
49+
50+
**Full name**: result.node_orientations_Z
51+
52+
**Internal name**: EUL_NODZ
53+
54+
**License**: None
55+
56+
57+
## Changelog
58+
59+
- Version 0.0.0: Initial release.

‎2026R1/dpf-framework-26-r1/operator-specifications/result/result_category.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,10 @@
239239
- [nodal rotation Y](nodal_rotation_Y.md)
240240
- [nodal rotation Z](nodal_rotation_Z.md)
241241
- [nodal to global](nodal_to_global.md)
242+
- [node orientations](node_orientations.md)
243+
- [node orientations X](node_orientations_X.md)
244+
- [node orientations Y](node_orientations_Y.md)
245+
- [node orientations Z](node_orientations_Z.md)
242246
- [normal contact force](normal_contact_force.md)
243247
- [normal contact moment](normal_contact_moment.md)
244248
- [num surface status changes](num_surface_status_changes.md)

‎2026R1/dpf-framework-26-r1/toc.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1267,6 +1267,14 @@
12671267
href: operator-specifications/result/nodal_rotation_Z.md
12681268
- name: nodal to global
12691269
href: operator-specifications/result/nodal_to_global.md
1270+
- name: node orientations
1271+
href: operator-specifications/result/node_orientations.md
1272+
- name: node orientations X
1273+
href: operator-specifications/result/node_orientations_X.md
1274+
- name: node orientations Y
1275+
href: operator-specifications/result/node_orientations_Y.md
1276+
- name: node orientations Z
1277+
href: operator-specifications/result/node_orientations_Z.md
12701278
- name: normal contact force
12711279
href: operator-specifications/result/normal_contact_force.md
12721280
- name: normal contact moment

0 commit comments

Comments
 (0)