soliton_initialization module reference

Initial conditions for the Equatorial Rossby soliton test (Boyd).

More…

Functions/Subroutines

soliton_initialize_thickness()

Initialization of thicknesses in Equatorial Rossby soliton test.

soliton_initialize_velocity()

Initialization of u and v in the equatorial Rossby soliton test.

Detailed Description

Description of the equatorial Rossby soliton initial

conditions

Function/Subroutine Documentation

subroutine soliton_initialization/soliton_initialize_thickness(h, depth_tot, G, GV, US)

Initialization of thicknesses in Equatorial Rossby soliton test.

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]

Call to

mom_error_handler::mom_mesg

Called from

mom_state_initialization::mom_initialize_state

subroutine soliton_initialization/soliton_initialize_velocity(u, v, h, G, GV, US)

Initialization of u and v in the equatorial Rossby soliton test.

Parameters
  • g :: [in] Grid structure

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

  • u :: [out] i-component of velocity [L T-1 ~> m s-1]

  • v :: [out] j-component of velocity [L T-1 ~> m s-1]

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

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