PUBLIC INTERFACE ~ PUBLIC ROUTINES

Module generic_CFC

Contact:  Niki Zadeh
Reviewers:  William Cooke
Change History: WebCVS Log

OVERVIEW

Ocean Carbon Model Intercomparison Study II: CFC module This module contains the generic version of CFC Tracers and their chemistry. It is designed so that both GFDL Ocean models, GOLD and MOM, can use it. The chemistry calculations in this module are ported from MOM ocmip2_cfc.F90 released in omsk_2008_03

Implementation of routines to solve the OCMIP-2 CFC simulations as outlined in the CFC-HOWTO documentation, revision 1.6, 1999/04/29.

OTHER MODULES USED

coupler_types_mod
field_manager_mod
          mpp_mod
 time_manager_mod
      fm_util_mod
   g_tracer_utils

PUBLIC INTERFACE

generic_CFC_init:
Initialize the generic CFC module
generic_CFC_update_from_coupler:
Modify the values obtained from the coupler if necessary.
generic_CFC_update_from_source:
Update tracer concentration fields due to the source/sink contributions.
generic_CFC_set_boundary_values:
Calculate and set coupler values at the surface / bottom
generic_CFC_end:
End the module.

PUBLIC ROUTINES

  1. generic_CFC_init

    call generic_CFC_init (tracer_list)
    DESCRIPTION
    This subroutine: Adds all the CFC Tracers to the list of generic Tracers passed to it via utility subroutine g_tracer_add(). Adds all the parameters used by this module via utility subroutine g_tracer_add_param(). Allocates all work arrays used in the module.


    INPUT
    tracer_list    Pointer to the head of generic tracer list.
       [type(g_tracer_type), pointer]

  2. generic_CFC_update_from_coupler

    call generic_CFC_update_from_coupler (tracer_list)
    DESCRIPTION
    Currently an empty stub for CFCs. Some tracer fields need to be modified after values are obtained from the coupler. This subroutine is the place for specific tracer manipulations.


    INPUT
    tracer_list    Pointer to the head of generic tracer list.
       [type(g_tracer_type), pointer]

  3. generic_CFC_update_from_source

    DESCRIPTION
    Currently an empty stub for CFCs.


  4. generic_CFC_set_boundary_values

    call generic_CFC_set_boundary_values (tracer_list,SST,SSS,rho,ilb,jlb,tau)
    DESCRIPTION


    INPUT
    tracer_list    Pointer to the head of generic tracer list.
       [type(g_tracer_type), pointer]
    ilb,jlb    Lower bounds of x and y extents of input arrays on data domain
       [integer]
    SST    Sea Surface Temperature
       [real, dimension(ilb:,jlb:)]
    SSS    Sea Surface Salinity
       [real, dimension(ilb:,jlb:)]
    rho    Ocean density
       [real, dimension(ilb:,jlb:,:,:)]
    tau    Time step index of %field
       [integer]

  5. generic_CFC_end

    call generic_CFC_end
    DESCRIPTION
    Deallocate all work arrays


REFERENCES

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

top