Skip to content

Commit 61db580

Browse files
authored
Merge pull request #255 from ansys/DPF_261/daily_doc_update
DPF doc daily update for 261
2 parents adaa9b9 + 3a16a59 commit 61db580

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1114
-648
lines changed

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

Lines changed: 972 additions & 602 deletions
Large diffs are not rendered by default.

2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_support_get_attribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Uses the TimeFreqSupport APIs to return a given attribute of the scoping in inpu
1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
1919
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | |
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>| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs". |
21-
| <strong>Pin 2</strong>| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping. |
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>| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index". |
21+
| <strong>Pin 2</strong>| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index. |
2222
| <strong>Pin 3</strong>| property_identifier_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered). |
2323

2424
## Outputs
2525

2626
| Output | Name | Expected type(s) | Description |
2727
|-------|------|------------------|-------------|
28-
| **Pin 0**| property |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise. |
28+
| **Pin 0**| property |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", an int for "step_id_from_harmonic_index" and a Field otherwise. |
2929

3030
## Configurations
3131

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ Read/compute element nodal accumulated equivalent creep strain by calling the re
5757
| <strong>Pin 9</strong>| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal |
5858
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
5959
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
60-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
60+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
61+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6162

6263
## Outputs
6364

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ Read/compute element nodal accumulated equivalent plastic strain by calling the
5757
| <strong>Pin 9</strong>| requested_location |[`string`](../../core-concepts/dpf-types.md#standard-types) | requested location Nodal, Elemental or ElementalNodal |
5858
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
5959
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
60-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
60+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
61+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6162

6263
## Outputs
6364

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ Read/compute element actual applied fluid penetration pressure by calling the re
6161
| <strong>Pin 19</strong>| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
6262
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
6363
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
64-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
64+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
65+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6566

6667
## Outputs
6768

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ Read/compute element contact friction stress by calling the readers defined by t
6161
| <strong>Pin 19</strong>| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
6262
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
6363
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
64-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
64+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
65+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6566

6667
## Outputs
6768

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ Read/compute element contact gap distance by calling the readers defined by the
6161
| <strong>Pin 19</strong>| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
6262
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
6363
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
64-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
64+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
65+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6566

6667
## Outputs
6768

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ Read/compute element contact penetration by calling the readers defined by the d
6161
| <strong>Pin 19</strong>| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
6262
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
6363
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
64-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
64+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
65+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6566

6667
## Outputs
6768

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ Read/compute element contact pressure by calling the readers defined by the data
6161
| <strong>Pin 19</strong>| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
6262
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
6363
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
64-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
64+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
65+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6566

6667
## Outputs
6768

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ Read/compute element contact sliding distance by calling the readers defined by
6161
| <strong>Pin 19</strong>| phi |[`double`](../../core-concepts/dpf-types.md#standard-types) | angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
6262
| <strong>Pin 22</strong>| read_beams |[`bool`](../../core-concepts/dpf-types.md#standard-types) | elemental nodal beam results are read if this pin is set to true (default is false) |
6363
| <strong>Pin 26</strong>| split_shells |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required. |
64-
| <strong>Pin 27</strong>| shell_layer |[`int32`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
64+
| <strong>Pin 27</strong>| shell_layer |[`bool`](../../core-concepts/dpf-types.md#standard-types) | If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. |
65+
| <strong>Pin 28</strong>| extend_to_mid_nodes |[`bool`](../../core-concepts/dpf-types.md#standard-types) | Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True |
6566

6667
## Outputs
6768

0 commit comments

Comments
 (0)