sloshing_initialization module reference

Initialization for the “sloshing” internal waves configuration.

Functions/Subroutines

`sloshing_initialize_topography()`	Initialization of topography.
`sloshing_initialize_thickness()`	Initialization of thicknesses This routine is called when THICKNESS_CONFIG is set to 'sloshing'.
`sloshing_initialize_temperature_salinity()`	Initialization of temperature and salinity.

Detailed Description

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

Function/Subroutine Documentation

subroutine sloshing_initialization/sloshing_initialize_topography(D, G, param_file, max_depth)

Initialization of topography.

Parameters:

g :: [in] The dynamic horizontal grid type
d :: [out] Ocean bottom depth [Z ~> m]
param_file :: param_file [in] Parameter file structure
max_depth :: max_depth [in] Maximum ocean depth [Z ~> m]

Called from:

mom_fixed_initialization::mom_initialize_topography

[source]

subroutine sloshing_initialization/sloshing_initialize_thickness(h, depth_tot, G, GV, US, param_file, just_read)

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 :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
h :: h [out] The thickness that is being initialized [Z ~> m]
depth_tot :: depth_tot [in] The nominal total depth of the ocean [Z ~> m]
param_file :: param_file [in] A structure to parse for model parameter values.
just_read :: just_read [in] If true, this call will only read parameters without changing h.

[source]

subroutine sloshing_initialization/sloshing_initialize_temperature_salinity(T, S, h, G, GV, US, param_file, just_read)

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 :: [in] Ocean grid structure.
gv :: [in] The ocean’s vertical grid structure.
t :: [out] Potential temperature [C ~> degC].
s :: [out] Salinity [S ~> ppt].
h :: h [in] Layer thickness [Z ~> m].
us :: [in] A dimensional unit scaling type
param_file :: param_file [in] A structure to parse for model parameter values.
just_read :: just_read [in] If true, this call will only read parameters without changing T & S.

Called from:

mom_state_initialization::mom_initialize_state

[source]