Skip to content

Commit 2d35e46

Browse files
AnsMelanieAnsMelanie
authored
Merge pull request #267 from ansys/DPF_261/daily_doc_update
DPF doc daily update for 261
2 parents ccfe4cf + 572f83a commit 2d35e46

File tree

7 files changed

+314
-4
lines changed

7 files changed

+314
-4
lines changed

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

Lines changed: 67 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
Changes since the last released version for DPF 26.1.pre1 (as of 2025-10-31).
3+
Changes since the last released version for DPF 26.1.pre1 (as of 2025-11-03).
44

55
This changelog is organized by category, with sections for different types of updates (new features, bug fixes, changes, performance improvements).
66

@@ -12,10 +12,11 @@ The following table shows which components have updates in each category.
1212
| cgns | [1 item](#Features_cgns) | |
1313
| changelog | [2 items](#Features_changelog) |[1 item](#Fixes_changelog) |
1414
| ci | [1 item](#Features_ci) |[1 item](#Fixes_ci) |
15-
| compression | [2 items](#Features_compression) | |
15+
| compression | [2 items](#Features_compression) |[1 item](#Fixes_compression) |
1616
| core | |[1 item](#Fixes_core) |
1717
| cyclic | [1 item](#Features_cyclic) | |
1818
| doc | [2 items](#Features_doc) | |
19+
| documentation | [1 item](#Features_documentation) | |
1920
| dpf | [3 items](#Features_dpf) |[1 item](#Fixes_dpf) |
2021
| eng_mat | |[1 item](#Fixes_eng_mat) |
2122
| expansion | [1 item](#Features_expansion) | |
@@ -26,9 +27,9 @@ The following table shows which components have updates in each category.
2627
| h5dpf | [1 item](#Features_h5dpf) |[1 item](#Fixes_h5dpf) |
2728
| hdf5 | [4 items](#Features_hdf5) | |
2829
| hgp | [2 items](#Features_hgp) | |
29-
| kernel | [1 item](#Features_kernel) |[1 item](#Fixes_kernel) |
30+
| kernel | [2 items](#Features_kernel) |[1 item](#Fixes_kernel) |
3031
| lsdyna | [1 item](#Features_lsdyna) | |
31-
| mapdl | [11 items](#Features_mapdl) |[14 items](#Fixes_mapdl) |
32+
| mapdl | [12 items](#Features_mapdl) |[14 items](#Fixes_mapdl) |
3233
| mapdlpluggin | |[1 item](#Fixes_mapdlpluggin) |
3334
| math | [7 items](#Features_math) | |
3435
| mechanical | [2 items](#Features_mechanical) |[3 items](#Fixes_mechanical) |
@@ -92,6 +93,8 @@ The following table shows which components have updates in each category.
9293

9394
- Use scripting name in operator changelog:
9495
>
96+
>
97+
>
9598
## ci
9699
### <a id="Features_ci"></a> Features
97100

@@ -127,6 +130,14 @@ The following table shows which components have updates in each category.
127130
- Scale and Round Operator:
128131
>
129132
133+
### <a id="Fixes_compression"></a> Fixes
134+
135+
- Quantization loss of performance:
136+
> The quantization ("quantization") operator has became super slow since its last modification.
137+
>
138+
>
139+
>
140+
>
130141
## core
131142

132143
### <a id="Fixes_core"></a> Fixes
@@ -176,6 +187,20 @@ The following table shows which components have updates in each category.
176187
>
177188
>
178189
190+
## documentation
191+
### <a id="Features_documentation"></a> Features
192+
193+
- Add Markdown and LaTeX example operator:
194+
> This PR adds an example operator ``markdown_latex_example`` to ``Ans.Dpf.Documentation`` where usage of supported Markdown and LaTeX is showcased.
195+
>
196+
> It also allows to test whether the operator is properly exposed in all clients and pipelines.
197+
>
198+
> We take the opportunity to fix support for multiline descriptions in output pins during generation of operator classes in C#.
199+
>
200+
>
201+
>
202+
>
203+
179204
## dpf
180205
### <a id="Features_dpf"></a> Features
181206

@@ -403,6 +428,15 @@ The following table shows which components have updates in each category.
403428
## kernel
404429
### <a id="Features_kernel"></a> Features
405430

431+
- Add Unit string to express British ton:
432+
>
433+
>
434+
> The string `"ton"` in DPF units denotes the Metric Ton (1000 kg). The string `"tonuk"` now denotes the British ton (also known as Long ton, approximately 1016.05 kg or 2240 pounds of mass).
435+
>
436+
>
437+
>
438+
>
439+
406440
- Establish thread safety and STL compliance for scopingIterators:
407441
> - Test for thread safety when using scoping Iterators for read access within parallel regions (over fields, over scoping etc).
408442
>
@@ -435,6 +469,13 @@ The following table shows which components have updates in each category.
435469
## mapdl
436470
### <a id="Features_mapdl"></a> Features
437471

472+
- Adding new operator and result for Nodal Orientations:
473+
> Adding new operator and result for Nodal Orientations
474+
>
475+
>
476+
>
477+
>
478+
438479
- Refactor ElementType handling to increase performance:
439480
>
440481
>
@@ -1358,6 +1399,18 @@ The following table shows which components have updates in each category.
13581399
- [nodal_rotational_velocity_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/nodal_rotational_velocity_Z.md):
13591400
> Read/compute nodal rotational velocity Z component of the vector (3rd component) by calling the readers defined by the datasources.
13601401
1402+
- [node_orientations](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/node_orientations.md):
1403+
> Read/compute node euler angles by calling the readers defined by the datasources.
1404+
1405+
- [node_orientations_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/node_orientations_X.md):
1406+
> Read/compute node euler angles X component of the vector (1st component) by calling the readers defined by the datasources.
1407+
1408+
- [node_orientations_Y](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/node_orientations_Y.md):
1409+
> Read/compute node euler angles Y component of the vector (2nd component) by calling the readers defined by the datasources.
1410+
1411+
- [node_orientations_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/node_orientations_Z.md):
1412+
> Read/compute node euler angles Z component of the vector (3rd component) by calling the readers defined by the datasources.
1413+
13611414

13621415
#### serialization
13631416

@@ -1808,6 +1861,16 @@ The following table shows which components have updates in each category.
18081861
> 0.1.0: Addition of is_constant pin
18091862
18101863

1864+
- [remove_rigid_body_motion](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/remove_rigid_body_motion.md)
1865+
1866+
> 0.0.1: Replace vector of pointers with array of objects to prevent memory leaks
1867+
1868+
1869+
- [remove_rigid_body_motion_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/remove_rigid_body_motion_fc.md)
1870+
1871+
> 0.0.1: Replace vector of pointers with array of objects to prevent memory leaks
1872+
1873+
18111874
- [state_variable](https://ansys-a.devportal.io/docs/dpf-framework-2026-r1/operator-specifications/result/state_variable.md)
18121875

18131876
> 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True

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

0 commit comments

Comments
 (0)