PUBLIC INTERFACE ~ PUBLIC ROUTINES

Module ocean_residency_ml_mod

Contact:  Richard D. Slater
Reviewers:  Stephen M. Griffies
Change History: WebCVS Log

OVERVIEW

Ocean age tracer module

This module handles the case where the specified region is determined by a 2-d array of depths, typically mixed layer depths. To use this module, in the field table namelist, you must do the following: 1) set "module_name" to "ocean_residency_ml" 2) "strings" should have one value: one of "kpp_bl", "mld_buoyancy", or "mld_potrho" 3) no "params" should be set 4) no "flags" should be set Currently, the following mixed layers are supported: kpp_bl: KPP mixed layer mld_buoyancy: mixed layer defined by a change in buoyancy (mld in diagnostic output) mld_potrho: mixed layer defined by a change in potential density (depth_of_potrho in diagnostic output) There should be no "params" or "flags" set, and only one element of "strings". For an overview of the ocean residency modules, see ocean_residency.F90.

OTHER MODULES USED

       field_manager_mod
                 mpp_mod
ocean_residency_meta_mod
         ocean_types_mod
   ocean_tracer_diag_mod

PUBLIC INTERFACE

ocean_residency_ml_source:
ocean_residency_ml_start:

PUBLIC ROUTINES

  1. ocean_residency_ml_source

    DESCRIPTION
    Calculate the mask for the mixed layer. Arguments: Input: isd: low dimension of first index ied: high dimension of first index jsd: low dimension of second index jed: high dimension of second index nk: dimension of third index T_prog: array of ocean prognostic types T_diag: array of ocean diagnostic types Time: ocean time type Thickness: ocean thickness type Dens: ocean density type depth_zwt: depth of bottom of grid cell hblt_depth: array of depths of KPP boundary layer


  2. ocean_residency_ml_start

    DESCRIPTION
    Start the ocean residency mixed layer package


top