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

Module ocean_topog_mod

Contact:  Matt Harrison S. M. Griffies
Reviewers: 
Change History: WebCVS Log


OVERVIEW

Set up ocean bottom topography.

Set up ocean bottom topography. Reads information from grid specification file.


OTHER MODULES USED

       constants_mod
fms_mod
mpp_domains_mod
mpp_mod
axis_utils_mod
ocean_domains_mod
ocean_parameters_mod
ocean_types_mod

PUBLIC INTERFACE

ocean_topog_init:


PUBLIC DATA

None.


PUBLIC ROUTINES

  1. ocean_topog_init

    DESCRIPTION
    Initialize the ocean bottom topography.

    There are two reasons to prefer land be at j=1.

    A/ mom4 employs a northest B-grid. To construct horizontal remapping operators, we need information about grid factors one row outside of the global domain boundaries. In particular, we need j=0 grid information. However, when constructing the grid spec file, we assume nothing about the region outside the global domain. So mom4's requirement of j=0 grid information necessitates extrapolation. This extrapolation is done inside ocean_grids.F90, and it can lead to non-symmetric values of grid spacing for the region j=0 and j=nj, even if the domain global limits are symmetric across the equator.

    B/ The FMS Sea Ice Simulator (SIS) requires land to be present for all points at jsc+joff=1. If this is not the case, then the ocean model cannot be coupled to SIS. The SIS requirement of all land at jsc+joff=1 is related to the use of a northeast B-grid convention. To couple the models, the ocean grid must be generated with fill_first_row=.true.




NAMELIST

&ocean_topog_nml

debug_this_module
For debugging.
[logical]
flat_bottom
For debugging, it is often useful to over-ride the grid spec file and simply make the domain flat bottom.
[logical]
flat_bottom_kmt
Number of depth levels to use for the flat_bottom option.
[integer]
flat_bottom_ht
Depth to make the flat_bottom.
[real]
min_thickness
min_thickness is only used for Mosaic grid. Since there is no kmt available in mosaic grid, need to set min_thickness to configure kmt based on ht and zw. Default min_thickness=1.0 metre.
[real]
kmt_recompute
To recompute the kmt array based on min_thickness. This step is not recommended in general, since it can modify the kmt array which may be in the grid spec file. But it may be of use for specialized situations, such as when you wish to use the same topography file with a refined vertical resolution.
[logical]
kmt_recompute_offset
To recompute the kmt array based on min_thickness, with an offset determined by kmt_recompute_offset. Default kmt_recompute_offset=0.
[integer]


DATA SETS

None.


ERROR MESSAGES

None.


top