feat: using dpf instead of reader in "results" module

doc/changelog.d/1300.miscellaneous.md

@@ -0,0 +1 @@
+feat: using dpf instead of reader in "results" module

src/ansys/mapdl/core/__init__.py

@@ -66,13 +66,14 @@
 # Import related globals
 _HAS_ATP: bool = is_installed("ansys.tools.path")
 _HAS_CLICK: bool = is_installed("click")
-_HAS_PIM: bool = is_installed("ansys.platform.instancemanagement")
+_HAS_DPF: bool = is_installed("ansys.dpf.core")
+_HAS_MATPLOTLIB: bool = is_installed("matplotlib")
 _HAS_PANDAS: bool = is_installed("pandas")
+_HAS_PIM: bool = is_installed("ansys.platform.instancemanagement")
 _HAS_PYANSYS_REPORT: bool = is_installed("ansys.tools.report")
 _HAS_PYVISTA: bool = is_installed("pyvista")
 _HAS_REQUESTS: bool = is_installed("requests")
 _HAS_TQDM: bool = is_installed("tqdm")
-_HAS_MATPLOTLIB: bool = is_installed("matplotlib")
 _HAS_VISUALIZER: bool = (
     is_installed("ansys.tools.visualization_interface") and _HAS_MATPLOTLIB
 )

src/ansys/mapdl/core/_commands/post1_/setup.py

@@ -572,7 +572,7 @@ def set(
                 ``to_array`` on the object returning from ``mapdl.set("list")``.
 
         sbstep
-            Substep number (within Lstep). Defaults to the last substep of the
+            Substep number (within ``Lstep``). Defaults to the last substep of the
             load step (except in a buckling or modal analysis). For a buckling
             (``ANTYPE,BUCKLE``) or modal (``ANTYPE,MODAL``) analysis, ``Sbstep``
             corresponds to the mode number. Specify ``Sbstep = LAST`` to store the

src/ansys/mapdl/core/examples/__init__.py

@@ -20,9 +20,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from .downloads import (
+from ansys.mapdl.core.examples.downloads import (
     download_bracket,
     download_cfx_mapping_example_data,
     download_manifold_example_data,
 )
-from .verif_files import vmfiles
+
+# Canonical Examples
+from ansys.mapdl.core.examples.examples import *
+from ansys.mapdl.core.examples.verif_files import vmfiles

src/ansys/mapdl/core/examples/examples.py

@@ -24,10 +24,25 @@
 import os
 
 # get location of this folder and the example files
-dir_path: str = os.path.dirname(os.path.realpath(__file__))
+__dir_path: str = os.path.dirname(os.path.realpath(__file__))
 
 # add any files you'd like to import here.  For example:
-wing_model: str = os.path.join(dir_path, "wing.dat")
+wing_model: str = os.path.join(__dir_path, "wing.dat")
+
+# Verification files
+from ansys.mapdl.core.examples.verif_files import vmfiles
+
+laterally_loaded_tapered_support_structure = vmfiles["vm5"]
+pinched_cylinder = vmfiles["vm6"]
+transient_thermal_stress_in_a_cylinder = vmfiles["vm33"]
+elongation_of_a_solid_bar = vmfiles["vm37"]
+natural_frequency_of_a_piezoelectric_transducer = vmfiles["vm175"]
+frequency_response_of_electrical_input_admittance = vmfiles["vm176"]
+electrothermal_microactuator_analysis = vmfiles["vm223"]
+piezoelectric_rectangular_strip_under_pure_bending_load = vmfiles["vm231"]
+transient_response_of_a_ball_impacting_a_flexible_surface = vmfiles["vm65"]
+threed_nonaxisymmetric_vibration_of_a_stretched_membrane = vmfiles["vm155"]
+modal_analysis_of_a_cyclic_symmetric_annular_plate = vmfiles["vm244"]
 
 # be sure to add the input file directly in this directory
 # This way, files can be loaded with:

src/ansys/mapdl/core/mapdl_core.py

@@ -362,6 +362,9 @@ def __init__(
 
         self._info = Information(self)
 
+        # DPF
+        self._dpf_result: "DPFResult | None" = None
+
     def _after_run(self, _command: str) -> None:
         pass
 
@@ -1049,7 +1052,11 @@ def graphics_backend(self, value: GraphicsBackend):
     @property
     @requires_package("ansys.mapdl.reader", softerror=True)
     def result(self):
-        """Binary interface to the result file using :class:`ansys.mapdl.reader.rst.Result`.
+        """Binary interface to the result file using ``ansys-dpf-core`` or
+        ``ansys-mapdl-reader``.
+
+        If `ansys-dpf-core` is not installed, then a :class:`ansys.mapdl.reader.rst.Result`
+        object is returned.
 
         Returns
         -------
@@ -1083,12 +1090,27 @@ def result(self):
         NSL : Nodal displacements
         RF  : Nodal reaction forces
         """
+        from ansys.mapdl.core import _HAS_DPF
+
+        if _HAS_DPF:
+            from ansys.mapdl.core.reader import DPFResult
+
+            if self._dpf_result is None:
+                # create a DPFResult object
+                self._dpf_result = DPFResult(None, mapdl=self)
+
+            return self._dpf_result
+
         from ansys.mapdl.reader import read_binary
         from ansys.mapdl.reader.rst import Result
 
         if not self._local:
             # download to temporary directory
-            save_path = os.path.join(tempfile.gettempdir())
+            save_path = os.path.join(
+                tempfile.gettempdir(), f"ansys_tmp_{random_string()}"
+            )
+            if not os.path.exists(save_path):
+                os.mkdir(save_path)
             result_path = self.download_result(save_path)
         else:
             if self._distributed_result_file and self._result_file:

src/ansys/mapdl/core/post.py

@@ -862,7 +862,7 @@ def _edof_rst(self, item, it1num=""):
     def nodal_temperature(self) -> np.ndarray:
         """The nodal temperature of the current result.
 
-        Equilvanent MAPDL command:
+        Equivalent MAPDL command:
         ``PRNSOL, TEMP``
 
         Notes
@@ -944,7 +944,7 @@ def plot_nodal_temperature(self, show_node_numbering=False, **kwargs):
     def nodal_displacement(self, component="NORM") -> np.ndarray:
         """Nodal X, Y, or Z structural displacement.
 
-        Equilvanent MAPDL command:
+        Equivalent MAPDL command:
 
         * ``PRNSOL, U, X``
 
@@ -1067,7 +1067,7 @@ def plot_nodal_displacement(
     def nodal_rotation(self, component="ALL") -> np.ndarray:
         """Nodal X, Y, or Z structural rotation
 
-        Equilvanent MAPDL commands:
+        Equivalent MAPDL commands:
 
         * ``PRNSOL, ROT, X``
         * ``PRNSOL, ROT, Y``
@@ -1180,7 +1180,7 @@ def element_displacement(self, component="ALL", option="AVG") -> np.ndarray:
         One value per element.  Either minimum, maximum, or average of
         all nodes in each element.
 
-        Equilvanent MAPDL commands:
+        Equivalent MAPDL commands:
 
         * ``ETABLE,VALUES,U,X``
         * ``PRETAB,VALUES`` or ``*VGET,TMP,ELEM,1,ETAB,VALUES``
@@ -1324,7 +1324,7 @@ def element_stress(self, component, option="AVG") -> np.ndarray:
         One value per element.  Either minimum, maximum, or average of
         all nodes in each element.
 
-        Equilvanent MAPDL commands:
+        Equivalent MAPDL commands:
 
         * ``ETABLE,VALUES,S,X``
         * ``PRETAB,VALUES`` or ``*VGET,TMP,ELEM,1,ETAB,VALUES``
@@ -1467,7 +1467,7 @@ def element_temperature(self, option="AVG") -> np.ndarray:
         One value per element.  Either minimum, maximum, or average of
         all nodes in each element.
 
-        Equilvanent MAPDL commands:
+        Equivalent MAPDL commands:
 
         * ``ETABLE,VALUES,TEMP``
         * ``PRETAB,VALUES`` or ``*VGET,TMP,ELEM,1,ETAB,VALUES``
@@ -1558,7 +1558,7 @@ def plot_element_temperature(
     def nodal_pressure(self) -> np.ndarray:
         """The nodal pressure of the current result.
 
-        Equilvanent MAPDL command:
+        Equivalent MAPDL command:
         ``PRNSOL, PRES``
 
         Notes
@@ -1640,7 +1640,7 @@ def plot_nodal_pressure(self, show_node_numbering=False, **kwargs):
     def nodal_voltage(self) -> np.ndarray:
         """The nodal voltage of the current result.
 
-        Equilvanent MAPDL command:
+        Equivalent MAPDL command:
 
         * ``PRNSOL, PRES``
 
@@ -1729,7 +1729,7 @@ def plot_nodal_voltage(self, show_node_numbering=False, **kwargs):
     def nodal_component_stress(self, component) -> np.ndarray:
         """Nodal component stress.
 
-        Equilvanent MAPDL commands:
+        Equivalent MAPDL commands:
 
         * ``VGET, PARM, NODE, , S, X``
         * ``PRNSOL, S, COMP``
@@ -1821,7 +1821,7 @@ def plot_nodal_component_stress(
     def nodal_principal_stress(self, component) -> np.ndarray:
         """Nodal principal stress.
 
-        Equilvanent MAPDL commands:
+        Equivalent MAPDL commands:
 
         * ``*VGET, PARM, NODE, , S, 1``
         * ``PRNSOL, S, PRIN``
@@ -1914,7 +1914,7 @@ def plot_nodal_principal_stress(
     def nodal_stress_intensity(self) -> np.ndarray:
         """The nodal stress intensity of the current result.
 
-        Equilvanent MAPDL command: ``PRNSOL, S, PRIN``
+        Equivalent MAPDL command: ``PRNSOL, S, PRIN``
 
         Notes
         -----
@@ -2000,7 +2000,7 @@ def plot_nodal_stress_intensity(self, show_node_numbering=False, **kwargs):
     def nodal_eqv_stress(self) -> np.ndarray:
         """The nodal equivalent stress of the current result.
 
-        Equilvanent MAPDL command: ``PRNSOL, S, PRIN``
+        Equivalent MAPDL command: ``PRNSOL, S, PRIN``
 
         Returns
         -------
@@ -2098,7 +2098,7 @@ def nodal_total_component_strain(self, component) -> np.ndarray:
 
         Includes elastic, plastic, and creep strain.
 
-        Equilvanent MAPDL commands:
+        Equivalent MAPDL commands:
 
         * ``*VGET, PARM, NODE, , EPTO, X``
 
@@ -2195,7 +2195,7 @@ def nodal_total_principal_strain(self, component) -> np.ndarray:
 
         Includes elastic, plastic, and creep strain.
 
-        Equilvanent MAPDL command:
+        Equivalent MAPDL command:
 
         * ``*VGET,PARM,NODE,,EPTO,1``
 
@@ -2293,7 +2293,7 @@ def plot_nodal_total_principal_strain(
     def nodal_total_strain_intensity(self) -> np.ndarray:
         """The total nodal strain intensity of the current result.
 
-        Equilvanent MAPDL command:
+        Equivalent MAPDL command:
 
         * ``PRNSOL, EPTO, PRIN``
 
@@ -2383,7 +2383,7 @@ def plot_nodal_total_strain_intensity(self, show_node_numbering=False, **kwargs)
     def nodal_total_eqv_strain(self) -> np.ndarray:
         """The total nodal equivalent strain of the current result.
 
-        Equilvanent MAPDL command:
+        Equivalent MAPDL command:
 
         * ``PRNSOL, EPTO, PRIN``
 

src/ansys/mapdl/core/reader/__init__.py

@@ -0,0 +1,23 @@
+# Copyright (C) 2016 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from .result import DPFResult