namespace dome2d_initialization

Overview

Initialization of the 2D DOME experiment with density water initialized on a coastal shelf. More…

namespace dome2d_initialization {

// global functions

subroutine, public dome2d_initialize_topography(D D, G G, param_file param_file, max_depth max_depth);

subroutine, public dome2d_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    );

subroutine, public dome2d_initialize_temperature_salinity(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    just_read_params just_read_params
    );

subroutine, public dome2d_initialize_sponges(
    G G,
    GV GV,
    tv tv,
    param_file param_file,
    use_ALE use_ALE,
    CSp CSp,
    ACSp ACSp
    );

} // namespace dome2d_initialization

Detailed Documentation

Initialization of the 2D DOME experiment with density water initialized on a coastal shelf.

Global Functions

subroutine, public dome2d_initialize_topography(
    D D,
    G G,
    param_file param_file,
    max_depth max_depth
    )

Initialize topography with a shelf and slope in a 2D domain.

Parameters:

g	The dynamic horizontal grid type
d	Ocean bottom depth in the units of depth_max
param_file	Parameter file structure
max_depth	Maximum ocean depth in arbitrary units

subroutine, public dome2d_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    )

Initialize thicknesses according to coordinate mode.

Parameters:

g	Ocean grid structure
gv	Vertical grid structure
us	A dimensional unit scaling type
h	The thickness that is being initialized [H ~> m or kg m-2].
param_file	A structure indicating the open file to parse for model parameter values.
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public dome2d_initialize_temperature_salinity(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    just_read_params just_read_params
    )

Initialize temperature and salinity in the 2d DOME configuration.

Parameters:

g	Ocean grid structure
gv	The ocean’s vertical grid structure.
t	Potential temperature [degC]
s	Salinity [ppt]
h	Layer thickness [H ~> m or kg m-2]
param_file	Parameter file structure
eqn_of_state	Equation of state structure
just_read_params	If present and true, this call will only read parameters without changing T & S.

subroutine, public dome2d_initialize_sponges(
    G G,
    GV GV,
    tv tv,
    param_file param_file,
    use_ALE use_ALE,
    CSp CSp,
    ACSp ACSp
    )

Set up sponges in 2d DOME configuration.

Parameters:

g	Ocean grid structure
gv	Vertical grid structure
tv	Thermodynamics structure
param_file	Parameter file structure
use_ale	If true, indicates model is in ALE mode
csp	Layer-mode sponge structure
acsp	ALE-mode sponge structure