docs changes

src/equilibria/smod_equil_couette_flow.f08

@@ -1,5 +1,18 @@
 ! =============================================================================
-!> This submodule defines a steady plane Couette flow in a Cartesian geometry.
+!> This submodule defines a steady plane Couette flow in a Cartesian geometry
+!! with flow and viscosity.
+!! @note Default values are given by
+!!
+!! - <tt>k2</tt> = 0
+!! - <tt>k3</tt> = 1
+!! - <tt>cte_rho0</tt> = 1
+!! - <tt>cte_T0</tt> = 1
+!! - <tt>cte_v02</tt> = 0
+!! - <tt>cte_v03</tt> = 1
+!! - <tt>viscosity</tt> = True
+!! - <tt>viscosity_value</tt> = 1e-3
+!!
+!! and can all be changed in the parfile. @endnote
 submodule (mod_equilibrium) smod_equil_couette_flow
   implicit none
 

src/equilibria/smod_equil_harris_sheet.f08

@@ -3,7 +3,20 @@
 !! by a Harris sheet.
 !!
 !! This equilibrium is taken from Shi et al. (2020), Oblique tearing mode
-!! instability: guide field and Hall effect
+!! instability: guide field and Hall effect. _The Astrophysical Journal_, 902:142.
+!! [DOI](https://doi.org/10.3847/1538-4357/abb6fa).
+!! @note Default values are given by
+!!
+!! - <tt>k2</tt> = 0.12
+!! - <tt>k3</tt> = 0
+!! - <tt>cte_rho0</tt> = 1
+!! - <tt>cte_T0</tt> = 1
+!! - <tt>cte_B02</tt> = 1
+!! - <tt>cte_B03</tt> = 0 : guide field parameter.
+!! - <tt>alpha</tt> = 1 : used to set the width of the current sheet.
+!! - <tt>eq_bool</tt> = False : if True, an alternative force-free Harris sheet is used.
+!!
+!! and can all be changed in the parfile. @endnote
 submodule (mod_equilibrium) smod_equil_harris_sheet
   implicit none
 

src/mod_global_variables.f08

@@ -71,13 +71,13 @@ module mod_global_variables
   real(dp)                  :: dropoff_width
   !> boolean for viscosity, defaults to <tt>False</tt>
   logical, save             :: viscosity
-  !> boolean to include viscoous heating, defaults to <tt>False</tt>
+  !> boolean to include viscous heating, defaults to <tt>False</tt>
   logical, save             :: viscous_heating
-  !> defines the fixed value for either the dynamic or kinematic viscosity, defaults to 0
+  !> defines the fixed value for the dynamic viscosity, defaults to 0
   real(dp)                  :: viscosity_value
   !> boolean to use Hall MHD, defaults to <tt>False</tt>
   logical, save             :: hall_mhd
-  !> boolean to use substitution for Hall elements, defaults to <tt>True</tt>
+  !> boolean to use substitution for Hall elements (as presented in the paper), defaults to <tt>True</tt>
   logical, save             :: hall_substitution
   !> boolean to use dropoff profile for Hall parameter, defaults to <tt>False</tt>
   logical, save             :: hall_dropoff

src/physics/mod_hall.f08

@@ -1,6 +1,6 @@
 ! =============================================================================
-!> !> Module containing Hall-related routines, calculates
-!! and sets the Hall and inertia term factors based on the specified profiles.
+!> Module containing Hall-related routines.
+!! Sets the Hall and electron inertia factors based on normalisations and specified profiles.
 module mod_hall
   use mod_global_variables, only: dp, dim_quadblock
 
@@ -13,8 +13,8 @@ module mod_hall
 contains
 
   !> Retrieves the normalised Hall factor as described by Porth et al. (2014),
-  !! with a dropoff at the boundary, if desired. Additionally defines the
-  !! inertia term factor if included, with a dropoff profile, if desired.
+  !! with a dropoff at the boundary, if desired. Additionally, defines the
+  !! electron inertia factor if included, with a dropoff profile, if desired.
   subroutine set_hall_factors(hall_field)
     use mod_grid, only: grid_gauss
     use mod_physical_constants, only: dpi