Module ocean_residency_range_mod
OVERVIEW
Ocean age tracer module
This module handles the case where the specified region is determined
from a range of another tracer. Any tracer, either prognostic or
diagnostic, may be used. The tracer field, mutiplied by an optional
scaling factor, will be multiplied by the current value in residency
mask array.
To use this module, in the field table namelist, you must do the following:
1) set "module_name" to "ocean_residency_range"
2) "strings" should have two values, the first is "tracer_range", and the
second to the name of a prognostic or diagnostic variable
3) set "params" to pairs of points defining the range of the variable
to select. For each pair of values, the first value must be less than
the second value. The grid cells will satisfy the union of all of the
grid cells which satisfy
"low value" < "cell value" <= "high value"
for at least one pair of points
4) no "flags" should be set
Any prognostic or diagnostic variable may be used. If you wish to allow
another variable to be used, you can just create a diagnostic variable
for it.
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
PUBLIC INTERFACE
PUBLIC DATA
None.
PUBLIC ROUTINES
-
ocean_residency_range_source
-
DESCRIPTION
- Calculate the mask for the tracer range(s)
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
taum1: tau-1 time level index
T_prog: array of ocean prognostic types
T_diag: array of ocean diagnostic types
grid_kmt: indices of the bottom grid cell
-
ocean_residency_range_start
-
DESCRIPTION
- Start the ocean residency tracer range package
DATA SETS
None.
ERROR MESSAGES
None.