PUBLIC INTERFACE ~ PUBLIC ROUTINES

Module ocmip2_he_mod

Contact:  Jennifer Simeon
Reviewers:  Eric Galbraith ,  Daniele Bianchi
Change History: WebCVS Log

OVERVIEW

Ocean Carbon Model Intercomparison Study II: HE module

Implementation of routines to solve the OCMIP-2 HE simulations as outlined in the Helium-HOWTO documentation, revision 1.6, 1999/04/29. Modified Jan 2008 b1d. Separated atmospheric and mantle component and added a factor to chance the source strength

OTHER MODULES USED

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

PUBLIC INTERFACE

allocate_arrays:
ocmip2_he_bbc:
ocmip2_he_end:
ocmip2_he_restart:
ocmip2_he_sbc:
ocmip2_he_flux_init:
ocmip2_he_init:
ocmip2_he_init_sfc:
ocmip2_he_sum_sfc:
ocmip2_he_zero_sfc:
ocmip2_he_avg_sfc:
ocmip2_he_sfc_end:
ocmip2_he_source:
ocmip2_he_start:
ocmip2_he_tracer:

PUBLIC ROUTINES

  1. allocate_arrays

    DESCRIPTION
    Dynamically allocate arrays


  2. ocmip2_he_bbc

    DESCRIPTION
    Called each time-step calculate the bottom boundary conditions


  3. ocmip2_he_end

    DESCRIPTION
    Called once at the end of the run Clean up various HE quantities for this run.


  4. ocmip2_he_restart

    DESCRIPTION
    Write out restart files registered through register_restart_file


  5. ocmip2_he_sbc

    DESCRIPTION
    Called each time-step Calculate the surface boundary conditions


  6. ocmip2_he_flux_init

    DESCRIPTION
    Called once at the beginning of the run Set up any extra fields needed by the ocean-atmosphere gas fluxes


  7. ocmip2_he_init

    DESCRIPTION
    Called once at the beginning of the run Set up any extra fields needed by the tracer packages Save pointers to various "types", such as Grid and Domains.


  8. ocmip2_he_init_sfc

    DESCRIPTION
    Called once at the beginning of the run Initialize surface fields for flux calculations


  9. ocmip2_he_sum_sfc

    DESCRIPTION
    Called for FMS coupler ocean_tpm_sum_sfc: Accumulate data for the coupler Sum surface fields for flux calculations


  10. ocmip2_he_zero_sfc

    DESCRIPTION
    Zero out the fields for the coupler to allow for accumulation for the next time period


  11. ocmip2_he_avg_sfc

    DESCRIPTION
    Called for FMS coupler ocean_tpm_avg_sfc: Take the time-mean of the fields for the coupler Sum surface fields for flux calculations


  12. ocmip2_he_sfc_end

    DESCRIPTION
    Called for FMS coupler ocean_tpm_sfc_end: Save out fields for the restart.


  13. ocmip2_he_source

    DESCRIPTION
    compute the source terms for the HEs, including boundary conditions (not done in setvbc, to minimize number of hooks required in MOM base code) As described by J-C Dutay et al.'s Helium HOWTO. Mantle Helium has a source due to emission of helium rich waters along ocean ridges on the seafloor. Globally integrated, the source term amounts to 1000 moles of He-3 per year. Regionally, sources are partitioned as a function of ridge position, length and spreading rate. A loss term exists in the air-sea flux of mantle helium. The loss term is calculated in the subroutine ocmip2_he_sbc.


  14. ocmip2_he_start

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


  15. ocmip2_he_tracer

    DESCRIPTION
    Perform things that should be done in tracer, but are done here in order to minimize the number of hooks necessary in the MOM4 basecode


REFERENCES

  1. http://www.ipsl.jussieu.fr/OCMIP/phase2/simulations/Helium/HOWTO-Helium.html

top