Skip to content

Commit

Permalink
small fixes in sphinx doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tgastine committed Apr 4, 2024
1 parent 721e938 commit 14ad36d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
1 change: 0 additions & 1 deletion doc/sphinx/apiFortran/timeAdvLinear.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ Linear calculation part of the time stepping (LMLoop)

.. f:automodule:: updateb_mod
``updatePHI.f90``
------------------

Expand Down
5 changes: 5 additions & 0 deletions doc/sphinx/apiPython/misc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,8 @@ Additional possible analyses
:members:
:private-members:
:special-members:

.. autoclass:: magic.libmelt
:members:
:private-members:
:special-members:
2 changes: 1 addition & 1 deletion doc/sphinx/inputNamelists/controlNamelist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -364,4 +364,4 @@ Miscellaneous
| mpi_packing='single' | Transpose each field individually |
+------------------------+--------------------------------------------------+

* **l_adv_curl** (default :f:var:`l_adv_curl=.false. <l_adv_curl>`) is a logical. When set to True, the advection term is treated as :math:`\vec{u}\times\vec{\omega}` instead of :math:`\vec{u}\vec{\nabla}\vec{u}`. The practical consequence of that is to reduce the number of spectral/spatial Spherical Harmonic Transforms and hence to speed-up the code. Because of the treatment of the viscous heating term in the anelastic approximation, this is only an option when considering Boussinesq models.
* **l_adv_curl** (default :f:var:`l_adv_curl=.true. <l_adv_curl>`) is a logical. When set to True, the advection term is treated as :math:`\vec{u}\times\vec{\omega}` instead of :math:`\vec{u}\vec{\nabla}\vec{u}`. The practical consequence of that is to reduce the number of spectral/spatial Spherical Harmonic Transforms and hence to speed-up the code. Because of the treatment of the viscous heating term in the anelastic approximation, this is only an option when considering Boussinesq models.

0 comments on commit 14ad36d

Please sign in to comment.