namespace mom_state_initialization

Overview

Initialization functions for state variables, u, v, h, T and S. More…

namespace mom_state_initialization {

// global functions

subroutine, public mom_initialize_state(
    u u,
    v v,
    h h,
    tv tv,
    Time Time,
    G G,
    GV GV,
    US US,
    PF PF,
    dirs dirs,
    restart_CS restart_CS,
    ALE_CSp ALE_CSp,
    tracer_Reg tracer_Reg,
    sponge_CSp sponge_CSp,
    ALE_sponge_CSp ALE_sponge_CSp,
    OBC OBC,
    Time_in Time_in
    );

} // namespace mom_state_initialization

Detailed Documentation

Initialization functions for state variables, u, v, h, T and S.

Global Functions

subroutine, public mom_initialize_state(
    u u,
    v v,
    h h,
    tv tv,
    Time Time,
    G G,
    GV GV,
    US US,
    PF PF,
    dirs dirs,
    restart_CS restart_CS,
    ALE_CSp ALE_CSp,
    tracer_Reg tracer_Reg,
    sponge_CSp sponge_CSp,
    ALE_sponge_CSp ALE_sponge_CSp,
    OBC OBC,
    Time_in Time_in
    )

Initialize temporally evolving fields, either as initial conditions or by reading them from a restart (or saves) file.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
u	The zonal velocity that is being
v	The meridional velocity that is being
h	Layer thicknesses [H ~> m or kg m-2]
tv	A structure pointing to various thermodynamic variables
time	Time at the start of the run segment.
pf	A structure indicating the open file to parse for model parameter values.
dirs	A structure containing several relevant directory paths.
restart_cs	A pointer to the restart control structure.
ale_csp	The ALE control structure for remapping
tracer_reg	A pointer to the tracer registry
sponge_csp	The layerwise sponge control structure.
ale_sponge_csp	The ALE sponge control structure.
obc	The open boundary condition control structure.
time_in	Time at the start of the run segment. Time_in overrides any value set for Time.