feat: aux2 submodule (#3683)

* feat: ``aux1`` submodule generated with ``mapdl-cmld-conv``

* chore: adding changelog file 3683.added.md [dependabot-skip]

* fix: ``commands.py``

* fix: removing ``-W`` flag in doc build

* fix: properly using Sphinx ``:file:`` role

* junk: for comparison

* feat: latest changes + fix codespell

* ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

* fix: renaming ``aux2_`` into ``aux2``

* ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

* fix: revert change in ``ci.yml``

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: German <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

doc/changelog.d/3683.added.md

@@ -0,0 +1 @@
+feat: ``aux2`` submodule

doc/source/conf.py

@@ -124,7 +124,7 @@
     "ansys-tools-path": ("https://path.tools.docs.pyansys.com/version/stable/", None),
 }
 
-# ref.ref warning needs to be readded when merging to main
+# ref.ref warning needs to be re-added when merging to main
 suppress_warnings = [
     "label.*",
     "design.fa-build",

doc/source/mapdl_commands/aux2/binary_file_dump.rst

@@ -0,0 +1,22 @@
+
+.. _ref_binary_file_dump:
+
+
+BinaryFileDump
+==============
+
+
+.. currentmodule:: ansys.mapdl.core._commands.aux2.binary_file_dump
+
+.. autoclass:: ansys.mapdl.core._commands.aux2.binary_file_dump.BinaryFileDump
+
+.. autosummary::
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   BinaryFileDump.aux2
+   BinaryFileDump.dump
+   BinaryFileDump.fileaux2
+   BinaryFileDump.form
+   BinaryFileDump.ptr

doc/source/mapdl_commands/aux2/binary_file_manipulation.rst

@@ -0,0 +1,20 @@
+
+.. _ref_binary_file_manipulation:
+
+
+BinaryFileManipulation
+======================
+
+
+.. currentmodule:: ansys.mapdl.core._commands.aux2.binary_file_manipulation
+
+.. autoclass:: ansys.mapdl.core._commands.aux2.binary_file_manipulation.BinaryFileManipulation
+
+.. autosummary::
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   BinaryFileManipulation.combine
+   BinaryFileManipulation.hbmat
+   BinaryFileManipulation.psmat

doc/source/mapdl_commands/aux2/index.rst

@@ -0,0 +1,18 @@
+
+.. _ref_aux2:
+
+Aux2
+====
+
+.. list-table::
+
+   * - :ref:`ref_binary_file_dump`
+   * - :ref:`ref_binary_file_manipulation`
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   binary_file_dump
+   binary_file_manipulation

pyproject.toml

@@ -159,7 +159,7 @@ omit = [
 show_missing = true
 
 [tool.codespell]
-skip = '*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,*.cdb,*.CDB,build,./docker/mapdl/v*,./factory/*,./ansys/mapdl/core/mapdl_functions.py,PKG-INFO,*.mypy_cache/*,./docker/mapdl/*,./_unused/*,./src/ansys/mapdl/core/_commands/apdl/*'
+skip = '*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,*.cdb,*.CDB,build,./docker/mapdl/v*,./factory/*,./ansys/mapdl/core/mapdl_functions.py,PKG-INFO,*.mypy_cache/*,./docker/mapdl/*,./_unused/*,*/ansys/mapdl/core/_commands/apdl/*'
 quiet-level = 3
 ignore-regex=".*codespell-ignore$|NORML|POIN"
 ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt"

src/ansys/mapdl/core/_commands/aux2_/__init__.py → src/ansys/mapdl/core/_commands/aux2/__init__.py

@@ -20,4 +20,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from . import bin_dump, bin_manip
+from . import binary_file_dump, binary_file_manipulation

src/ansys/mapdl/core/_commands/aux2/binary_file_dump.py

@@ -0,0 +1,144 @@
+# 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.
+
+
+class BinaryFileDump:
+
+    def dump(self, nstrt: str = "", nstop: str = "", **kwargs):
+        r"""Dumps the contents of a binary file.
+
+        Mechanical APDL Command: `DUMP <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_DUMP.html>`_
+
+        Parameters
+        ----------
+        nstrt : str
+            Dump file from record ``NSTRT`` (defaults to 1) to ``NSTOP`` (defaults to ``NSTRT`` ). If
+            ``NSTRT`` = HEAD, dump only record 1 of the file ( ``NSTOP`` and the format specification are
+            ignored). If ``NSTRT`` = ALL, dump the entire file.
+
+        nstop : str
+            Dump file from record ``NSTRT`` (defaults to 1) to ``NSTOP`` (defaults to ``NSTRT`` ). If
+            ``NSTRT`` = HEAD, dump only record 1 of the file ( ``NSTOP`` and the format specification are
+            ignored). If ``NSTRT`` = ALL, dump the entire file.
+
+        Notes
+        -----
+        Dumps the file named on the AUX2 :ref:`fileaux2` command according the format specified on the
+        :ref:`form` command.
+        """
+        command = f"DUMP,{nstrt},{nstop}"
+        return self.run(command, **kwargs)
+
+    def aux2(self, **kwargs):
+        r"""Enters the binary file dumping processor.
+
+        Mechanical APDL Command: `/AUX2 <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_AUX2.html>`_
+
+        Notes
+        -----
+        Enters the binary file-dumping processor (auxiliary processor AUX2), used for dumping the contents
+        of certain Mechanical APDL binary files for visual examination.
+
+        This command is valid only at the Begin Level.
+        """
+        command = "/AUX2"
+        return self.run(command, **kwargs)
+
+    def form(self, lab: str = "", **kwargs):
+        r"""Specifies the format of the file dump.
+
+        Mechanical APDL Command: `FORM <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_FORM.html>`_
+
+        Parameters
+        ----------
+        lab : str
+            Format:
+
+            * ``RECO`` - Basic record description only (minimum output) (default).
+
+            * ``TEN`` - Same as RECO plus the first ten words of each record.
+
+            * ``LONG`` - Same as RECO plus all words of each record.
+
+        Notes
+        -----
+        Specifies the format of the file dump (from the :ref:`dump` command).
+        """
+        command = f"FORM,{lab}"
+        return self.run(command, **kwargs)
+
+    def fileaux2(self, fname: str = "", ident: str = "", **kwargs):
+        r"""Specifies the binary file to be dumped.
+
+        Mechanical APDL Command: `FILEAUX2 <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_FILEAUX2.html>`_
+
+        Parameters
+        ----------
+        fname : str
+            File name and directory path (248 characters maximum, including the characters needed for the
+            directory path). An unspecified directory path defaults to the working directory; in this case,
+            you can use all 248 characters for the file name. The file name defaults to the current
+            :file:`Jobname` if ``Ident`` is specified.
+
+        ident : str
+            File name identifier. See the `Basic Analysis Guide
+            <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en/ans_bas/Hlp_G_BAS19.html>`_ for file
+            descriptions and identifiers. If not an identifier, the program uses ``Ident`` as the file name
+            extension.
+
+        Notes
+        -----
+        Specifies the binary file to be dumped with the :ref:`dump` command.
+        """
+        command = f"FILEAUX2,{fname},{ident}"
+        return self.run(command, **kwargs)
+
+    def ptr(
+        self, loc: str = "", base: str = "", loch: str = "", baseh: str = "", **kwargs
+    ):
+        r"""Dumps the record of a binary file.
+
+        Mechanical APDL Command: `PTR <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_PTR.html>`_
+
+        Parameters
+        ----------
+        loc : str
+            Dump the file record starting at pointer ``LOC``. ``BASE`` is the base pointer, and would be
+            used if ``LOC`` is a relative pointer.
+
+        base : str
+            Dump the file record starting at pointer ``LOC``. ``BASE`` is the base pointer, and would be
+            used if ``LOC`` is a relative pointer.
+
+        loch : str
+            Second 32-bit integer (if required) for defining the 64-bit pointer.
+
+        baseh : str
+            Second 32-bit integer (if required) for defining the 64-bit pointer.
+
+        Notes
+        -----
+        Dumps the record of the file named on the AUX2 :ref:`fileaux2` command according the format
+        specified on the :ref:`form` command.
+        """
+        command = f"PTR,{loc},{base},{loch},{baseh}"
+        return self.run(command, **kwargs)