Skip to content

feat: solution submodule #3881

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

Closed
wants to merge 11 commits into from
Closed
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/3881.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
feat: ``solution`` submodule
64 changes: 8 additions & 56 deletions doc/source/mapdl_commands/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ are grouped by capability.
:maxdepth: 1
:caption: Session

session/run_controls
session/processor_entry
session/files
session/list_controls

session/index.rst

********
Database
Expand All @@ -34,12 +30,7 @@ These commands are used to operate on the database globally.
:maxdepth: 1
:caption: Database

database/setup
database/selecting
database/components
database/working_plane
database/coord_sys
database/picking
database/index.rst

********
Graphics
Expand All @@ -50,14 +41,7 @@ These commands are used to control the graphics of the program.
:maxdepth: 1
:caption: Graphics

graphics/setup
graphics/views
graphics/scaling
graphics/style
graphics/labeling
graphics/graphs
graphics/annotation

graphics/index.rst

****
APDL
Expand Down Expand Up @@ -120,36 +104,7 @@ These commands are used to load and solve the model.
:maxdepth: 1
:caption: Solution

solution/analysis_options
solution/nonlinear_options
solution/dynamic_options
solution/spectrum_options
solution/load_step_options
solution/solid_constraints
solution/solid_forces
solution/solid_surface_loads
solution/solid_body_loads
solution/inertia
solution/miscellaneous_loads
solution/load_step_operations
solution/master_dof
solution/gap_conditions
solution/rezoning
solution/2d_to_3d_analysis
solution/birth_and_death
solution/fe_constraints
solution/fe_forces
solution/fe_surface_loads
solution/fe_body_loads
solution/ocean
solution/solution_status
solution/radiosity
solution/multi_field_solver_definition_commands
solution/multi_field_solver_global_controls
solution/multi_field_solver_time_controls
solution/multi_field_solver_load_transfer
solution/multi_field_solver_convergence_controls
solution/multi_field_solver_interface_mapping
solution/index.rst

*****
POST1
Expand Down Expand Up @@ -205,8 +160,7 @@ binary files produced by the program.
:maxdepth: 1
:caption: AUX2

aux2/bin_dump
aux2/bin_manip
aux2/index.rst

****
AUX3
Expand All @@ -218,7 +172,7 @@ files by deleting sets or by changing values.
:maxdepth: 1
:caption: AUX3

aux3/results_files
aux3/index.rst


*****
Expand All @@ -231,9 +185,7 @@ analyses.
:maxdepth: 1
:caption: AUX12

aux12/general_radiation
aux12/radiation_mat
aux12/radiosity_solver
aux12/index.rst


*****
Expand All @@ -245,7 +197,7 @@ These commands are used to read in an IGES file for analysis in ANSYS.
:maxdepth: 1
:caption: AUX15

aux15/iges
aux15/index.rst


*****************
Expand Down
14 changes: 0 additions & 14 deletions doc/source/mapdl_commands/solution/2d_to_3d_analysis.rst

This file was deleted.

20 changes: 20 additions & 0 deletions doc/source/mapdl_commands/solution/_gap_conditions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

.. _ref__gap_conditions:


GapConditions
=============


.. currentmodule:: ansys.mapdl.core._commands.solution._gap_conditions

.. autoclass:: ansys.mapdl.core._commands.solution._gap_conditions.GapConditions

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


GapConditions.gp
GapConditions.gpdele
GapConditions.gplist
18 changes: 18 additions & 0 deletions doc/source/mapdl_commands/solution/_nonlinear_options.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

.. _ref__nonlinear_options:


NonlinearOptions
================


.. currentmodule:: ansys.mapdl.core._commands.solution._nonlinear_options

.. autoclass:: ansys.mapdl.core._commands.solution._nonlinear_options.NonlinearOptions

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


NonlinearOptions.crplim
18 changes: 18 additions & 0 deletions doc/source/mapdl_commands/solution/_status.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

.. _ref__status:


Status
======


.. currentmodule:: ansys.mapdl.core._commands.solution._status

.. autoclass:: ansys.mapdl.core._commands.solution._status.Status

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


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

.. _ref_additive_manufacturing:


AdditiveManufacturing
=====================


.. currentmodule:: ansys.mapdl.core._commands.solution.additive_manufacturing

.. autoclass:: ansys.mapdl.core._commands.solution.additive_manufacturing.AdditiveManufacturing

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


AdditiveManufacturing.ambeam
AdditiveManufacturing.ambuild
AdditiveManufacturing.amenv
AdditiveManufacturing.ammat
AdditiveManufacturing.ampowder
AdditiveManufacturing.amresult
AdditiveManufacturing.amstep
AdditiveManufacturing.amsupports
AdditiveManufacturing.amtype
18 changes: 18 additions & 0 deletions doc/source/mapdl_commands/solution/analysis_2d_to_3d.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

.. _ref_analysis_2d_to_3d:


Analysis2DTo3D
==============


.. currentmodule:: ansys.mapdl.core._commands.solution.analysis_2d_to_3d

.. autoclass:: ansys.mapdl.core._commands.solution.analysis_2d_to_3d.Analysis2DTo3D

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


Analysis2DTo3D.map2dto3d
121 changes: 63 additions & 58 deletions doc/source/mapdl_commands/solution/analysis_options.rst
Original file line number Diff line number Diff line change
@@ -1,64 +1,69 @@
.. _ref_analysis_options_commands_api:

****************
Analysis options
****************
.. _ref_analysis_options:

.. currentmodule:: ansys.mapdl.core

These SOLUTION commands are used to set general analysis options.
AnalysisOptions
===============


.. currentmodule:: ansys.mapdl.core._commands.solution.analysis_options

.. autoclass:: ansys.mapdl.core._commands.solution.analysis_options.AnalysisOptions

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


Mapdl.abextract
Mapdl.accoption
Mapdl.adams
Mapdl.antype
Mapdl.ascres
Mapdl.asol
Mapdl.bcsoption
Mapdl.cgrow
Mapdl.cmatrix
Mapdl.cmsopt
Mapdl.cncheck
Mapdl.cnkmod
Mapdl.cntr
Mapdl.cutcontrol
Mapdl.ddoption
Mapdl.dmpext
Mapdl.dmpoption
Mapdl.dspoption
Mapdl.exbopt
Mapdl.ematwrite
Mapdl.eqslv
Mapdl.eresx
Mapdl.escheck
Mapdl.essolv
Mapdl.expass
Mapdl.gauge
Mapdl.gmatrix
Mapdl.lanboption
Mapdl.lumpm
Mapdl.moddir
Mapdl.monitor
Mapdl.msave
Mapdl.msolve
Mapdl.opncontrol
Mapdl.outaero
Mapdl.ovcheck
Mapdl.pcgopt
Mapdl.perturb
Mapdl.prscontrol
Mapdl.pscontrol
Mapdl.rate
Mapdl.resvec
Mapdl.rstoff
Mapdl.scopt
Mapdl.seexp
Mapdl.seopt
Mapdl.snoption
Mapdl.solve
Mapdl.stabilize
Mapdl.thexpand
Mapdl.thopt
AnalysisOptions.abextract
AnalysisOptions.accoption
AnalysisOptions.adams
AnalysisOptions.antype
AnalysisOptions.ascres
AnalysisOptions.asol
AnalysisOptions.bcsoption
AnalysisOptions.cjump
AnalysisOptions.cload
AnalysisOptions.cmatrix
AnalysisOptions.cmsopt
AnalysisOptions.cnkmod
AnalysisOptions.cntr
AnalysisOptions.cutcontrol
AnalysisOptions.ddoption
AnalysisOptions.dmpext
AnalysisOptions.dmpoption
AnalysisOptions.dspoption
AnalysisOptions.ematwrite
AnalysisOptions.eqslv
AnalysisOptions.eresx
AnalysisOptions.exbopt
AnalysisOptions.expass
AnalysisOptions.gauge
AnalysisOptions.gmatrix
AnalysisOptions.invopt
AnalysisOptions.lanboption
AnalysisOptions.lumpm
AnalysisOptions.moddir
AnalysisOptions.monitor
AnalysisOptions.msave
AnalysisOptions.msolve
AnalysisOptions.opncontrol
AnalysisOptions.outaero
AnalysisOptions.pcgopt
AnalysisOptions.perturb
AnalysisOptions.pivcheck
AnalysisOptions.prscontrol
AnalysisOptions.pscontrol
AnalysisOptions.psolve
AnalysisOptions.rate
AnalysisOptions.resvec
AnalysisOptions.rstoff
AnalysisOptions.scopt
AnalysisOptions.seexp
AnalysisOptions.seopt
AnalysisOptions.snoption
AnalysisOptions.solve
AnalysisOptions.stabilize
AnalysisOptions.thexpand
AnalysisOptions.thopt
AnalysisOptions.toffst
Loading