dome2d_initialization module reference

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

More…

Functions/Subroutines

dome2d_initialize_topography()	Initialize topography with a shelf and slope in a 2D domain.
dome2d_initialize_thickness()	Initialize thicknesses according to coordinate mode.
dome2d_initialize_temperature_salinity()	Initialize temperature and salinity in the 2d DOME configuration.
dome2d_initialize_sponges()	Set up sponges in 2d DOME configuration.

Detailed Description

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

Function/Subroutine Documentation

subroutine dome2d_initialization/dome2d_initialize_topography(D, G, param_file, max_depth)

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

Parameters:

• g :: [in] The dynamic horizontal grid type

• d :: [out] Ocean bottom depth [Z ~> m]

• param_file :: [in] Parameter file structure

• max_depth :: [in] Maximum ocean depth [Z ~> m]

Call to:

mdl

Called from:

mom_fixed_initialization::mom_initialize_topography

subroutine dome2d_initialization/dome2d_initialize_thickness(h, depth_tot, G, GV, US, param_file, just_read)

Initialize thicknesses according to coordinate mode.

Parameters:

• g :: [in] Ocean grid structure

• gv :: [in] Vertical grid structure

• us :: [in] A dimensional unit scaling type

• h :: [out] The thickness that is being initialized [Z ~> m]

• depth_tot :: [in] The nominal total depth of the ocean [Z ~> m]

• param_file :: [in] A structure indicating the open file to parse for model parameter values.

• just_read :: [in] If true, this call will only read parameters without changing h.

Call to:

mdl mom_error_handler::mom_error mom_error_handler::mom_mesg regrid_consts::regridding_rho regrid_consts::regridding_sigma

subroutine dome2d_initialization/dome2d_initialize_temperature_salinity(T, S, h, G, GV, US, param_file, just_read)

Initialize temperature and salinity in the 2d DOME configuration.

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 :: [in] Layer thickness [Z ~> m]

• us :: [in] A dimensional unit scaling type

• param_file :: [in] Parameter file structure

• just_read :: [in] If true, this call will only read parameters without changing T & S.

Call to:

mdl mom_error_handler::mom_error regrid_consts::regridding_rho regrid_consts::regridding_sigma

subroutine dome2d_initialization/dome2d_initialize_sponges(G, GV, US, tv, depth_tot, param_file, use_ALE, CSp, ACSp)

Set up sponges in 2d DOME configuration.

Parameters:

• g :: [in] Ocean grid structure

• gv :: [in] Vertical grid structure

• us :: [in] A dimensional unit scaling type

• tv :: [in] Thermodynamics structure

• depth_tot :: [in] The nominal total depth of the ocean [Z ~> m]

• param_file :: [in] Parameter file structure

• use_ale :: [in] If true, indicates model is in ALE mode

• csp :: Layer-mode sponge structure

• acsp :: ALE-mode sponge structure

Call to:

mom_sponge::initialize_sponge mdl mom_error_handler::mom_error

Called from:

mom_state_initialization::mom_initialize_state