Module ocean_tracer_util_mod

OVERVIEW

This module contains many routines of use for tracer diagnostics in mom4.

OTHER MODULES USED

             mpp_mod
        platform_mod
   ocean_domains_mod
ocean_parameters_mod
     ocean_types_mod
      ocean_util_mod
 ocean_workspace_mod

PUBLIC INTERFACE

PUBLIC DATA

PUBLIC ROUTINES

1. ocean_tracer_util_init

   DESCRIPTION

   Initialize mom4 tracer utilities.

   
   
   

2. tracer_min_max

   DESCRIPTION

   Compute the global min and max for tracers.
   
   Vectorized using maxloc() and minloc() intrinsic functions by Russell.Fiedler@csiro.au (May 2005).
   
   Modified by Zhi.Liang@noaa.gov (July 2005)
   
   

   
   
   

3. dzt_min_max

   DESCRIPTION

   Compute the global min and max for dzt.
   
   Modified by Stephen.Griffies@noaa.gov from subroutine tracer_min_max
   
   

   
   
   

4. tracer_prog_chksum

   DESCRIPTION

   Compute checksums for prognostic tracers

   
   
   

5. tracer_diag_chksum

   DESCRIPTION

   Compute checksums for diagnostic tracers

   
   
   

6. tracer_psom_chksum

   DESCRIPTION

   Compute checksums for PSOM advection second order moments.

   
   
   

7. sort_pick_array

   DESCRIPTION

   Simplest, and slowest, sorting algorithm from Numerical Recipes. Called "sort_pick" in Numerical Recipes.
   
   Input are two arrays, first array defines the ascending sort and second is a slave to the sort.
   
   Typical example is sorting a vector of water parcels lightest to densest, with slave being volume of the parcels.
   
   More sophisticated sorting algorithms exist, and may need to be coded should this method prove too slow.
   
   This scheme has order N^2 operations, which is a lot.
   
   output has array(1) smallest and a(nsortpts) largest with corresponding slave array.
   
   coded Stephen.Griffies@noaa.gov June 2005
   
   

   
   
   

8. sort_shell_array

   DESCRIPTION

   Shell (or diminishing increment) sort from Numerical Recipes. Called "sort_shell" in Numerical Recipes.
   
   Input are two arrays, first array defines the ascending sort and second is a slave to the sort array.
   
   Typical example is sorting a vector of water parcels lightest to densest, with slave being volume of the parcels.
   
   More sophisticated sorting algorithms exist, and may need to be coded should this method prove too slow.
   
   This scheme has order N^(5/4) operations.
   
   output has array(1) smallest and a(nsortpts) largest, with corresponding ordering for slave array.
   
   coded Stephen.Griffies@noaa.gov June 2005
   
   

   
   
   

DATA SETS

ERROR MESSAGES