namespace sloshing_initialization

Overview

Initialization for the “sloshing” internal waves configuration. More…

namespace sloshing_initialization {

// global functions

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

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

subroutine, public sloshing_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
    );

} // namespace sloshing_initialization

Detailed Documentation

Initialization for the “sloshing” internal waves configuration.

The module configures the model for the non-rotating sloshing test case.

Global Functions

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

Initialization of topography.

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 sloshing_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    )

Initialization of thicknesses This routine is called when THICKNESS_CONFIG is set to ‘sloshing’.

This routine initializes layer positions to set off a sloshing motion in the zonal direction in a rectangular basin. All layers have initially the same thickness but all interfaces (except bottom and sea surface) are displaced according to a half-period cosine, with maximum value on the left and minimum value on the right. This sets off a regular sloshing motion.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s 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 sloshing_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
    )

Initialization of temperature and salinity.

This subroutine initializes linear profiles for T and S according to reference surface layer salinity and temperature and a specified range. Note that the linear distribution is set up with respect to the layer number, not the physical position).

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	A structure indicating the open file to parse for model parameter values.
eqn_of_state	Equation of state structure.
just_read_params	If present and true, this call will only read parameters without changing h.