soliton_initialization module reference

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

Functions/Subroutines

`soliton_initialize_thickness()`	Initialization of thicknesses in equatorial Rossby soliton test, as described in section 6.1 of Haidvogel and Beckman (1990) and in Boyd (1980, JPO) and Boyd (1985, JPO).
`soliton_initialize_velocity()`	Initialization of u and v in the equatorial Rossby soliton test, as described in section 6.1 of Haidvogel and Beckman (1990) and in Boyd (1980, JPO) and Boyd (1985, JPO).

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, param_file, just_read)

Initialization of thicknesses in equatorial Rossby soliton test, as described in section 6.1 of Haidvogel and Beckman (1990) and in Boyd (1980, JPO) and Boyd (1985, JPO).

Parameters:

g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
h :: h [out] The thickness that is being initialized [Z ~> m]
depth_tot :: depth_tot [in] The nominal total depth of the ocean [Z ~> m]
param_file :: param_file [in] A structure indicating the open file to parse for model parameter values.
just_read :: 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

Called from:

mom_state_initialization::mom_initialize_state

[source]

subroutine soliton_initialization/soliton_initialize_velocity(u, v, G, GV, US, param_file, just_read)

Initialization of u and v in the equatorial Rossby soliton test, as described in section 6.1 of Haidvogel and Beckman (1990) and in Boyd (1980, JPO) and Boyd (1985, JPO).

Parameters:

g :: [in] Grid structure
gv :: [in] The ocean’s vertical grid structure
u :: u [out] i-component of velocity [L T-1 ~> m s-1]
v :: v [out] j-component of velocity [L T-1 ~> m s-1]
us :: [in] A dimensional unit scaling type
param_file :: param_file [in] A structure indicating the open file to parse for model parameter values.
just_read :: 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

[source]