Merge branch 'main' into release/0.60

Author: akaszynski

.github/workflows/nightly-doc-build.yml

@@ -1,7 +1,6 @@
 name: Nightly Documentation Build
 
 on:
-  pull_request:
   schedule:  # UTC at 0400
     - cron:  '0 4 * * *'
   workflow_dispatch:

README.rst

@@ -4,7 +4,7 @@ PyMAPDL
     :target: https://pypi.org/project/ansys-mapdl-core/
 
 .. image:: https://github.com/pyansys/pymapdl/actions/workflows/ci.yml/badge.svg
-   :target: https://github.com/pyansys/pymapdl/actions/workflows/tci.yml
+   :target: https://github.com/pyansys/pymapdl/actions/workflows/ci.yml
 
 .. image:: https://zenodo.org/badge/70696039.svg
    :target: https://zenodo.org/badge/latestdoi/70696039
@@ -32,7 +32,7 @@ MAPDL and supports:
 
 Here's a quick demo of PyMAPDL within VSCode:
 
-.. image:: https://github.com/pyansys/pymapdl/raw/fix/auto_complete_vscode/doc/landing_page_demo.gif
+.. image:: https://github.com/pyansys/pymapdl/raw/main/doc/landing_page_demo.gif
 
 PyMAPDL works within Jupyter Notebooks, the standard Python console,
 or in batch mode on Windows, Linux, and even Mac OS.

ansys/mapdl/core/_commands/database/selecting.py

@@ -130,6 +130,43 @@ def asel(
 
             STAT - Display the current select status.
 
+
+        The following fields are used only with Type = S, R, A, or U:
+
+        Item
+            Label identifying data. Valid item labels are shown in Table 105: ASEL - Valid Item and Component
+            Labels (p. 185). Some items also require a component label. If Item = PICK (or simply "P"), graphical
+            picking is enabled and all remaining command fields are ignored (valid only in the GUI). Defaults
+            to AREA.
+
+        Comp
+            Component of the item (if required). Valid component labels are shown in Table 105: ASEL - Valid
+            Item and Component Labels (p. 185).
+
+        VMIN
+            Minimum value of item range. Ranges are area numbers, coordinate values, attribute numbers, etc.,
+            as appropriate for the item. A component name (as specified on the CM (p. 338) command) may
+            also be substituted for VMIN (VMAX and VINC are ignored). If Item = MAT, TYPE, REAL, or ESYS
+            and if VMIN is positive, the absolute value of Item is compared against the range for selection; if
+            VMIN is negative, the signed value of Item is compared. See the ALIST (p. 106) command for a
+            discussion of signed attributes.
+
+        VMAX
+            Maximum value of item range. VMAX defaults to VMIN.
+
+        VINC
+            Value increment within range. Used only with integer ranges (such as for area numbers). Defaults
+            to 1. VINC cannot be negative.
+
+        KSWP
+            Specifies whether only areas are to be selected:
+
+                - `kswp = 0` - Select areas only.
+                - `kswp = 1` - Select areas, as well as keypoints, lines, nodes, and elements associated with selected areas.
+
+            Valid only with Type = S.
+
+
         Notes
         -----
         Selects a subset of areas. For example, to select those areas with area
@@ -597,6 +634,38 @@ def ksel(
 
             STAT - Display the current select status.
 
+
+        The following fields are used only with Type = S, R, A, or U:
+
+        Item
+            Label identifying data. Valid item labels are shown in the table below. Some items also require a
+            component label. If Item = PICK (or simply "P"), graphical picking is enabled and all remaining
+            command fields are ignored (valid only in the GUI). Defaults to KP.
+
+        Comp
+            Component of the item (if required). Valid component labels are shown in the table below.
+
+        VMIN
+            Minimum value of item range. Ranges are keypoint numbers, coordinate values, attribute numbers,
+            etc., as appropriate for the item. A component name (as specified on the CM (p. 338) command)
+            may also be substituted for VMIN (VMAX and VINC are ignored). If Item = MAT, TYPE, REAL, or
+            ESYS and if VMIN is positive, the absolute value of Item is compared against the range for selection;
+            if VMIN is negative, the signed value of Item is compared. See the KLIST (p. 942) command for a
+            discussion of signed attributes.
+
+        VMAX
+            Maximum value of item range. VMAX defaults to VMIN.
+
+        VINC
+            Value increment within range. Used only with integer ranges (such as for keypoint numbers). Defaults
+            to 1. VINC cannot be negative.
+
+        KABS
+            Absolute value key:
+
+                - `kabs = 0` - Check sign of value during selection.
+                - `kabs = 1` - Use absolute value during selection (sign ignored).
+
         Notes
         -----
         Selects a subset of keypoints or hard points.  For example, to select a
@@ -727,6 +796,40 @@ def lsel(
 
             STAT - Display the current select status.
 
+
+        The following fields are used only with Type = S, R, A, or U:
+
+        Item
+            Label identifying data. Valid item labels are shown in the table below. Some items also require a
+            component label. If Item = PICK (or simply "P"), graphical picking is enabled and all remaining
+            command fields are ignored (valid only in the GUI). Defaults to LINE.
+
+        Comp
+            Component of the item (if required). Valid component labels are shown in the table below.
+
+        VMIN
+            Minimum value of item range. Ranges are line numbers, coordinate values, attribute numbers, etc.,
+            as appropriate for the item. If VMIN = 0.0, a tolerance of ±1.0E-6 is used, or ±0.005 x VMIN if VMIN
+            = VMAX. A component name (as specified on the CM (p. 338) command) may also be substituted
+            for VMIN (VMAX and VINC are ignored). If Item = MAT, TYPE, REAL, ESYS, or NDIV and if VMIN is
+            positive, the absolute value of Item is compared against the range for selection; if VMIN is negative,
+            the signed value of Item is compared. See the LLIST (p. 1011) command for a discussion of signed
+            attributes.
+
+        VMAX
+            Maximum value of item range. VMAX defaults to VMIN.
+
+        VINC
+            Value increment within range. Used only with integer ranges (such as for line numbers). Defaults
+            to 1. VINC cannot be negative.
+
+        KSWP
+            Specifies whether only lines are to be selected:
+
+                - `kswp = 0` - Select lines only.
+                - `kswp = 1` - Select lines, as well as keypoints, nodes, and elements associated with selected lines. Valid
+            only with Type = S.
+
         Notes
         -----
         Selects lines based on values of a labeled item and component.  For
@@ -860,6 +963,36 @@ def nsel(
 
             STAT - Display the current select status.
 
+
+        The following fields are used only with Type = S, R, A, or U:
+
+        Item
+            Label identifying data. Valid item labels are shown in the table below. Some items also require a
+            component label. If Item = PICK (or simply "P"), graphical picking is enabled and all remaining
+            command fields are ignored (valid only in the GUI). Defaults to NODE.
+
+        Comp
+            Component of the item (if required). Valid component labels are shown in the table below.
+
+        VMIN
+            Minimum value of item range. Ranges are node numbers, set numbers, coordinate values, load
+            values, or result values as appropriate for the item. A component name (as specified on the CM (p. 338)
+            command) may also be substituted for VMIN (VMAX and VINC are ignored).
+
+        VMAX
+            Maximum value of item range. VMAX defaults to VMIN for input values. For result values, VMAX
+            defaults to infinity if VMIN is positive, or to zero if VMIN is negative.
+
+        VINC
+            Value increment within range. Used only with integer ranges (such as for node and set numbers).
+            Defaults to 1. VINC cannot be negative.
+
+        KABS
+            Absolute value key:
+
+            - `kabs = 0` - Check sign of value during selection.
+            - `kabs = 1` - Use absolute value during selection (sign ignored)
+
         Notes
         -----
         Selects a subset of nodes.  For example, to select a new set of nodes
@@ -1268,6 +1401,38 @@ def vsel(
 
             STAT - Display the current select status.
 
+        The following fields are used only with Type = S, R, A, or U:
+
+        Item
+            Label identifying data. Valid item labels are shown in the table below. Some items also require a
+            component label. If Item = PICK (or simply "P"), graphical picking is enabled and all remaining
+            command fields are ignored (valid only in the GUI). Defaults to VOLU.
+
+        Comp
+            Component of the item (if required). Valid component labels are shown in the table below.
+
+        VMIN
+            Minimum value of item range. Ranges are volume numbers, coordinate values, attribute numbers,
+            etc., as appropriate for the item. A component name (as specified on the CM (p. 338) command)
+            may also be substituted for VMIN (VMAX and VINC are ignored). If Item = MAT, TYPE, REAL, or
+            ESYS and if VMIN is positive, the absolute value of Item is compared against the range for selection;
+            if VMIN is negative, the signed value of Item is compared. See the VLIST (p. 2050) command for a
+            discussion of signed attributes.
+
+        VMAX
+            Maximum value of item range. VMAX defaults to VMIN.
+
+        VINC
+            Value increment within range. Used only with integer ranges (such as for volume numbers). Defaults
+            to 1. VINC cannot be negative.
+
+        KSWP
+            Specifies whether only volumes are to be selected:
+
+            - `kswp = 0` - Select volumes only.
+            - `kswp = 1` - Select volumes, as well as keypoints, lines, areas,
+            nodes, and elements associated with selected volumes. Valid only with Type = S.
+
         Notes
         -----
         Selects volumes based on values of a labeled item and component.  For

ansys/mapdl/core/_commands/parse.py

@@ -44,30 +44,34 @@ def parse_e(msg: Optional[str]) -> Optional[int]:
 
 
 def parse_kpoint(msg):
+    """Parse create keypoint message and return keypoint number."""
     if msg:
         res = re.search(r"kpoint=\s+(\d+)\s+", msg)
         if res is not None:
             return int(res.group(1))
 
 
 def parse_output_areas(msg):
-    """Parse create area message and return area number"""
+    """Parse create area message and return area number."""
     if msg:
         res = re.search(r"(OUTPUT AREAS =\s*)([0-9]+)", msg)
         if res is not None:
             return int(res.group(2))
+        res = re.search(r"(OUTPUT AREA\(S\) =\s*)([0-9]+)", msg)
+        if res is not None:
+            return int(res.group(2))
 
 
 def parse_a(msg):
-    """Parse create area message and return area number"""
+    """Parse create area message and return area number."""
     if msg:
         res = re.search(r"(AREA NUMBER =\s*)([0-9]+)", msg)
         if res is not None:
             return int(res.group(2))
 
 
 def parse_line_no(msg):
-    """Parse create area message and return area number"""
+    """Parse create line message and return line number."""
     if msg:
         res = re.search(r"LINE NO[.]=\s+(\d+)", msg)
         if res is not None:

ansys/mapdl/core/_commands/post1_/element_table.py

@@ -381,36 +381,57 @@ def pretab(
         lab9="",
         **kwargs,
     ):
-        """Prints the element table items.
+        """Print the element table items.
 
         APDL Command: PRETAB
 
         Parameters
         ----------
-        lab1, lab2, lab3, . . . , lab9
-            Print selected items.  Valid labels are (blank) or any label as
-            specified with the ETABLE command.  Convenience labels may be used
-            for Lab1 to select groups of labels (10 labels maximum):  GRP1 for
-            first 10 stored items; GRP2 for items 11 to 20; GRP3 for items 21
-            to 30; GRP4 for items 31 to 40; GRP5 for items 41 to 50.  Enter
-            ETABLE,STAT command to list stored item order.  If all labels are
+        lab1, lab2, lab3, ... , lab9
+            Print selected items.  Valid labels are ``""`` or any
+            label as specified with the ETABLE command.  Convenience
+            labels may be used for Lab1 to select groups of labels (10
+            labels maximum): GRP1 for first 10 stored items; GRP2 for
+            items 11 to 20; GRP3 for items 21 to 30; GRP4 for items 31
+            to 40; GRP5 for items 41 to 50.  Run ``etable("stat")``
+            command to list stored item order.  If all labels are
             blank, print first 10 stored items (GRP1).
 
         Notes
         -----
-        Prints the items stored in the table defined with the ETABLE command.
-        Item values will be listed for the selected elements in the sorted
-        sequence [ESORT].  The FORCE command can be used to define which
-        component of the nodal load is to be used (static,  damping, inertia,
-        or total).
+        Prints the items stored in the table defined with the
+        :func:`etable() <ansys.mapdl.core.Mapdl.etable>` command.
+        Item values will be listed for the selected elements in the
+        sorted sequence [ESORT].  :func:`force()
+        <ansys.mapdl.core.Mapdl.force>` can be used to define which
+        component of the nodal load is to be used (static, damping,
+        inertia, or total).
+
+        Examples
+        --------
+        Print out element displacement results.
+
+        >>> mapdl.etable("values", "U", "X")
+        STORE VALUES   FROM ITEM=U    COMP=X     FOR ALL SELECTED ELEMENTS
+
+        Now print out the table.
+
+        >>> mapdl.pretab().splitlines()[:4]
+        ['PRINT ELEMENT TABLE ITEMS PER ELEMENT',
+         '       1   0.1073961540E-005  0.1073961540E-005',
+         '       2   0.3156317304E-005  0.3156317304E-005',
+         '       3   0.5125435148E-005  0.5125435148E-005']
+
+        Note that can access the array directly from APDL:
+
+        >>> mapdl.get_array("elem", 1, "ETAB", "values")
+        array([1.07396154e-06, 3.15631730e-06, 5.12543515e-06, ...,
+               5.41204700e-06, 3.33649806e-06, 1.13836132e-06])
 
-        Portions of this command are not supported by PowerGraphics
-        [/GRAPHICS,POWER].
         """
-        command = (
-            f"PRETAB,{lab1},{lab2},{lab3},{lab4},{lab5},{lab6},{lab7},{lab8},{lab9}"
+        return self.run(
+            f"PRETAB,{lab1},{lab2},{lab3},{lab4},{lab5},{lab6},{lab7},{lab8},{lab9}", **kwargs
         )
-        return self.run(command, **kwargs)
 
     def sabs(self, key="", **kwargs):
         """Specifies absolute values for element table operations.

ansys/mapdl/core/_commands/preproc/booleans.py

@@ -36,9 +36,20 @@ def aadd(
         conditions assigned to the original entities will not be
         transferred to the new entities generated.  Concatenated entities
         are not valid with this command.
+
+        Examples
+        --------
+        Generate two areas and combine them.
+
+        >>> a1 = mapdl.rectng(2.5, 3.5, 0, 10)
+        >>> a2 = mapdl.cyl4(0, 10, 2.5, 0, 3.5, 90)
+        >>> a_comb = mapdl.aadd(a1, a2)
+        >>> a_comb
+        3
+
         """
         command = f"AADD,{na1},{na2},{na3},{na4},{na5},{na6},{na7},{na8},{na9}"
-        return self.run(command, **kwargs)
+        return parse.parse_output_areas(self.run(command, **kwargs))
 
     def aglue(
         self,

ansys/mapdl/core/_commands/preproc/volumes.py

@@ -862,10 +862,9 @@ def vrotat(
         nseg="",
         **kwargs,
     ) -> str:
-        """Generate cylindrical volumes by rotating an area pattern about
+        """Generate cylindrical volumes by rotating an area pattern about an axis.
 
         APDL Command: VROTAT
-        an axis.
 
         Generates cylindrical volumes (and their corresponding
         keypoints, lines, and areas) by rotating an area pattern (and