Skip to content

Commit

Permalink
update docs on spherical rotation axis
Browse files Browse the repository at this point in the history
  • Loading branch information
zhichen3 committed Dec 20, 2024
1 parent 0c1c2d4 commit 601921b
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion Docs/source/rotation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ The "vertical direction" is defined as follows:

* ``coord_sys = 1``, (r,z): along the z-axis

* ``coord_sys = 2``, (r, :math:`\theta`): along the z-axis after converting
to the spherical coordiante, i.e.
:math:`\hat{z} = \cos{\theta} \hat{r} = \sin{\theta} \hat{\theta}`.

* 3D

* ``coord_sys = 0``, (x,y,z): along the z-axis
Expand Down Expand Up @@ -76,7 +80,9 @@ The main parameters that affect rotation are:
solve for the update implicitly (default: 1)

- ``castro.rot_axis`` : rotation axis (default: 3
(Cartesian); 2 (cylindrical))
(Cartesian); 2 (cylindrical)). This parameter doesn't affect
Spherical Coordinate since rotation axis is automatically set
to z-axis.

For completeness, we show below a derivation of the source terms that
appear in the momentum and total energy evolution equations upon
Expand Down

0 comments on commit 601921b

Please sign in to comment.