dumbbell_initialization module reference

Configures the model for the idealized dumbbell test case.

More…

Functions/Subroutines

dumbbell_initialize_topography()

Initialization of topography.

dumbbell_initialize_thickness()

Initializes the layer thicknesses to be uniform in the dumbbell test case.

dumbbell_initialize_temperature_salinity()

Initial values for temperature and salinity for the dumbbell test case.

dumbbell_initialize_sponges()

Initialize the restoring sponges for the dumbbell test case.

Detailed Description

Configures the model for the idealized dumbbell test case.

Function/Subroutine Documentation

subroutine dumbbell_initialization/dumbbell_initialize_topography(D, G, param_file, max_depth)

Initialization of topography.

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

  • d :: [out] Ocean bottom depth in the units of depth_max

  • param_file :: [in] Parameter file structure

  • max_depth :: [in] Maximum ocean depth in arbitrary units

Call to

mdl

Called from

mom_fixed_initialization::mom_initialize_topography

subroutine dumbbell_initialization/dumbbell_initialize_thickness(h, depth_tot, G, GV, US, param_file, just_read)

Initializes the layer thicknesses to be uniform in the dumbbell test case.

Parameters
  • g :: [in] The ocean’s grid structure.

  • gv :: [in] The ocean’s vertical grid structure.

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

  • h :: [out] The thickness that is being initialized [H ~> m or kg m-2].

  • 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_mesg regrid_consts::regridding_rho regrid_consts::regridding_sigma

subroutine dumbbell_initialization/dumbbell_initialize_temperature_salinity(T, S, h, G, GV, param_file, eqn_of_state, just_read)

Initial values for temperature and salinity for the dumbbell test case.

Parameters
  • g :: [in] Ocean grid structure

  • gv :: [in] Vertical grid structure

  • t :: [out] Potential temperature [degC]

  • s :: [out] Salinity [ppt]

  • h :: [in] Layer thickness [H ~> m or kg m-2]

  • param_file :: [in] Parameter file structure

  • eqn_of_state :: Equation of state structure

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

Call to

mdl

subroutine dumbbell_initialization/dumbbell_initialize_sponges(G, GV, US, tv, depth_tot, param_file, use_ALE, CSp, ACSp)

Initialize the restoring sponges for the dumbbell test case.

Parameters
  • g :: [in] Horizontal grid control structure

  • gv :: [in] Vertical grid control structure

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

  • tv :: [in] Thermodynamic variables

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

  • param_file :: [in] Parameter file structure

  • use_ale :: [in] ALE flag

  • csp :: Layered sponge control structure pointer

  • acsp :: ALE sponge control structure pointer

Call to

mdl

Called from

mom_state_initialization::mom_initialize_state