Skip to content

feat: post26 submodule #3892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: feat/main_commands
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changelog.d/3892.miscellaneous.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Feat: ``post26`` submodule
7 changes: 4 additions & 3 deletions doc/source/mapdl_commands/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,12 +186,13 @@ time-history processor.
:maxdepth: 1
:caption: POST26

post26/setup
post26/_set_up
post26/controls
post26/operations
post26/display
post26/listing
post26/special
post26/operations
post26/set_up
post26/special_purpose
post26/status


Expand Down
18 changes: 18 additions & 0 deletions doc/source/mapdl_commands/post26/_set_up.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

.. _ref__set_up:


SetUp
=====


.. currentmodule:: ansys.mapdl.core._commands.post26._set_up

.. autoclass:: ansys.mapdl.core._commands.post26._set_up.SetUp

.. autosummary::
:template: base.rst
:toctree: _autosummary


SetUp.gapf
25 changes: 13 additions & 12 deletions doc/source/mapdl_commands/post26/controls.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
.. _ref_post26_controls_api:

********
.. _ref_controls:


Controls
********
========

.. currentmodule:: ansys.mapdl.core

These POST26 commands are used to control the calculations of other
commands.
.. currentmodule:: ansys.mapdl.core._commands.post26.controls

.. autoclass:: ansys.mapdl.core._commands.post26.controls.Controls

.. autosummary::
:toctree: _autosummary/
:template: base.rst
:toctree: _autosummary


Mapdl.cfact
Mapdl.force
Mapdl.layerp26
Mapdl.shell
Mapdl.tvar
Controls.cfact
Controls.layerp26
Controls.tvar
30 changes: 17 additions & 13 deletions doc/source/mapdl_commands/post26/display.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
.. _ref_display_api:

*******
.. _ref_display:


Display
*******
=======


.. currentmodule:: ansys.mapdl.core
.. currentmodule:: ansys.mapdl.core._commands.post26.display

These POST26 commands are used to display the results.
.. autoclass:: ansys.mapdl.core._commands.post26.display.Display

.. autosummary::
:toctree: _autosummary/

Mapdl.keep
Mapdl.plcplx
Mapdl.pltime
Mapdl.plvar
Mapdl.spread
Mapdl.xvar
:template: base.rst
:toctree: _autosummary


Display.keep
Display.plcplx
Display.pltime
Display.plvar
Display.spread
Display.xvar
30 changes: 30 additions & 0 deletions doc/source/mapdl_commands/post26/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

.. _ref_post26:

Post26
======

.. list-table::

* - :ref:`ref_operations`
* - :ref:`ref_set_up`
* - :ref:`ref_controls`
* - :ref:`ref_special_purpose`
* - :ref:`ref_listing`
* - :ref:`ref__set_up`
* - :ref:`ref_display`
* - :ref:`ref_status`


.. toctree::
:maxdepth: 1
:hidden:

operations
set_up
controls
special_purpose
listing
_set_up
display
status
31 changes: 17 additions & 14 deletions doc/source/mapdl_commands/post26/listing.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
.. _ref_post26_listing_api:

*******
.. _ref_listing:


Listing
*******
=======


.. currentmodule:: ansys.mapdl.core
.. currentmodule:: ansys.mapdl.core._commands.post26.listing

These POST26 commands are used to produce tabular listings of the
results.
.. autoclass:: ansys.mapdl.core._commands.post26.listing.Listing

.. autosummary::
:toctree: _autosummary/

Mapdl.extrem
Mapdl.lines
Mapdl.nprint
Mapdl.prcplx
Mapdl.prtime
Mapdl.prvar
:template: base.rst
:toctree: _autosummary


Listing.extrem
Listing.lines
Listing.nprint
Listing.prcplx
Listing.prtime
Listing.prvar
53 changes: 28 additions & 25 deletions doc/source/mapdl_commands/post26/operations.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
.. _ref_operations_api:

**********
.. _ref_operations:


Operations
**********
==========


.. currentmodule:: ansys.mapdl.core
.. currentmodule:: ansys.mapdl.core._commands.post26.operations

These POST26 commands are used to perform operations on the stored
variables.
.. autoclass:: ansys.mapdl.core._commands.post26.operations.Operations

.. autosummary::
:toctree: _autosummary/

Mapdl.abs
Mapdl.add
Mapdl.atan
Mapdl.clog
Mapdl.conjug
Mapdl.deriv
Mapdl.exp
Mapdl.filldata
Mapdl.imagin
Mapdl.int1
Mapdl.large
Mapdl.nlog
Mapdl.prod
Mapdl.quot
Mapdl.realvar
Mapdl.small
Mapdl.sqrt
:template: base.rst
:toctree: _autosummary


Operations.abs
Operations.add
Operations.atan
Operations.clog
Operations.conjug
Operations.deriv
Operations.exp
Operations.filldata
Operations.imagin
Operations.int1
Operations.large
Operations.nlog
Operations.prod
Operations.quot
Operations.realvar
Operations.small
Operations.sqrt
34 changes: 34 additions & 0 deletions doc/source/mapdl_commands/post26/set_up.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

.. _ref_set_up:


SetUp
=====


.. currentmodule:: ansys.mapdl.core._commands.post26.set_up

.. autoclass:: ansys.mapdl.core._commands.post26.set_up.SetUp

.. autosummary::
:template: base.rst
:toctree: _autosummary


SetUp.ansol
SetUp.cisol
SetUp.data
SetUp.enersol
SetUp.esol
SetUp.gssol
SetUp.jsol
SetUp.nsol
SetUp.nstore
SetUp.numvar
SetUp.rforce
SetUp.rgb
SetUp.solu
SetUp.store
SetUp.timerange
SetUp.vardel
SetUp.varnam
34 changes: 0 additions & 34 deletions doc/source/mapdl_commands/post26/setup.rst

This file was deleted.

21 changes: 0 additions & 21 deletions doc/source/mapdl_commands/post26/special.rst

This file was deleted.

25 changes: 25 additions & 0 deletions doc/source/mapdl_commands/post26/special_purpose.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

.. _ref_special_purpose:


SpecialPurpose
==============


.. currentmodule:: ansys.mapdl.core._commands.post26.special_purpose

.. autoclass:: ansys.mapdl.core._commands.post26.special_purpose.SpecialPurpose

.. autosummary::
:template: base.rst
:toctree: _autosummary


SpecialPurpose.cvar
SpecialPurpose.pmgtran
SpecialPurpose.rcyc
SpecialPurpose.resp
SpecialPurpose.rpsd
SpecialPurpose.smooth
SpecialPurpose.vget
SpecialPurpose.vput
22 changes: 12 additions & 10 deletions doc/source/mapdl_commands/post26/status.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
.. _ref_status_api:

******
.. _ref_status:


Status
******
======

.. currentmodule:: ansys.mapdl.core

These POST26 commands are for use with the STAT command.
.. currentmodule:: ansys.mapdl.core._commands.post26.status

.. autoclass:: ansys.mapdl.core._commands.post26.status.Status

.. autosummary::
:toctree: _autosummary/
:template: base.rst
:toctree: _autosummary


Mapdl.define
Mapdl.operate
Mapdl.plotting
Mapdl.print
Status.operate
Status.plotting
Loading
Loading