mom_continuity module reference

Solve the layer continuity equation.

More…

Data Types

continuity_cs

Control structure for mom_continuity().

Functions/Subroutines

continuity()

Time steps the layer thicknesses, using a monotonically limited, directionally split PPM scheme, based on Lin (1994).

continuity_init()

Initializes continuity_cs().

continuity_stencil()

continuity_stencil returns the continuity solver stencil size

Detailed Description

Solve the layer continuity equation.

Type Documentation

type mom_continuity/continuity_cs

Control structure for mom_continuity(). .

Type fields:

  • % continuity_scheme [integer] :: Selects the discretization for the continuity solver. Valid values are:

  • % ppm [type( continuity_ppm_cs )] :: Control structure for

Function/Subroutine Documentation

subroutine mom_continuity/continuity(u, v, hin, h, uh, vh, dt, G, GV, US, CS, OBC, pbv, uhbt, vhbt, visc_rem_u, visc_rem_v, u_cor, v_cor, BT_cont)

Time steps the layer thicknesses, using a monotonically limited, directionally split PPM scheme, based on Lin (1994).

Parameters:

  • g :: [inout] Ocean grid structure.

  • gv :: [in] Vertical grid structure.

  • u :: [in] Zonal velocity [L T-1 ~> m s-1].

  • v :: [in] Meridional velocity [L T-1 ~> m s-1].

  • hin :: [in] Initial layer thickness [H ~> m or kg m-2].

  • h :: [inout] Final layer thickness [H ~> m or kg m-2].

  • uh :: [out] Volume flux through zonal faces =

  • vh :: [out] Volume flux through meridional faces =

  • dt :: [in] Time increment [T ~> s].

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

  • cs :: [in] Control structure for mom_continuity(). .

  • obc :: Open boundaries control structure.

  • pbv :: [in] porous barrier fractional cell metrics

  • uhbt :: [in] The vertically summed volume

  • vhbt :: [in] The vertically summed volume

  • visc_rem_u :: [in] Both the fraction of

  • visc_rem_v :: [in] Both the fraction of

  • u_cor :: [out] The zonal velocities that

  • v_cor :: [out] The meridional velocities that

  • bt_cont :: A structure with elements

Call to:

mom_error_handler::mom_error ppm_scheme

Called from:

mom_dynamics_unsplit::step_mom_dyn_unsplit mom_dynamics_unsplit_rk2::step_mom_dyn_unsplit_rk2

subroutine mom_continuity/continuity_init(Time, G, GV, US, param_file, diag, CS)

Initializes continuity_cs(). .

Parameters:

  • time :: [in] Current model time.

  • g :: [in] Ocean grid structure.

  • gv :: [in] Vertical grid structure.

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

  • param_file :: [in] Parameter file handles.

  • diag :: [inout] Diagnostics control structure.

  • cs :: [inout] Control structure for mom_continuity(). .

Call to:

mom_error_handler::mom_error mom_error_handler::mom_mesg ppm_scheme ppm_string mom_string_functions::uppercase

Called from:

mom_dynamics_split_rk2::initialize_dyn_split_rk2 mom_dynamics_unsplit::initialize_dyn_unsplit mom_dynamics_unsplit_rk2::initialize_dyn_unsplit_rk2

function mom_continuity/continuity_stencil(CS) [integer]

continuity_stencil returns the continuity solver stencil size

Parameters:

cs :: [in] Module’s control structure.

Return:

undefined :: The continuity solver stencil size with the current settings.

Call to:

ppm_scheme

Called from:

mom_dynamics_split_rk2::initialize_dyn_split_rk2 mom_dynamics_unsplit::initialize_dyn_unsplit mom_dynamics_unsplit_rk2::initialize_dyn_unsplit_rk2 mom_dynamics_split_rk2::step_mom_dyn_split_rk2