rgc_initialization module reference¶
Configures the models sponges for the Rotating Gravity Current (RGC) experiment.
Functions/Subroutines¶
Sets up the the inverse restoration time, and the values towards which the interface heights, velocities and tracers should be restored within the sponges for the RGC test case. |
Detailed Description¶
Configures the models sponges for the Rotating Gravity Current (RGC) experiment.
Function/Subroutine Documentation¶
-
subroutine
rgc_initialization/
rgc_initialize_sponges
(G, GV, US, tv, u, v, depth_tot, PF, use_ALE, CSp, ACSp)¶ Sets up the the inverse restoration time, and the values towards which the interface heights, velocities and tracers should be restored within the sponges for the RGC test case.
- Parameters:
g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
tv :: [in] A structure containing pointers to any available thermodynamic fields, potential temperature and salinity or mixed layer density. Absent fields have NULL pointers.
u :: [in] Array with the u velocity [L T-1 ~> m s-1]
v :: [in] Array with the v velocity [L T-1 ~> m s-1]
depth_tot :: [in] The nominal total depth of the ocean [Z ~> m]
pf :: [in] A structure to parse for model parameter values.
use_ale :: [in] If true, indicates model is in ALE mode
csp :: Layer-mode sponge structure
acsp :: ALE-mode sponge structure
- Call to:
mom_eos::eos_domain
mom_error_handler::mom_error
mom_sponge::set_up_sponge_ml_density
- Called from: