mom_coord_initialization module reference

Initializes fixed aspects of the related to its vertical coordinate.

More…

Functions/Subroutines

mom_initialize_coord()

MOM_initialize_coord sets up time-invariant quantities related to MOM6’s vertical coordinate.

set_coord_from_gprime()

Sets the layer densities (Rlay) and the interface reduced gravities (g).

set_coord_from_layer_density()

Sets the layer densities (Rlay) and the interface reduced gravities (g).

set_coord_from_ts_ref()

Sets the layer densities (Rlay) and the interface reduced gravities (g) from a profile of g’.

set_coord_from_ts_profile()

Sets the layer densities (Rlay) and the interface reduced gravities (g) from a T-S profile.

set_coord_from_ts_range()

Sets the layer densities (Rlay) and the interface reduced gravities (g) from a linear T-S profile.

set_coord_from_file()

set_coord_linear()

Sets the layer densities (Rlay) and the interface reduced gravities (g) according to a linear profile starting at a reference surface layer density and spanning a range of densities to the bottom defined by the parameter RLAY_RANGE (defaulting to 2.0 if not defined)

set_coord_to_none()

Sets Rlay to Rho0 and g_prime to zero except for the free surface.

write_vertgrid_file()

Writes out a file containing any available data related to the vertical grid used by the MOM ocean model.

Detailed Description

Initializes fixed aspects of the related to its vertical coordinate.

Function/Subroutine Documentation

subroutine mom_coord_initialization/mom_initialize_coord(GV, US, PF, write_geom, output_dir, tv, max_depth)

MOM_initialize_coord sets up time-invariant quantities related to MOM6’s vertical coordinate.

Parameters
  • gv :: [inout] Ocean vertical grid structure.

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

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

  • write_geom :: [in] If true, write grid geometry files.

  • output_dir :: [in] The directory into which to write files.

  • tv :: [inout] The thermodynamic variable structure.

  • max_depth :: [in] The ocean’s maximum depth [Z ~> m].

Call to

bfb_initialization::bfb_set_coord mom_error_handler::calltree_enter mom_error_handler::calltree_leave mdl set_coord_from_file set_coord_from_gprime set_coord_from_layer_density set_coord_from_ts_profile set_coord_from_ts_range set_coord_from_ts_ref set_coord_linear set_coord_to_none mom_verticalgrid::setverticalgridaxes user_initialization::user_set_coord write_vertgrid_file

Called from

mom_oda_driver_mod::init_oda

subroutine mom_coord_initialization/set_coord_from_gprime(Rlay, g_prime, GV, US, param_file)

Sets the layer densities (Rlay) and the interface reduced gravities (g).

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

  • rlay :: [out] The layers’ target coordinate values (potential density) [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave

Called from

mom_initialize_coord

subroutine mom_coord_initialization/set_coord_from_layer_density(Rlay, g_prime, GV, US, param_file)

Sets the layer densities (Rlay) and the interface reduced gravities (g).

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

  • rlay :: [out] The layers’ target coordinate values (potential density) [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave

Called from

mom_initialize_coord

subroutine mom_coord_initialization/set_coord_from_ts_ref(Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref)

Sets the layer densities (Rlay) and the interface reduced gravities (g) from a profile of g’.

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

  • rlay :: [out] The layers’ target coordinate values (potential density) [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

  • eqn_of_state :: Equation of state structure

  • p_ref :: [in] The coordinate-density reference pressure [R L2 T-2 ~> Pa].

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave

Called from

mom_initialize_coord

subroutine mom_coord_initialization/set_coord_from_ts_profile(Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref)

Sets the layer densities (Rlay) and the interface reduced gravities (g) from a T-S profile.

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

  • rlay :: [out] Layer potential density [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

  • eqn_of_state :: Equation of state structure

  • p_ref :: [in] The coordinate-density reference pressure [R L2 T-2 ~> Pa].

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_string_functions::slasher

Called from

mom_initialize_coord

subroutine mom_coord_initialization/set_coord_from_ts_range(Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref)

Sets the layer densities (Rlay) and the interface reduced gravities (g) from a linear T-S profile.

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

  • rlay :: [out] Layer potential density [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

  • eqn_of_state :: Equation of state structure

  • p_ref :: [in] The coordinate-density reference pressure [R L2 T-2 ~> Pa].

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave

Called from

mom_initialize_coord

subroutine mom_coord_initialization/set_coord_from_file(Rlay, g_prime, GV, US, param_file)
Parameters
  • gv :: [in] The ocean’s vertical grid structure

  • rlay :: [out] Layer potential density [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_string_functions::slasher

Called from

mom_initialize_coord

subroutine mom_coord_initialization/set_coord_linear(Rlay, g_prime, GV, US, param_file)

Sets the layer densities (Rlay) and the interface reduced gravities (g) according to a linear profile starting at a reference surface layer density and spanning a range of densities to the bottom defined by the parameter RLAY_RANGE (defaulting to 2.0 if not defined)

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

  • rlay :: [out] Layer potential density [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave

Called from

mom_initialize_coord

subroutine mom_coord_initialization/set_coord_to_none(Rlay, g_prime, GV, US, param_file)

Sets Rlay to Rho0 and g_prime to zero except for the free surface. This is for use only in ALE mode where Rlay should not be used and g_prime(1) alone might be used.

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

  • rlay :: [out] Layer potential density [R ~> kg m-3].

  • g_prime :: [out] The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].

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

  • param_file :: [in] A structure to parse for run-time parameters

Call to

mom_error_handler::calltree_enter mom_error_handler::calltree_leave

Called from

mom_initialize_coord

subroutine mom_coord_initialization/write_vertgrid_file(GV, US, param_file, directory)

Writes out a file containing any available data related to the vertical grid used by the MOM ocean model.

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

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

  • param_file :: [in] A structure to parse for run-time parameters

  • directory :: [in] The directory into which to place the file.

Called from

mom_initialize_coord