Skip to content

Commit 4371ec0

Browse files
Update generated code for DPF 261_daily on master (#2442)
Co-authored-by: PProfizi <[email protected]>
1 parent 647251b commit 4371ec0

File tree

6 files changed

+22
-10
lines changed

6 files changed

+22
-10
lines changed

doc/source/_static/dpf_operators.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14119,10 +14119,12 @@ <h2 class="h2-main">Configurating operators</h2>
1411914119
</div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="fieldA"></pin-name></td><td><req-type typeName="(field)"></req-type></td><td><div class = "pin-des-text"><p>Vector or tensor field that must be rotated, expressed in global coordinate system.</p>
1412014120
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="fieldB"></pin-name></td><td><req-type typeName="(field)"></req-type></td><td><div class = "pin-des-text"><p>Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global.</p>
1412114121
</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td><td><div class = "pin-des-text"><p>Rotated field</p>
14122-
</div></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="mapdl.global_to_nodal" license="none" cat="result" plugin="core" cpp-name="GlobalToNodal"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="min max by entity over time" scripting_name="min_max_over_time_by_entity"plugin="core"cat="min_max"><h1 class="op-des-h1">min_max: min max by entity over time</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Evaluates minimum, maximum over time/frequency and returns those min max as well as the time/freq where they occurred</p>
14122+
</div></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="mapdl.global_to_nodal" license="none" cat="result" plugin="core" cpp-name="GlobalToNodal"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="min max by entity over time" scripting_name="min_max_over_time_by_entity"plugin="core"cat="min_max"><h1 class="op-des-h1">min_max: min max by entity over time</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>For each entity and component, evaluates minimum and maximum over time/frequency.<br>
14123+
Input pin 4 <code>compute_amplitude</code> is only effective when given <code>fields_container</code> contains the <code>complex</code> label.<br>
14124+
if given input <code>fields_container</code> has a <code>time_freq_support</code>, output pins 2 and 3 <code>fields_container</code> contains time/freq indices of the minimum and maximum values.</p>
1412314125
</div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="fields_container"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="3" ellipsis = "false"></pin-number-optional></td><td><pin-name name="compute_absolute_value"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>Calculate the absolute value of field entities before computing the min/max.</p>
1412414126
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="4" ellipsis = "false"></pin-number-optional></td><td><pin-name name="compute_amplitude"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>Do calculate amplitude.</p>
14125-
</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="min"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="max"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="2" ellipsis = "false"></pin-number></td><td><pin-name name="time_freq_of_min"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="3" ellipsis = "false"></pin-number></td><td><pin-name name="time_freq_of_max"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="incremental" default="true" doc="This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range." types="bool" ></config-spec><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="min_max_over_time_by_entity" license="none" cat="min_max" plugin="core" cpp-name="min_max_over_time_by_entity"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="connectivity ids" scripting_name="connectivity_ids"plugin="core"cat="scoping"><h1 class="op-des-h1">scoping: connectivity ids</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Returns the ordered node ids corresponding to the element ids scoping in input. For each element the node ids are its connectivity.</p>
14127+
</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="min"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="max"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="2" ellipsis = "false"></pin-number-optional></td><td><pin-name name="time_freq_of_min"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="3" ellipsis = "false"></pin-number-optional></td><td><pin-name name="time_freq_of_max"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="incremental" default="true" doc="This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range." types="bool" ></config-spec><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="min_max_over_time_by_entity" license="none" cat="min_max" plugin="core" cpp-name="min_max_over_time_by_entity"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="connectivity ids" scripting_name="connectivity_ids"plugin="core"cat="scoping"><h1 class="op-des-h1">scoping: connectivity ids</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Returns the ordered node ids corresponding to the element ids scoping in input. For each element the node ids are its connectivity.</p>
1412614128
</div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping)"></req-type></td><td><div class = "pin-des-text"><p>Elemental scoping</p>
1412714129
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="7" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></req-type></td><td><div class = "pin-des-text"><p>the support of the scoping is expected if there is no mesh in input</p>
1412814130
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="10" ellipsis = "false"></pin-number-optional></td><td><pin-name name="take_mid_nodes"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>default is true</p>

src/ansys/dpf/core/operators/min_max/min_max_over_time_by_entity.py

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,13 @@
1616

1717

1818
class min_max_over_time_by_entity(Operator):
19-
r"""Evaluates minimum, maximum over time/frequency and returns those min max
20-
as well as the time/freq where they occurred
19+
r"""| For each entity and component, evaluates minimum and maximum over
20+
time/frequency.
21+
| Input pin 4 ``compute_amplitude`` is only effective when given
22+
``fields_container`` contains the ``complex`` label.
23+
| if given input ``fields_container`` has a ``time_freq_support``,
24+
output pins 2 and 3 ``fields_container`` contains time/freq indices of
25+
the minimum and maximum values.
2126
2227
2328
Parameters
@@ -32,8 +37,8 @@ class min_max_over_time_by_entity(Operator):
3237
-------
3338
min: FieldsContainer
3439
max: FieldsContainer
35-
time_freq_of_min: FieldsContainer
36-
time_freq_of_max: FieldsContainer
40+
time_freq_of_min: FieldsContainer, optional
41+
time_freq_of_max: FieldsContainer, optional
3742
3843
Examples
3944
--------
@@ -86,8 +91,13 @@ def __init__(
8691

8792
@staticmethod
8893
def _spec() -> Specification:
89-
description = r"""Evaluates minimum, maximum over time/frequency and returns those min max
90-
as well as the time/freq where they occurred
94+
description = r"""| For each entity and component, evaluates minimum and maximum over
95+
time/frequency.
96+
| Input pin 4 ``compute_amplitude`` is only effective when given
97+
``fields_container`` contains the ``complex`` label.
98+
| if given input ``fields_container`` has a ``time_freq_support``,
99+
output pins 2 and 3 ``fields_container`` contains time/freq indices of
100+
the minimum and maximum values.
91101
"""
92102
spec = Specification(
93103
description=description,
@@ -127,13 +137,13 @@ def _spec() -> Specification:
127137
2: PinSpecification(
128138
name="time_freq_of_min",
129139
type_names=["fields_container"],
130-
optional=False,
140+
optional=True,
131141
document=r"""""",
132142
),
133143
3: PinSpecification(
134144
name="time_freq_of_max",
135145
type_names=["fields_container"],
136-
optional=False,
146+
optional=True,
137147
document=r"""""",
138148
),
139149
},
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)