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

Module ozone_mod

Contact:  fil
Reviewers:  ds
Change History: WebCVS Log

OVERVIEW

This code supplies mass mixing ratios of ozone (g/g) to the sea_esf_rad radiation_package (and the original_fms_rad package).

This code supplies mass mixing ratios of ozone (g/g) to the sea_esf_rad radiation_package (and the original_fms_rad package). Recent changes allow provision for predicted ozone to be considered. This is a field passed in the tracer array, r

OTHER MODULES USED

           fms_mod
        fms_io_mod
  time_manager_mod
  diag_manager_mod
   time_interp_mod
     constants_mod
  interpolator_mod
tracer_manager_mod
 field_manager_mod
 rad_utilities_mod

PUBLIC INTERFACE

ozone_init:
ozone_init is the constructor for ozone_mod.
ozone_driver:
ozone_driver obtains the current ozone distributions and returns them in Rad_gases%qo3.
ozone_end:
ozone_end is the destructor for ozone_mod.
obtain_input_file_data:
obtain_input_file_data reads an input file containing a single column ozone profile.
obtain_gfdl_zonal_ozone_data:
obtain_gfdl_zonal_ozone_data generates data at the appropriate time from the basic fms_zonal_ozone input data set, allowing the use of annual mean, fixed seasonal, or seasonally-varying ozone distrib- utions.
obtain_clim_zonal_ozone_data:
obtain_clim_zonal_ozone_data provides the necessary information to interpolator_mod so that the appropriate clim_ozone data may be obtained later on when needed.
geto3_3d:
geto3_3d retrieves an (i,j,k) array of ozone mass mixing ratio (g / g ) valid at the specified time to be returned to the calling routine.
geto3_2d:
geto3_2d retrieves an (i,k) array of ozone mass mixing ratio (g / g ) valid at the specified time to be returned to the calling routine.
get_clim_ozone:
get_clim_ozone retrieves the clim_ozone field at the desired place and time from the o3.climatology.nc file by accessing interpolator_mod.

PUBLIC DATA

None.

PUBLIC ROUTINES

  1. ozone_init

    call ozone_init (latb, lonb)
    DESCRIPTION
    ozone_init is the constructor for ozone_mod.


    INPUT
    latb    array of model latitudes at cell boundaries [radians]
       [real]
    lonb    array of model longitudes at cell boundaries [radians]
       [real]

  2. ozone_driver

    call ozone_driver (is, ie, js, je, lat, Rad_time, Atmos_input, & Rad_gases )
    DESCRIPTION
    ozone_driver obtains the current ozone distributions and returns them in Rad_gases%qo3.


    INPUT
    is,ie,js,je    starting/ending subdomain i,j indices of data in the physics_window being integrated
       [integer]
    lat    latitude of model points [ radians ]
       [real]
    Rad_time    time at which the climatologically-determined, time-varying ozone field should apply
       [time_type]
    Atmos_input    atmos_input_type variable containing the atmospheric input fields needed by the radiation package
       [atmos_input_type]

    INPUT/OUTPUT
    Rad_gases    radiative_gases_type variable which will return the ozone mass mixing ratio (g/g) to the calling routine
       [radiative_gases_type]

  3. ozone_end

    call ozone_end
    DESCRIPTION
    ozone_end is the destructor for ozone_mod.


  4. obtain_input_file_data

    call obtain_input_file_data
    DESCRIPTION
    obtain_input_file_data reads an input file containing a single column ozone profile.


  5. obtain_gfdl_zonal_ozone_data

    call obtain_gfdl_zonal_ozone_data (season)
    DESCRIPTION
    obtain_gfdl_zonal_ozone_data generates data at the appropriate time from the basic fms_zonal_ozone input data set, allowing the use of annual mean, fixed seasonal, or seasonally-varying ozone distrib- utions.


    INPUT
    season    scalar integer between 0-5, where 1-4 uses fixed data (1=winter, 2=spring, etc.), season=0 is annual mean ozone, and season=5 is seasonally varying ozone
       [integer]

  6. obtain_clim_zonal_ozone_data

    call obtain_clim_zonal_ozone_data (lonb, latb)
    DESCRIPTION
    obtain_clim_zonal_ozone_data provides the necessary information to interpolator_mod so that the appropriate clim_ozone data may be obtained later on when needed.


    INPUT
    lonb, latb    lonb array of model longitudes at cell boundaries [radians] latb array of model latitudes at cell boundaries [radians]
       [real]

  7. geto3_3d

    call geto3_3d (Time, lat, phalf, ozone)
    DESCRIPTION
    geto3_3d retrieves an (i,j,k) array of ozone mass mixing ratio (g / g ) valid at the specified time to be returned to the calling routine.


    INPUT
    Time    current model time [ time_type (days, seconds) ]
       [time_type]
    lat    latitude of model points [ radians ]
       [real]
    phalf    pressure at model layer interfaces [ kg / (m s^2) ]
       [real]

    OUTPUT
    ozone    ozone mass mixing ratio at model levels [ g / g ]
       [real]

  8. geto3_2d

    call geto3_2d (Time, lat, phalf, ozone)
    DESCRIPTION
    geto3_2d retrieves an (i,k) array of ozone mass mixing ratio (g / g ) valid at the specified time to be returned to the calling routine.


    INPUT
    Time    current model time [ time_type (days, seconds) ]
       [time_type]
    lat    latitude of model points [ radians ]
       [real]
    phalf    pressure at model layer interfaces [ kg / (m s^2) ]
       [real]

    OUTPUT
    ozone    ozone mass mixing ratio at model levels [ g / g ]
       [real]

  9. get_clim_ozone

    call get_clim_ozone (is, js, model_time, p_half, model_data)
    DESCRIPTION
    get_clim_ozone retrieves the clim_ozone field at the desired place and time from the o3.climatology.nc file by accessing interpolator_mod.


    INPUT
    model_time    time at which the climatologically-determined, time-varying ozone field should apply
       [time_type]
    p_half    pressure at model layer interfaces [ kg / (m s^2) ]
       [real]
    is, js    OPTIONAL: starting subdomain i,j indices of data in the physics_window being integrated
       [integer]

    OUTPUT
    model_data    output field containing ozone field at desired time
       [real]

DATA SETS

None.

ERROR MESSAGES

None.

top