Update generated code for DPF 261_daily on master

doc/source/_static/dpf_operators.html

@@ -14119,10 +14119,12 @@ <h2 class="h2-main">Configurating operators</h2>
 </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>
 </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>
 </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>
-</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>
+</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>
+Input pin 4 <code>compute_amplitude</code> is only effective when given <code>fields_container</code> contains the <code>complex</code> label.<br>
+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>
 </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>
 </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>
-</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>
+</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>
 </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>
 </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>
 </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

@@ -16,8 +16,13 @@
 
 
 class min_max_over_time_by_entity(Operator):
-    r"""Evaluates minimum, maximum over time/frequency and returns those min max
-    as well as the time/freq where they occurred
+    r"""| For each entity and component, evaluates minimum and maximum over
+      time/frequency.
+    | Input pin 4 ``compute_amplitude`` is only effective when given
+      ``fields_container`` contains the ``complex`` label.
+    | if given input ``fields_container`` has a ``time_freq_support``,
+      output pins 2 and 3 ``fields_container`` contains time/freq indices of
+      the minimum and maximum values.
 
 
     Parameters
@@ -32,8 +37,8 @@ class min_max_over_time_by_entity(Operator):
     -------
     min: FieldsContainer
     max: FieldsContainer
-    time_freq_of_min: FieldsContainer
-    time_freq_of_max: FieldsContainer
+    time_freq_of_min: FieldsContainer, optional
+    time_freq_of_max: FieldsContainer, optional
 
     Examples
     --------
@@ -86,8 +91,13 @@ def __init__(
 
     @staticmethod
     def _spec() -> Specification:
-        description = r"""Evaluates minimum, maximum over time/frequency and returns those min max
-as well as the time/freq where they occurred
+        description = r"""| For each entity and component, evaluates minimum and maximum over
+  time/frequency.
+| Input pin 4 ``compute_amplitude`` is only effective when given
+  ``fields_container`` contains the ``complex`` label.
+| if given input ``fields_container`` has a ``time_freq_support``,
+  output pins 2 and 3 ``fields_container`` contains time/freq indices of
+  the minimum and maximum values.
 """
         spec = Specification(
             description=description,
@@ -127,13 +137,13 @@ def _spec() -> Specification:
                 2: PinSpecification(
                     name="time_freq_of_min",
                     type_names=["fields_container"],
-                    optional=False,
+                    optional=True,
                     document=r"""""",
                 ),
                 3: PinSpecification(
                     name="time_freq_of_max",
                     type_names=["fields_container"],
-                    optional=False,
+                    optional=True,
                     document=r"""""",
                 ),
             },