namespace mom_regularize_layers

Overview

Provides regularization of layers in isopycnal mode. More…

namespace mom_regularize_layers {

// global variables

integer id_clock_pass;

// global functions

subroutine, public regularize_layers(h h, tv tv, dt dt, ea ea, eb eb, G G, GV GV, CS CS);

subroutine, public regularize_layers_init(
    Time Time,
    G G,
    GV GV,
    param_file param_file,
    diag diag,
    CS CS
    );

} // namespace mom_regularize_layers

Detailed Documentation

Provides regularization of layers in isopycnal mode.

Global Variables

integer id_clock_pass

Clock IDs.

Global Functions

subroutine, public regularize_layers(
    h h,
    tv tv,
    dt dt,
    ea ea,
    eb eb,
    G G,
    GV GV,
    CS CS
    )

This subroutine partially steps the bulk mixed layer model. The following processes are executed, in the order listed.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
h	Layer thicknesses [H ~> m or kg m-2].
tv	A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs.
dt	Time increment [s].
ea	The amount of fluid moved downward into a
eb	The amount of fluid moved upward into a layer
cs	The control structure returned by a previous call to regularize_layers_init.

subroutine, public regularize_layers_init(
    Time Time,
    G G,
    GV GV,
    param_file param_file,
    diag diag,
    CS CS
    )

Initializes the regularize_layers control structure.

Parameters:

time	The current model time.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
param_file	A structure to parse for run-time parameters.
diag	A structure that is used to regulate diagnostic output.
cs	A pointer that is set to point to the control structure for this module.