Merge branch 'master' into maint/update-contributors-file

Author: RobPasMue

doc/source/_static/dpf_operators.html

@@ -252,6 +252,7 @@ def reset_servers(gallery_conf, fname, when):
         "own_page_level": "class",
         "type": "python",
         "options": [
+            "inherited-members",
             "members",
             "undoc-members",
             "show-inheritance",

doc/source/conf.py

@@ -101,7 +101,7 @@
 min_max_op = dpf.operators.min_max.min_max(field)
 print(min_max_op.outputs.field_max().data)
 
-# Out of conveience, you can simply take the max of the field with:
+# Out of convenience, you can simply take the max of the field with:
 print(field.max().data)
 
 # The above yields a result identical to:

examples/00-basic/02-basic_field_containers.py

@@ -115,7 +115,7 @@
 h5_stream_prov_op = dpf.operators.metadata.streams_provider()
 h5_stream_prov_op.inputs.data_sources.connect(h5_all_times_ds)
 res_deser_all_times_list = []
-h5_read_op = dpf.operators.result.custom()
+h5_read_op = dpf.operators.result.result_provider()
 h5_read_op.inputs.streams_container.connect(h5_stream_prov_op.outputs)
 h5_read_op.inputs.time_scoping.connect(dpf.Scoping(ids=list(range(1, 54)), location="time"))
 for i, res_name in enumerate(result_names_on_all_time_steps):
@@ -134,7 +134,7 @@
 h5_stream_prov_op_2 = dpf.operators.metadata.streams_provider()
 h5_stream_prov_op_2.inputs.data_sources.connect(h5_set_per_set_ds)
 res_deser_set_per_set_list = []
-h5_read_op_2 = dpf.operators.result.custom()
+h5_read_op_2 = dpf.operators.result.result_provider()
 h5_read_op_2.inputs.streams_container.connect(h5_stream_prov_op_2.outputs)
 for i, res_name in enumerate(result_names_time_per_time):
     h5_read_op_2.inputs.result_name.connect(res_name)

examples/05-file-IO/02-hdf5_serialize_and_read.py

@@ -1,5 +1,5 @@
 ansys-sphinx-theme[autoapi]==1.3.2
-enum-tools[sphinx]==0.12.0
+enum-tools[sphinx]==0.13.0
 graphviz==0.20.1
 imageio==2.37.0
 imageio-ffmpeg==0.6.0
@@ -11,7 +11,7 @@ sphinx-copybutton==0.5.2
 sphinx-gallery==0.19.0
 sphinx-jinja==2.0.2
 sphinx-notfound-page==1.1.0
-sphinx-reredirects==0.1.3
+sphinx-reredirects==0.1.6
 sphinx_design==0.6.1
 sphinxcontrib-napoleon==0.7
 vtk==9.3.1

requirements/requirements_docs.txt

@@ -22,6 +22,7 @@
     "support_provider_cyclic": "mapdl::rst::support_provider_cyclic",
     "NMISC": "mapdl::nmisc",
     "SMISC": "mapdl::smisc",
+    "result_provider": "custom",
 }
 
 def build_docstring(specification_description):

src/ansys/dpf/core/operators/build.py

@@ -27,8 +27,8 @@ class skin(Operator):
         Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping.
     duplicate_shell: bool, optional
         If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged.
-    add_beam: bool, optional
-        If input mesh contains beam elements, output mesh beam elements (boolean = 1) are added or (boolean = 0) are ignored.
+    add_beam_point: bool, optional
+        If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False
 
     Returns
     -------
@@ -55,15 +55,15 @@ class skin(Operator):
     >>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
     >>> my_duplicate_shell = bool()
     >>> op.inputs.duplicate_shell.connect(my_duplicate_shell)
-    >>> my_add_beam = bool()
-    >>> op.inputs.add_beam.connect(my_add_beam)
+    >>> my_add_beam_point = bool()
+    >>> op.inputs.add_beam_point.connect(my_add_beam_point)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.mesh.skin(
     ...     mesh=my_mesh,
     ...     mesh_scoping=my_mesh_scoping,
     ...     duplicate_shell=my_duplicate_shell,
-    ...     add_beam=my_add_beam,
+    ...     add_beam_point=my_add_beam_point,
     ... )
 
     >>> # Get output data
@@ -79,9 +79,10 @@ def __init__(
         mesh=None,
         mesh_scoping=None,
         duplicate_shell=None,
-        add_beam=None,
+        add_beam_point=None,
         config=None,
         server=None,
+        add_beam=None,
     ):
         super().__init__(name="meshed_skin_sector", config=config, server=server)
         self._inputs = InputsSkin(self)
@@ -92,8 +93,15 @@ def __init__(
             self.inputs.mesh_scoping.connect(mesh_scoping)
         if duplicate_shell is not None:
             self.inputs.duplicate_shell.connect(duplicate_shell)
-        if add_beam is not None:
-            self.inputs.add_beam.connect(add_beam)
+        if add_beam_point is not None:
+            self.inputs.add_beam_point.connect(add_beam_point)
+        elif add_beam is not None:
+            warn(
+                DeprecationWarning(
+                    f'Operator skin: Input name "add_beam" is deprecated in favor of "add_beam_point".'
+                )
+            )
+            self.inputs.add_beam_point.connect(add_beam)
 
     @staticmethod
     def _spec() -> Specification:
@@ -122,10 +130,11 @@ def _spec() -> Specification:
                     document=r"""If input mesh contains shell elements, output mesh shell elements (boolean = 1) are duplicated, one per each orientation, or (boolean = 0) remain unchanged.""",
                 ),
                 3: PinSpecification(
-                    name="add_beam",
+                    name="add_beam_point",
                     type_names=["bool"],
                     optional=True,
-                    document=r"""If input mesh contains beam elements, output mesh beam elements (boolean = 1) are added or (boolean = 0) are ignored.""",
+                    document=r"""If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False""",
+                    aliases=["add_beam"],
                 ),
             },
             map_output_pin_spec={
@@ -221,8 +230,8 @@ class InputsSkin(_Inputs):
     >>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
     >>> my_duplicate_shell = bool()
     >>> op.inputs.duplicate_shell.connect(my_duplicate_shell)
-    >>> my_add_beam = bool()
-    >>> op.inputs.add_beam.connect(my_add_beam)
+    >>> my_add_beam_point = bool()
+    >>> op.inputs.add_beam_point.connect(my_add_beam_point)
     """
 
     def __init__(self, op: Operator):
@@ -233,8 +242,8 @@ def __init__(self, op: Operator):
         self._inputs.append(self._mesh_scoping)
         self._duplicate_shell = Input(skin._spec().input_pin(2), 2, op, -1)
         self._inputs.append(self._duplicate_shell)
-        self._add_beam = Input(skin._spec().input_pin(3), 3, op, -1)
-        self._inputs.append(self._add_beam)
+        self._add_beam_point = Input(skin._spec().input_pin(3), 3, op, -1)
+        self._inputs.append(self._add_beam_point)
 
     @property
     def mesh(self) -> Input:
@@ -298,10 +307,10 @@ def duplicate_shell(self) -> Input:
         return self._duplicate_shell
 
     @property
-    def add_beam(self) -> Input:
-        r"""Allows to connect add_beam input to the operator.
+    def add_beam_point(self) -> Input:
+        r"""Allows to connect add_beam_point input to the operator.
 
-        If input mesh contains beam elements, output mesh beam elements (boolean = 1) are added or (boolean = 0) are ignored.
+        If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False
 
         Returns
         -------
@@ -312,11 +321,23 @@ def add_beam(self) -> Input:
         --------
         >>> from ansys.dpf import core as dpf
         >>> op = dpf.operators.mesh.skin()
-        >>> op.inputs.add_beam.connect(my_add_beam)
+        >>> op.inputs.add_beam_point.connect(my_add_beam_point)
         >>> # or
-        >>> op.inputs.add_beam(my_add_beam)
+        >>> op.inputs.add_beam_point(my_add_beam_point)
         """
-        return self._add_beam
+        return self._add_beam_point
+
+    def __getattr__(self, name):
+        if name in ["add_beam"]:
+            warn(
+                DeprecationWarning(
+                    f'Operator skin: Input name "{name}" is deprecated in favor of "add_beam_point".'
+                )
+            )
+            return self.add_beam_point
+        raise AttributeError(
+            f"'{self.__class__.__name__}' object has no attribute '{name}'."
+        )
 
 
 class OutputsSkin(_Outputs):

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

@@ -59,7 +59,6 @@
 from .coordinates import coordinates
 from .creep_strain_energy_density import creep_strain_energy_density
 from .current_density import current_density
-from .custom import custom
 from .cyclic_analytic_seqv_max import cyclic_analytic_seqv_max
 from .cyclic_analytic_usum_max import cyclic_analytic_usum_max
 from .cyclic_expansion import cyclic_expansion
@@ -246,6 +245,7 @@
 from .recombine_harmonic_indeces_cyclic import recombine_harmonic_indeces_cyclic
 from .remove_rigid_body_motion import remove_rigid_body_motion
 from .remove_rigid_body_motion_fc import remove_rigid_body_motion_fc
+from .result_provider import result_provider
 from .rigid_transformation import rigid_transformation
 from .rigid_transformation_provider import rigid_transformation_provider
 from .rms_static_pressure import rms_static_pressure

src/ansys/dpf/core/operators/result/__init__.py

@@ -33,7 +33,7 @@ class acceleration(Operator):
     data_sources: DataSources
         result file path container, used if no streams are set
     bool_rotate_to_global: bool, optional
-        if true the field is rotated to global coordinate system (default true)
+        if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.
     mesh: MeshedRegion or MeshesContainer, optional
         mesh. If cylic expansion is to be done, mesh of the base sector
     read_cyclic: int, optional
@@ -190,7 +190,7 @@ def _spec() -> Specification:
                     name="bool_rotate_to_global",
                     type_names=["bool"],
                     optional=True,
-                    document=r"""if true the field is rotated to global coordinate system (default true)""",
+                    document=r"""if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.""",
                 ),
                 7: PinSpecification(
                     name="mesh",
@@ -448,7 +448,7 @@ def data_sources(self) -> Input:
     def bool_rotate_to_global(self) -> Input:
         r"""Allows to connect bool_rotate_to_global input to the operator.
 
-        if true the field is rotated to global coordinate system (default true)
+        if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.
 
         Returns
         -------

src/ansys/dpf/core/operators/result/acceleration.py

@@ -35,7 +35,7 @@ class accu_eqv_creep_strain(Operator):
     data_sources: DataSources
         result file path container, used if no streams are set
     bool_rotate_to_global: bool, optional
-        if true the field is rotated to global coordinate system (default true)
+        if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.
     mesh: MeshedRegion or MeshesContainer, optional
         prevents from reading the mesh in the result files
     requested_location: str, optional
@@ -194,7 +194,7 @@ def _spec() -> Specification:
                     name="bool_rotate_to_global",
                     type_names=["bool"],
                     optional=True,
-                    document=r"""if true the field is rotated to global coordinate system (default true)""",
+                    document=r"""if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.""",
                 ),
                 7: PinSpecification(
                     name="mesh",
@@ -468,7 +468,7 @@ def data_sources(self) -> Input:
     def bool_rotate_to_global(self) -> Input:
         r"""Allows to connect bool_rotate_to_global input to the operator.
 
-        if true the field is rotated to global coordinate system (default true)
+        if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.
 
         Returns
         -------