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

Module ocean_grids_mod

Contact:  M.J. Harrison R. C. Pacanowski Zhi Liang
Reviewers:  S.M. Griffies
Change History: WebCVS Log


OVERVIEW

Set up the ocean model grid spacing

This module sets up the ocean model grid based on information read in from the grid_spec.nc file. It translates the generic names from the grid_spec.nc file to the names used by mom4.


OTHER MODULES USED

    constants_mod
diag_manager_mod
fms_mod
mpp_domains_mod
mpp_io_mod
mpp_mod
ocean_domains_mod
ocean_types_mod

PUBLIC INTERFACE

ocean_grids_init:
set_ocean_grid_size:
set_ocean_hgrid_arrays:
set_ocean_vgrid_arrays:
axes_info:
update_boundaries:


PUBLIC DATA

None.


PUBLIC ROUTINES

  1. ocean_grids_init

    DESCRIPTION
    Initialize the grids module.


  2. set_ocean_grid_size

    DESCRIPTION
    Set the ocean grid size. Model expects the grid specification file to be called grid_spec.nc.


  3. set_ocean_hgrid_arrays

    DESCRIPTION
    Define horizontal (and some vertical) grid arrays.


  4. set_ocean_vgrid_arrays

    DESCRIPTION
    Compute vertical (and some horizontal) grids for ocean model. Also compute axes information for diagnostic manager.


  5. axes_info

    DESCRIPTION
    Set up the definitions of the axes


  6. update_boundaries

    DESCRIPTION
    Set halo points at model boundaries equal to values at boundaries if no grid connectivity exists. If model is connected along boundary then use mpp_update_domains.



NAMELIST

&ocean_grids_nml

debug_grid
For debugging. Note that most of the debugging stuff has been removed, but keep flag around in case need in future.
[logical]
verbose_init
Prints out lots of initial checksums. Useful to have on, so defaulted to true.
[logical]


DATA SETS

None.


ERROR MESSAGES

None.


REFERENCES

  1. S.M. Griffies, M.J. Harrison, A. Rosati, and R.C. Pacanowski A Technical Guide to MOM4 (2003)


COMPILER SPECIFICS

None.


PRECOMPILER OPTIONS

None.


LOADER OPTIONS

None.


TEST PROGRAM

None.


KNOWN BUGS

None.


NOTES

None.


FUTURE PLANS

None.


top