adjustment_initialization module reference

Configures the model for the geostrophic adjustment test case.

More…

Functions/Subroutines

adjustment_initialize_thickness()

Initializes the layer thicknesses in the adjustment test case.

adjustment_initialize_temperature_salinity()

Initialization of temperature and salinity in the adjustment test case.

Detailed Description

Configures the model for the geostrophic adjustment test case.

Function/Subroutine Documentation

subroutine adjustment_initialization/adjustment_initialize_thickness(h, G, GV, US, param_file, just_read)

Initializes the layer thicknesses in the adjustment 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].

  • 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 adjustment_initialization/adjustment_initialize_temperature_salinity(T, S, h, depth_tot, G, GV, param_file, eqn_of_state, just_read)

Initialization of temperature and salinity in the adjustment test case.

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

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

  • t :: [out] The temperature that is being initialized.

  • s :: [out] The salinity that is being initialized.

  • h :: [in] The model thicknesses [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.

  • eqn_of_state :: Equation of state.

  • 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

Called from

mom_state_initialization::mom_initialize_state