update generated code

Author: PProfizi

doc/source/_static/dpf_operators.html

@@ -14851,9 +14851,15 @@ <h2>LaTeX</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="meshA"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></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="meshB"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></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="small_value"></pin-name></td><td><req-type typeName="(double)"></req-type></td><td><div class = "pin-des-text"><p>define what is a small value for numeric comparison (default value:1.0e-14).</p>
 </div></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="tolerance"></pin-name></td><td><req-type typeName="(double)"></req-type></td><td><div class = "pin-des-text"><p>define the relative tolerance ceil for numeric comparison (default is 0.001).</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="4" ellipsis = "false"></pin-number></td><td><pin-name name="compare_auxiliary"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>compare auxiliary data (i.e property fields, scopings...). Default value is 'false'.</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="are_identical"></pin-name></td><td><req-type typeName="(bool)"></req-type></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="identical_meshes" license="none" cat="logic" plugin="core" cpp-name="compare::mesh"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="same fields?" scripting_name="identical_fields"plugin="core"cat="logic"><h1 class="op-des-h1">logic: same fields?</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Check if two fields are identical.</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="are_identical"></pin-name></td><td><req-type typeName="(bool)"></req-type></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="identical_meshes" license="none" cat="logic" plugin="core" cpp-name="compare::mesh"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="same fields?" scripting_name="identical_fields"plugin="core"cat="logic"><h1 class="op-des-h1">logic: same fields?</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Check if two fields are identical according to the following behavior:</p>
+<ul>
+<li>double_value (input pin 2) parameter is a significance threshold, not an absolute tolerance</li>
+<li>Values below double_value are considereded 'negligible', values above are considered 'significant'</li>
+<li>Both fields are considered different if the data for at least one entity in one field is negligible and the data for the same entity in the other is significant</li>
+<li>When the data for the same entity in both fields is significant, they are compared based on double_tolerance (input pin 3) with the expression given in the pin documentation.</li>
+</ul>
 </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></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></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="double_value"></pin-name></td><td><req-type typeName="(double)"></req-type></td><td><div class = "pin-des-text"><p>Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14).</p>
-</div></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="double_tolerance"></pin-name></td><td><req-type typeName="(double)"></req-type></td><td><div class = "pin-des-text"><p>Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 &lt; relativeTol. Default is 0.001.</p>
+</div></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="double_tolerance"></pin-name></td><td><req-type typeName="(double)"></req-type></td><td><div class = "pin-des-text"><p>Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 &lt; double_tolerance. Default is 0.001.</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="boolean"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>bool (true if identical...)</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="message"></pin-name></td><td><req-type typeName="(string)"></req-type></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="identical_fields" license="none" cat="logic" plugin="core" cpp-name="AreFieldsIdentical"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="same scopings?" scripting_name="identical_scopings"plugin="core"cat="logic"><h1 class="op-des-h1">logic: same scopings?</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Check if two scopings are identical.</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="scopingA"></pin-name></td><td><req-type typeName="(scoping)"></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="scopingB"></pin-name></td><td><req-type typeName="(scoping)"></req-type></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="boolean"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>bool (true if identical...)</p>

src/ansys/dpf/core/operators/logic/identical_fields.py

@@ -20,7 +20,18 @@
 
 
 class identical_fields(Operator):
-    r"""Check if two fields are identical.
+    r"""Check if two fields are identical according to the following behavior:
+
+    - double_value (input pin 2) parameter is a significance threshold, not
+      an absolute tolerance
+    - Values below double_value are considereded ‘negligible’, values above
+      are considered ‘significant’
+    - Both fields are considered different if the data for at least one
+      entity in one field is negligible and the data for the same entity in
+      the other is significant
+    - When the data for the same entity in both fields is significant, they
+      are compared based on double_tolerance (input pin 3) with the
+      expression given in the pin documentation.
 
 
     Inputs
@@ -30,7 +41,7 @@ class identical_fields(Operator):
     double_value: float, optional
         Double positive small value. Smallest value considered during the comparison step. All the absolute values in the field less than this value are considered null, (default value: 1.0e-14).
     double_tolerance: float, optional
-        Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001.
+        Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < double_tolerance. Default is 0.001.
 
     Outputs
     -------
@@ -95,7 +106,18 @@ def __init__(
 
     @staticmethod
     def _spec() -> Specification:
-        description = r"""Check if two fields are identical.
+        description = r"""Check if two fields are identical according to the following behavior:
+
+- double_value (input pin 2) parameter is a significance threshold, not
+  an absolute tolerance
+- Values below double_value are considereded ‘negligible’, values above
+  are considered ‘significant’
+- Both fields are considered different if the data for at least one
+  entity in one field is negligible and the data for the same entity in
+  the other is significant
+- When the data for the same entity in both fields is significant, they
+  are compared based on double_tolerance (input pin 3) with the
+  expression given in the pin documentation.
 """
         spec = Specification(
             description=description,
@@ -122,7 +144,7 @@ def _spec() -> Specification:
                     name="double_tolerance",
                     type_names=["double"],
                     optional=True,
-                    document=r"""Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001.""",
+                    document=r"""Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < double_tolerance. Default is 0.001.""",
                 ),
             },
             map_output_pin_spec={
@@ -286,7 +308,7 @@ def double_value(self) -> Input[float]:
     def double_tolerance(self) -> Input[float]:
         r"""Allows to connect double_tolerance input to the operator.
 
-        Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001.
+        Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < double_tolerance. Default is 0.001.
 
         Returns
         -------