Skip to content

feat: post1 submodule (2/2) #4002

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 4 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: 0 additions & 1 deletion doc/changelog.d/3983.documentation.md

This file was deleted.

1 change: 1 addition & 0 deletions doc/changelog.d/4002.miscellaneous.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Feat: ``post1`` submodule (2/2)
8 changes: 4 additions & 4 deletions doc/source/mapdl_commands/post1/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Post1
* - :ref:`ref_controls`
* - :ref:`ref_special_purpose`
* - :ref:`ref_status`
* - :ref:`_ref_magnetics_calculations`
* - :ref:`ref_magnetics_calculations`
* - :ref:`ref_element_table`
* - :ref:`ref_failure_criteria`
* - :ref:`ref__fatigue`
Expand All @@ -29,11 +29,11 @@ Post1
:hidden:

animation
setup
set_up
controls
special
special_purpose
status
magnetics_calc
magnetics_calculations
element_table
failure_criteria
_fatigue
Expand Down
23 changes: 0 additions & 23 deletions doc/source/mapdl_commands/post1/magnetics_calc.rst

This file was deleted.

26 changes: 26 additions & 0 deletions doc/source/mapdl_commands/post1/magnetics_calculations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

.. _ref_magnetics_calculations:


MagneticsCalculations
=====================


.. currentmodule:: ansys.mapdl.core._commands.post1.magnetics_calculations

.. autoclass:: ansys.mapdl.core._commands.post1.magnetics_calculations.MagneticsCalculations

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


MagneticsCalculations.curr2d
MagneticsCalculations.emagerr
MagneticsCalculations.emf
MagneticsCalculations.emft
MagneticsCalculations.fluxv
MagneticsCalculations.mmf
MagneticsCalculations.plf2d
MagneticsCalculations.powerh
MagneticsCalculations.senergy
61 changes: 33 additions & 28 deletions doc/source/mapdl_commands/post1/path_operations.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,38 @@
.. _ref_path_operations_api:

***************
Path operations
***************
.. _ref_path_operations:

.. currentmodule:: ansys.mapdl.core

These POST1 commands are used for path operations.
PathOperations
==============


.. currentmodule:: ansys.mapdl.core._commands.post1.path_operations

.. autoclass:: ansys.mapdl.core._commands.post1.path_operations.PathOperations

.. autosummary::
:toctree: _autosummary/

Mapdl.padele
Mapdl.paget
Mapdl.paput
Mapdl.paresu
Mapdl.pasave
Mapdl.path
Mapdl.pcalc
Mapdl.pcross
Mapdl.pdef
Mapdl.pdot
Mapdl.plpagm
Mapdl.plpath
Mapdl.plsect
Mapdl.pmap
Mapdl.ppath
Mapdl.prange
Mapdl.prpath
Mapdl.prsect
Mapdl.psel
Mapdl.pvect
:template: base.rst
:toctree: _autosummary


PathOperations.fssect
PathOperations.padele
PathOperations.paget
PathOperations.paput
PathOperations.paresu
PathOperations.pasave
PathOperations.path
PathOperations.pcalc
PathOperations.pcross
PathOperations.pdef
PathOperations.pdot
PathOperations.plpagm
PathOperations.plpath
PathOperations.plsect
PathOperations.pmap
PathOperations.ppath
PathOperations.prange
PathOperations.prpath
PathOperations.prsect
PathOperations.psel
PathOperations.pvect
60 changes: 32 additions & 28 deletions doc/source/mapdl_commands/post1/results.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,38 @@
.. _ref_results_api:

*******
.. _ref_results:


Results
*******
=======


.. currentmodule:: ansys.mapdl.core
.. currentmodule:: ansys.mapdl.core._commands.post1.results

These POST1 commands are used to process results, such as
degree-of-freedom results, nodal stresses, and element summable and
non-summable miscellaneous data.
.. autoclass:: ansys.mapdl.core._commands.post1.results.Results

.. autosummary::
:toctree: _autosummary/

Mapdl.nsort
Mapdl.nusort
Mapdl.plcint
Mapdl.pldisp
Mapdl.plesol
Mapdl.plnsol
Mapdl.plorb
Mapdl.prenergy
Mapdl.prorb
Mapdl.plvect
Mapdl.prcint
Mapdl.presol
Mapdl.prjsol
Mapdl.prnld
Mapdl.prnsol
Mapdl.prrfor
Mapdl.prrsol
Mapdl.prvect
Mapdl.sumtype
:template: base.rst
:toctree: _autosummary


Results.lcsum
Results.nsort
Results.nusort
Results.plcint
Results.plcksurf
Results.pldisp
Results.plesol
Results.plnsol
Results.plorb
Results.plvect
Results.prcint
Results.prenergy
Results.presol
Results.prjsol
Results.prnld
Results.prnsol
Results.prorb
Results.prrfor
Results.prrsol
Results.prvect
Results.sumtype
26 changes: 26 additions & 0 deletions doc/source/mapdl_commands/post1/set_up.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

.. _ref_set_up:


SetUp
=====


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

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

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


SetUp.append
SetUp.desol
SetUp.detab
SetUp.dnsol
SetUp.hrcplx
SetUp.rescombine
SetUp.reset
SetUp.set
SetUp.subset
21 changes: 0 additions & 21 deletions doc/source/mapdl_commands/post1/setup.rst

This file was deleted.

49 changes: 0 additions & 49 deletions doc/source/mapdl_commands/post1/special.rst

This file was deleted.

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

.. _ref_special_purpose:


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


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

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

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


SpecialPurpose.bfint
SpecialPurpose.cbdof
SpecialPurpose.cmsfile
SpecialPurpose.cyccalc
SpecialPurpose.cycfiles
SpecialPurpose.cycphase
SpecialPurpose.cycspec
SpecialPurpose.exoption
SpecialPurpose.expand
SpecialPurpose.exprofile
SpecialPurpose.exunit
SpecialPurpose.fssparm
SpecialPurpose.fsum
SpecialPurpose.hfang
SpecialPurpose.hfsym
SpecialPurpose.macopt
SpecialPurpose.nforce
SpecialPurpose.nldpost
SpecialPurpose.plas
SpecialPurpose.plcamp
SpecialPurpose.plcfreq
SpecialPurpose.plchist
SpecialPurpose.plfar
SpecialPurpose.plmc
SpecialPurpose.plnear
SpecialPurpose.plzz
SpecialPurpose.pras
SpecialPurpose.prcamp
SpecialPurpose.prfar
SpecialPurpose.prmc
SpecialPurpose.prnear
SpecialPurpose.reswrite
SpecialPurpose.rmflvec
SpecialPurpose.rsplit
SpecialPurpose.rstmac
SpecialPurpose.slashexpand
SpecialPurpose.spmwrite
SpecialPurpose.spoint
SpecialPurpose.vtkwrite
Loading
Loading