Skip to content

Commit 46512dd

Browse files
committed
Doc
1 parent 3a6bb23 commit 46512dd

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/source/modules/selfGravity.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,18 @@ The boundary conditions can be following
8787
| origin | | In spherical coordinates, artificially extends the grid used to compute the potential close to R=0. |
8888
| | | should only be used in X1-beg direction. |
8989
+-----------------------+------------------------------------------------------------------------------------------------------------------+
90+
| shearingbox | Shearingbox boundary conditions. |
91+
+-----------------------+------------------------------------------------------------------------------------------------------------------+
9092
| userdef | |User-defined boundary conditions. The boundary condition function should be enrolled in the setup constructor |
9193
| | | (see :ref:`userdefBoundaries`). |
9294
+-----------------------+------------------------------------------------------------------------------------------------------------------+
9395

9496
.. note::
9597
The method in fully periodic setups requires the removal of the mean gas density
96-
before solving Poisson equation. This is done automatically if all of the self-gravity boundaries are set to ``periodic``.
97-
Hence, make sure to specify all self-gravity boundary conditions as periodic for such setups, otherwise the solver will
98+
before solving Poisson equation. This is done automatically if all of the self-gravity boundaries are set to ``periodic`` or ``shearingbox``.
99+
Hence, make sure to specify all self-gravity boundary conditions as periodic (or shearingbox) for such setups, otherwise the solver will
98100
fail to converge.
101+
Note that in these cases, if the initial density is uniform, the self-gravity solver will fail as this correspond to a vaccum initial state.
99102

100103
The selfGravity module in *Idefix* is fully parallelised. This means that one can have a MPI domain decomposition in any spatial direction
101104
either on CPU or GPU.

0 commit comments

Comments
 (0)