grid_tools  1.7.0
 All Data Structures Files Functions Variables
Public Member Functions | Data Fields
utils Module Reference

Module that contains general utility routines. More...

Public Member Functions

subroutine fill_regional_halo (data, halo)
 This routine extrapolate geolat_c and geolon_c halo points for the regional standalone grid. More...
 
subroutine handle_err (status, string)
 Prints an error message to standard output, then halts program execution with a bad status. More...
 
subroutine read_namelist
 Read the program namelist file. More...
 

Data Fields

character(len=512) grid_file = "atmos_mosaic.nc"
 Path/name of the grid mosaic file. More...
 
integer grid_type = 0
 Grid type. More...
 
character(len=128) mask_field = "slmsk"
 NetCDF record name of the land/sea mask. More...
 
logical nested = .false.
 If true, process a global grid with a nest. More...
 
logical regional = .false.
 If true, process a stand-alone regional grid. More...
 
real res = 48.
 The 'CRES' resolution. More...
 
real stretch_fac = 1.0
 Grid stretching factor. More...
 
character(len=128) topo_field = "orog_filt"
 NetCDF record name of the filtered topography (or orography). More...
 
character(len=512) topo_file = "orog"
 Path/name of the topography (or orography) file. More...
 
logical zero_ocean = .true.
 If true, no diffusive flux into water/ocean area (preserve islands). More...
 

Detailed Description

Module that contains general utility routines.

Author
GFDL programmer

Definition at line 8 of file utils.F90.

Member Function/Subroutine Documentation

subroutine utils::fill_regional_halo ( real, dimension(1-halo:,1-halo:,:), intent(inout)  data,
integer, intent(in)  halo 
)

This routine extrapolate geolat_c and geolon_c halo points for the regional standalone grid.

Halo points are needed for dxc and dyc calculation.

Parameters
[in,out]data- field to be extrapolated
[in]halo- number of halo rows/columns
Author
Ratko Vasic (NCEP/EMC)

Definition at line 70 of file utils.F90.

Referenced by read_grid_file(), and read_topo_file().

subroutine utils::handle_err ( integer, intent(in)  status,
character(len=*), intent(in)  string 
)

Prints an error message to standard output, then halts program execution with a bad status.

Parameters
[in]statusError status code.
[in]stringError message.
Author
GFDL Programmer

Definition at line 106 of file utils.F90.

Referenced by read_grid_file(), read_namelist(), read_topo_file(), and write_topo_file().

subroutine utils::read_namelist ( )

Read the program namelist file.

Then, write the namelist variables to standard output.

Author
GFDL Programmer

Definition at line 36 of file utils.F90.

References handle_err().

Referenced by filter_topo().

Field Documentation

character(len=512) utils::grid_file = "atmos_mosaic.nc"

Path/name of the grid mosaic file.

Definition at line 18 of file utils.F90.

integer utils::grid_type = 0

Grid type.

0 for a gnomonic grid.

Definition at line 25 of file utils.F90.

character(len=128) utils::mask_field = "slmsk"

NetCDF record name of the land/sea mask.

Definition at line 17 of file utils.F90.

logical utils::nested = .false.

If true, process a global grid with a nest.

Definition at line 22 of file utils.F90.

logical utils::regional = .false.

If true, process a stand-alone regional grid.

Definition at line 23 of file utils.F90.

real utils::res = 48.

The 'CRES' resolution.

Definition at line 28 of file utils.F90.

real utils::stretch_fac = 1.0

Grid stretching factor.

Definition at line 27 of file utils.F90.

character(len=128) utils::topo_field = "orog_filt"

NetCDF record name of the filtered topography (or orography).

Definition at line 15 of file utils.F90.

character(len=512) utils::topo_file = "orog"

Path/name of the topography (or orography) file.

Definition at line 14 of file utils.F90.

logical utils::zero_ocean = .true.

If true, no diffusive flux into water/ocean area (preserve islands).

Definition at line 20 of file utils.F90.

The documentation for this module was generated from the following file: