PUBLIC INTERFACE ~ PUBLIC DATA ~ PUBLIC ROUTINES ~ NAMELIST ~ DIAGNOSTIC FIELDS ~ ERROR MESSAGES ~ REFERENCES ~ NOTES

Module ocean_residency_integrand_mod

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

OVERVIEW

Ocean age tracer module

This module contains the subroutines to set up fields other than reciprocal time over which to integrate.

To use this module, in the field table namelist, you must do the following:

1) set "module_name_int" to "ocean_residency_integrand" 2) "int_strings" should have one or two values, the first is the name of a prognostic or diagnostic variable to use as the integrand, and if the second value is given and is "average", then the array is assumed to be defined at the top of the grid cells, and the average of the top and bottom will be used for each grid cell (top of bottommost grid cell), otherwise the value at each level will be used 3) "int_params" may be set to a single value to scale the integrand, at most one value may be set 4) no "int_flags" should be set

For an overview of the ocean residency modules, see ocean_residency.F90.


OTHER MODULES USED

       field_manager_mod
                 mpp_mod
                 fms_mod
ocean_residency_meta_mod
         ocean_types_mod

PUBLIC INTERFACE

ocean_residency_integrand_source:
ocean_residency_integrand_start:

PUBLIC DATA

None.

PUBLIC ROUTINES

  1. ocean_residency_integrand_source

    DESCRIPTION
    Set the selected integrand field to be used in the "integrate_region" as defined in ocean_residency.F90. The selected prognostic or diagnostic variable will be multiplied by the residency mask (which is usually either 1 or 0, but is not so required) and a user-selected scale factor (default of 1). The variable may be either the average of the surrounding points ( C(k) = (C(k) + C(k+1))/2 ) or just the same indexical value.


  2. ocean_residency_integrand_start

    DESCRIPTION
    Start the ocean residency integrand package



DATA SETS

None.

ERROR MESSAGES

None.

top