From 601921b203ede23a37d302bc81119d1163664edc Mon Sep 17 00:00:00 2001 From: zhi Date: Fri, 20 Dec 2024 14:33:54 -0500 Subject: [PATCH] update docs on spherical rotation axis --- Docs/source/rotation.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Docs/source/rotation.rst b/Docs/source/rotation.rst index 2bb60ea4a4..caa9482ca4 100644 --- a/Docs/source/rotation.rst +++ b/Docs/source/rotation.rst @@ -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 @@ -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