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

Module rad_output_file_mod

Contact:  fil
Reviewers:  ds
Change History: WebCVS Log


OVERVIEW

Module that provides subroutines to write radiation output to history file



OTHER MODULES USED

             fms_mod
time_manager_mod
diag_manager_mod
constants_mod
rad_utilities_mod
esfsw_parameters_mod

PUBLIC INTERFACE

rad_output_file_init:
Constructor of rad_output_file module
write_rad_output_file:
write_rad_output_file produces a netcdf output file containing the user-specified radiation-related variables.
rad_output_file_end:
rad_output_file_end is the destructor for rad_output_file_mod
register_fields:
register_fields send the relevant information concerning the user-desired output fields to diag_manager_mod.


PUBLIC DATA

None.


PUBLIC ROUTINES

  1. rad_output_file_init

    call rad_output_file_init (axes, Time, names)
    DESCRIPTION
    Subroutine to initialize and set up rad_output_file module


    INPUT
    axes    diagnostic variable axes for netcdf files
       [integer]
    Time    current time [ time_type(days, seconds) ]
       [time_type]
    names    aerosol names
       [character]

  2. write_rad_output_file

    call write_rad_output_file (is, ie, js, je, Atmos_input, Surface, & Rad_output, & Sw_output, Lw_output, Rad_gases, & Cldrad_props, Cld_spec, & Time_diag, aerosol_in)
    DESCRIPTION
    write_rad_output_file produces a netcdf output file containing the user-specified radiation-related variables.


    INPUT
    is, ie, js, je    starting/ending subdomain i,j indices of data in the physics_window being integrated
       [integer]
    Atmos_input    atmos_input_type variable containing atmos- pheric input data for the radiation package on the model grid
       [atmos_input_type]
    Surface    Surface input data to radiation package
       [surface_type]
    Rad_output    rad_output_type variable containing radiation output data needed by other modules
       [rad_output_type]
    Sw_output    sw_output_type variable containing shortwave radiation output data from the sea_esf_rad radiation package on the model grid
       [sw_output_type]
    Lw_output    lw_output_type variable containing longwave radiation output data from the sea_esf_rad radiation package on the model grid
       [lw_output_type]
    Rad_gases    radiative_gases_type variable containing rad- iative gas input data for the radiation package on the model grid
       [radiative_gases_type]
    Cldrad_pros    cldrad_properties_type variable containing cloud radiative property input data for the radiation package on the model grid
       [cldrad_properties_type]
    Cld_spec    cld_specification_type variable containing cloud microphysical data
       [cld_diagnostics_type]
    Time_diag    time on next timestep, used as stamp for diag- nostic output [ time_type (days, seconds) ]
       [time_type]
    aerosol_in    optional aerosol data
       [real]

  3. rad_output_file_end

    call rad_output_file_end 
    
    DESCRIPTION
    rad_output_file_end is the destructor for rad_output_file_mod


  4. register_fields

    call register_fields (Time, axes, nfilds, names)
    DESCRIPTION
    register_fields send the relevant information concerning the user-desired output fields to diag_manager_mod.


    INPUT
    Time    current time [ time_type(days, seconds) ]
       [time_type]
    axes    diagnostic variable axes for netcdf files
       [integer]
    nfields    number of aerosol fields
       [integer]
    names    names of aerosol fields
       [character]


DATA SETS

None.


ERROR MESSAGES

None.


top