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

Module ocmip2_biotic_mod

Contact:  Richard D. Slater
Reviewers:  John P. Dunne
Change History: WebCVS Log

OVERVIEW

Ocean Carbon Model Intercomparison Study II: Biotic module

Implementation of routines to solve the OCMIP-2 Biotic simulations as outlined in the Biotic-HOWTO documentation, revision 1.7, 1999/10/05.

OTHER MODULES USED

        time_manager_mod
        diag_manager_mod
       field_manager_mod
                 fms_mod
              fms_io_mod
                 mpp_mod
time_interp_external_mod
         mpp_domains_mod
           constants_mod
      ocean_tpm_util_mod
             fm_util_mod
       coupler_types_mod
         ocean_types_mod
      ocmip2_co2calc_mod
  atmos_ocean_fluxes_mod

PUBLIC INTERFACE

allocate_arrays:
locate:
ocmip2_biotic_bbc:
ocmip2_biotic_end:
ocmip2_biotic_restart:
ocmip2_biotic_sbc:
ocmip2_biotic_flux_init:
ocmip2_biotic_init:
ocmip2_biotic_init_sfc:
ocmip2_biotic_sum_sfc:
ocmip2_biotic_zero_sfc:
ocmip2_biotic_avg_sfc:
ocmip2_biotic_sfc_end:
ocmip2_biotic_source:
ocmip2_biotic_start:
set_array:

PUBLIC DATA

None.

PUBLIC ROUTINES

  1. allocate_arrays

    DESCRIPTION
    Dynamically allocate arrays


  2. locate

    DESCRIPTION
    After Numerical recipes:

    Given an array XX of length N, and a given value of X, returns a value of J such that X is between XX(J) and XX(J+1). XX must be monotonic, either increasing or decreasing. J=0 or J=N is returned to indicate that X is out of range. New features:

    If "period" is specified, then the array, xx, is considered to be periodic with a period of "period". If "x_in" is out of range, then add or subtract "period" once to attempt to make "x_in" be in range.

    If "nearest" is specified, and true, then return "j" such that it is the element of "xx" which is nearest to the value of "x_in" (where "x_in" may have been modified by the value "period", above). With this option, "j" will be in the range 1 <= j <= n.


  3. ocmip2_biotic_bbc

    DESCRIPTION
    calculate the surface boundary conditions


  4. ocmip2_biotic_end

    DESCRIPTION
    Clean up various BIOTIC quantities for this run.


  5. ocmip2_biotic_restart

    DESCRIPTION
    Write out restart files registered through register_restart_file


  6. ocmip2_biotic_sbc

    DESCRIPTION
    Calculate the surface boundary conditions


  7. ocmip2_biotic_flux_init

    DESCRIPTION
    Set up any extra fields needed by the ocean-atmosphere gas fluxes


  8. ocmip2_biotic_init

    DESCRIPTION
    Set up any extra fields needed by the tracer packages

    Save pointers to various "types", such as Grid and Domains.


  9. ocmip2_biotic_init_sfc

    DESCRIPTION
    Initialize surface fields for flux calculations

    Note: this subroutine should be merged into ocmip2_biotic_start


  10. ocmip2_biotic_sum_sfc

    DESCRIPTION
    Sum surface fields for flux calculations


  11. ocmip2_biotic_zero_sfc

    DESCRIPTION
    Sum surface fields for flux calculations


  12. ocmip2_biotic_avg_sfc

    DESCRIPTION
    Sum surface fields for flux calculations


  13. ocmip2_biotic_sfc_end

    DESCRIPTION
    Initialize surface fields for flux calculations


  14. ocmip2_biotic_source

    DESCRIPTION
    compute the source terms for the BIOTICs, including boundary conditions (not done in setvbc, to minimize number of hooks required in MOM base code)


  15. ocmip2_biotic_start

    DESCRIPTION
    Initialize variables, read in namelists, calculate constants for a given run and allocate diagnostic arrays


  16. set_array

    DESCRIPTION
    Set up an array covering the model domain with a user-specified value, in user-specified regions. There are a given number of 2-d regions specified by the values slat, nlat, wlon and elon. The longitudes are for a cyclic domain, and if wlon and elon are on opposite sides of the cut, the correct thing will be done. Elon is considered to be east of wlon, so if elon is less than wlon, then the region east of elon to the cut will be filled, and the region from the cut to wlon will be filled.

    After setting up the array in this routine, it may prove useful to allow fine-tuning the settings via an array in a namelist.

    Arguments: Input: num_regions = number of user-specified regions which will be filled

    wlon = 1-d array of western (starting) longitudes for the rectangular regions

    elon = 1-d array of eastern (ending) longitudes for the rectangular regions

    slat = 1-d array of southern (starting) latitudes for the rectangular regions

    nlat = 1-d array of northern (ending) latitudes for the rectangular regions

    Note: if slat >= nlat, then nothing is done for that region

    set_value = the value to assign to array in the user-specified regions

    unset_value = the value to assign to array outside of the user-specified regions

    name = character variable used in informative messages

    coastal_only = true to limit changes only to coastal points (i.e., at least one bordering point is land)

    Output:

    array = 2-d array which will contain the set- and unset- values. The array is assumed to have a border one unit wide on all edges, ala MOM. A cyclic boundary condition will be set if requested.


DATA SETS

None.

ERROR MESSAGES

None.

REFERENCES

  1. http://www.ipsl.jussieu.fr/OCMIP/phase2/simulations/Biotic/HOWTO-Biotic.html
  2. Press, W. H., S. A. Teukosky, W. T. Vetterling, B. P. Flannery, 1992. Numerical Recipes in FORTRAN, Second Edition, Cambridge University Press.
  3. Enting, I.G., T. M. L. Wigley, M. Heimann, 1994. Future Emissions and concentrations of carbon dioxide: key ocean / atmosphere / land analyses, CSIRO Aust. Div. Atmos. Res. Tech. Pap. No. 31, 118 pp.

COMPILER SPECIFICS

None.

PRECOMPILER OPTIONS

None.

LOADER OPTIONS

None.

TEST PROGRAM

None.

KNOWN BUGS

None.

NOTES

None.

FUTURE PLANS

None.

top