update generated code (#1509)

Co-authored-by: rlagha <[email protected]>

Author: pyansys-ci-bot

doc/source/_static/dpf_operators.html

@@ -13,17 +13,16 @@
 
 
 class compute_residual_and_error(Operator):
-    """Computes the norm of a field or a field container.
+    """Computes the Lp-norm of a field or a field container.
     When a second entry is provided, the residual (the difference
     between the first and second entry) is calculated along with the
-    error.
+    error as the Lp-norm of the difference.
     When a second input is not provided, the calculation is only
     completed for the first entry.
     The type of calculation performed is based on the specifications
-    provided for pins 1 and pin 2 defines the type of error norm (L1
-    vs L2).
-    Note that if the input is a field container that only contains one
-    field, the operator's outputs are of type field
+    provided for pin 1, pin 2 defines the type of error norm (L1 vs
+    L2), and
+    pin 3 which entity to use as a reference
 
     Parameters
     ----------
@@ -36,10 +35,14 @@ class compute_residual_and_error(Operator):
         0 for absolute,
         1 for relative to the first entry at
         a given time step,
-        2 for normalized by the max of the
-        first entry at a given time step,
-        3 for normalized by the max of the
-        first entry over all time steps
+        2 for normalized by the max at a
+        given time step of the first entry or
+        residuals depending on the reference
+        field option,
+        3 for normalized by the max over all
+        time steps of the first entry or
+        residuals depending on the reference
+        field option
     norm_calculation_type : int, optional
         Type for norm calculation (optional, default:
         l2) - it is normalized depending on
@@ -116,18 +119,17 @@ def __init__(
 
     @staticmethod
     def _spec():
-        description = """Computes the norm of a field or a field container.
+        description = """Computes the Lp-norm of a field or a field container.
             When a second entry is provided, the residual (the
             difference between the first and second entry) is
-            calculated along with the error.
+            calculated along with the error as the Lp-norm of the
+            difference.
             When a second input is not provided, the calculation is
             only completed for the first entry.
             The type of calculation performed is based on the
-            specifications provided for pins 1 and pin 2 defines the
-            type of error norm (L1 vs L2).
-            Note that if the input is a field container that only
-            contains one field, the operator's outputs are of type
-            field"""
+            specifications provided for pin 1, pin 2 defines the type
+            of error norm (L1 vs L2), and
+            pin 3 which entity to use as a reference"""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -147,10 +149,14 @@ def _spec():
         0 for absolute,
         1 for relative to the first entry at
         a given time step,
-        2 for normalized by the max of the
-        first entry at a given time step,
-        3 for normalized by the max of the
-        first entry over all time steps""",
+        2 for normalized by the max at a
+        given time step of the first entry or
+        residuals depending on the reference
+        field option,
+        3 for normalized by the max over all
+        time steps of the first entry or
+        residuals depending on the reference
+        field option""",
                 ),
                 2: PinSpecification(
                     name="norm_calculation_type",
@@ -321,10 +327,14 @@ def normalization_type(self):
         0 for absolute,
         1 for relative to the first entry at
         a given time step,
-        2 for normalized by the max of the
-        first entry at a given time step,
-        3 for normalized by the max of the
-        first entry over all time steps
+        2 for normalized by the max at a
+        given time step of the first entry or
+        residuals depending on the reference
+        field option,
+        3 for normalized by the max over all
+        time steps of the first entry or
+        residuals depending on the reference
+        field option
 
         Parameters
         ----------

src/ansys/dpf/core/operators/math/compute_residual_and_error.py

@@ -12,7 +12,13 @@
 
 
 class from_scoping(Operator):
-    """Extracts a meshed region from an other meshed region base on a scoping
+    """Extracts a meshed region from another meshed region based on a
+    scoping. Regarding the property fields of the meshed region: the
+    'Elemental' and 'Nodal' property fields are scoped to the elements
+    or nodes of the output mesh, the 'Global' property fields are
+    transferred from the input mesh to the output mesh without
+    changes, and the rest of the property fields are not present in
+    the output mesh.
 
     Parameters
     ----------
@@ -29,7 +35,8 @@ class from_scoping(Operator):
         included
     nodes_only : bool, optional
         Returns mesh with nodes only (without any
-        elements). default is false.
+        elements or property fields). default
+        is false.
     mesh : MeshedRegion
 
 
@@ -85,9 +92,13 @@ def __init__(
 
     @staticmethod
     def _spec():
-        description = (
-            """Extracts a meshed region from an other meshed region base on a scoping"""
-        )
+        description = """Extracts a meshed region from another meshed region based on a
+            scoping. Regarding the property fields of the meshed
+            region: the 'Elemental' and 'Nodal' property fields are
+            scoped to the elements or nodes of the output mesh, the
+            'Global' property fields are transferred from the input
+            mesh to the output mesh without changes, and the rest of
+            the property fields are not present in the output mesh."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -115,7 +126,8 @@ def _spec():
                     type_names=["bool"],
                     optional=True,
                     document="""Returns mesh with nodes only (without any
-        elements). default is false.""",
+        elements or property fields). default
+        is false.""",
                 ),
                 7: PinSpecification(
                     name="mesh",
@@ -253,7 +265,8 @@ def nodes_only(self):
         """Allows to connect nodes_only input to the operator.
 
         Returns mesh with nodes only (without any
-        elements). default is false.
+        elements or property fields). default
+        is false.
 
         Parameters
         ----------

src/ansys/dpf/core/operators/mesh/from_scoping.py

@@ -91,6 +91,8 @@
 from .elastic_strain_Z import elastic_strain_Z 
 from .elastic_strain_energy_density import elastic_strain_energy_density 
 from .elastic_strain_eqv import elastic_strain_eqv 
+from .elastic_strain_intensity import elastic_strain_intensity 
+from .elastic_strain_max_shear import elastic_strain_max_shear 
 from .elastic_strain_principal_1 import elastic_strain_principal_1 
 from .elastic_strain_principal_2 import elastic_strain_principal_2 
 from .elastic_strain_principal_3 import elastic_strain_principal_3 
@@ -101,6 +103,9 @@
 from .element_centroids import element_centroids 
 from .element_nodal_forces import element_nodal_forces 
 from .element_orientations import element_orientations 
+from .element_orientations_X import element_orientations_X 
+from .element_orientations_Y import element_orientations_Y 
+from .element_orientations_Z import element_orientations_Z 
 from .elemental_heat_generation import elemental_heat_generation 
 from .elemental_mass import elemental_mass 
 from .elemental_volume import elemental_volume 
@@ -199,6 +204,8 @@
 from .plastic_strain_Z import plastic_strain_Z 
 from .plastic_strain_energy_density import plastic_strain_energy_density 
 from .plastic_strain_eqv import plastic_strain_eqv 
+from .plastic_strain_intensity import plastic_strain_intensity 
+from .plastic_strain_max_shear import plastic_strain_max_shear 
 from .plastic_strain_principal_1 import plastic_strain_principal_1 
 from .plastic_strain_principal_2 import plastic_strain_principal_2 
 from .plastic_strain_principal_3 import plastic_strain_principal_3 
@@ -239,6 +246,8 @@
 from .stress_YZ import stress_YZ 
 from .stress_Z import stress_Z 
 from .stress_eqv_as_mechanical import stress_eqv_as_mechanical 
+from .stress_intensity import stress_intensity 
+from .stress_max_shear import stress_max_shear 
 from .stress_principal_1 import stress_principal_1 
 from .stress_principal_2 import stress_principal_2 
 from .stress_principal_3 import stress_principal_3