namespace rgc_initialization

Overview

namespace rgc_initialization {

// global functions

subroutine, public rgc_initialize_sponges(
    G G,
    GV GV,
    tv tv,
    u u,
    v v,
    PF PF,
    use_ALE use_ALE,
    CSp CSp,
    ACSp ACSp
    );

} // namespace rgc_initialization

Detailed Documentation

Global Functions

subroutine, public rgc_initialize_sponges(
    G G,
    GV GV,
    tv tv,
    u u,
    v v,
    PF PF,
    use_ALE use_ALE,
    CSp CSp,
    ACSp 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	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
tv	A structure containing pointers to any available thermodynamic fields, potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
u	Array with the u velocity [L T-1 ~> m s-1]
v	Array with the v velocity [L T-1 ~> m s-1]
pf	A structure indicating the open file to parse for model parameter values.
use_ale	If true, indicates model is in ALE mode
csp	Layer-mode sponge structure
acsp	ALE-mode sponge structure