PUBLIC INTERFACE ~ PUBLIC ROUTINES ~ NAMELIST

Module vgrid_mod

Contact: Z. Liang
Reviewers: S. M. Griffies
Change History: WebCVS Log

OVERVIEW

vgrid_mod Generate vertical grid.

The grid file contains the following information, 
       zt = depth of tracer points
       zb = depth of tracer_boundaries

              +---------------+
              |               |
              |               |
              |               |
              |               |
              |      +zt_k    |
              |               |
              |               |
              |               |
              +------+zb_k----+

OTHER MODULES USED

       mpp_mod
    mpp_io_mod
       fms_mod
grids_type_mod
grids_util_mod
 constants_mod

PUBLIC INTERFACE

vgrid_init:
Initialization routine.
generate_vgrid:
Generate vertical grid.
write_vgrid_data:
write the vertical grid data to netcdf file
write_vgrid_meta:
Write out vertical grid meta data.
vgrid_end:
Destruction routine.

PUBLIC ROUTINES

  1. vgrid_init

    call vgrid_init ( )
    DESCRIPTION
    Read namelist, write out version and namelist informaiton and generate depth resolution.


  2. generate_vgrid

    call generate_vgrid (Vgrid)
    DESCRIPTION


    INPUT/OUTPUT
    Vgrid    A derived-type variable that contains vertical grid information.
       [vgrid_data_type]

  3. write_vgrid_data

    call write_vgrid_data (unit)
    DESCRIPTION


    INPUT
    unit    The unit corresponding the output netcdf file. Always is returned by mpp_open.
       [integer]

  4. write_vgrid_meta

    call write_vgrid_meta (unit, Vgrid)
    DESCRIPTION


    INPUT
    unit    The unit corresponding the output netcdf file. Always is returned by mpp_open.
       [integer]
    Vgrid    A derived-type variable that contains vertical grid information.
       [vgrid_data_type]

  5. vgrid_end

    call vgrid_end ( Vgrid )
    DESCRIPTION
    Deallocates memory used by "vgrid_data_type" variables.


    INPUT/OUTPUT
    Vgrid    A derived-type variable that contains vertical grid information.
       [vgrid_data_type]

NAMELIST

&vgrid_nml

nzdepths
number of depth regions for varying resolution
[integer]
z_depth
boundaries for defining depth regions of varying resolution
[real, dimension(nxlons), units: meters]
dz_depth
nominal resolution of depth regions
[real, dimension(nxlons), units: meters]
stretch_z
stretch factor of vertical grids.
[real]
read_my_grid
read ASCII grid information for supplying user-defined grids.
[logical]
my_grid_file
Name of ASCII or netcdf user grid file
[character(len=128)]
z_axis_t
Name of z_t axis, if the file is netcdf
[character(len=24)]
z_axis_b
Name of z_b axis, if the file is netcdf
[character(len=24)]
z_axis_b_offset
offset of z_b axis, if the file is netcdf 1 corresponds to an axis starting at k=0, z_b=0 (mom3)
[integer]
debug
control standard output.
[logical]

top