Some Sample Programs Using the I/O API

Here are six sample m3tools programs to show normal usage of the I/O API. These programs were designed to show some typical interactive uses in a meaningful fashion (i.e., the programs really do compute something useful). Note that a modeling program should use fixed logical names which are properties of the program itself, and should use OPEN3() and GETEFILE() (etc.), instead of prompting the user for file names with the PROMPT*FILE() routines.

These programs also use a number of the utility and coordinate transformation routines. Along with these programs, a number of I/O API data manipulation programs are also distributed, in the m3tools subdirectory of the release; they are documented here in the I/O API Programmer/User Manual.

These sample programs are:

latlon computes single-layer time-independent gridded and/or boundary files containing REAL variables LAT and LON and REAL*8 variables LATD and LOND containing latitudes and longitudes at cell centers for the specified grid and/or its boundary (the choice of which file (or both) to generate is a user option). Uses
- MODULE M3UTILIO
- MODULE MODGCTP
- DSCGRID(),
- GETVAL(), as generic for GETDBLE(), GETMENU(), GETNUM(), GETREAL(), GETYN()
- GETSTR()
- GRID2XY()
- M3EXIT()
- OPEN3()
- XY2XY()
- WRITE3()
m3probe extracts time series for a specified variable for a specified set of points from an input file of type GRIDDED, BOUNDARY, or CUSTOM, and writes the resulting time series as columns to a human-readable ASCII REPORT-file.
Note that this program also demonstrates how array-subscript order works for BOUNDARY files.
- MODULE M3UTILIO
- DESC3()
- GETEFILE()
- GETSTR()
- GETVAL(), as generic for GETNUM(), GETYN()
- M3EXIT()
- M3MESG()
- NEXTIME()
- OPEN3()
- RUNSPEC()
m3cple reads all variables in each time step in the specified time step sequence from the specified input file, optionally under the control of the specified synchronization file, copies or interpolates them to the specified output grid, and write them to the specified output file.
- MODULE M3UTILIO
- MODULE MODGCTP
- GETVAL(), as generic for GETNUM(), GETYN()
- CHECK3()
- CURREC()
- DESC3()
- DSCGRID()
- GETSTR()
- GRID2INDX() and INDXMULT()
- LASTTIME()
- LUSTR()
- M3EXIT()
- M3MESG()
- M3WARN()
- NEXTIME()
- OPEN3()
- PROMPTMFILE()
- READ3()
- UPCASE()
- WRITE3()
mtxcalc computes a sparse grid-to-grid transform matrix for specified input and output grids, and write the result to a sparse-matrix file.
- MODULE M3UTILIO
- MODULE MODATTS3
- MODULE MODGCTP
- DSCGRID()
- ENVGET() as generic for ENVINT(), ENVREAL()
- GETVAL() as generic for GETYN()
- GRID2XY()
- M3EXIT()
- M3MESG()
- OPEN3()
- PROMPTFFILE()
- SETMTXATT()
- WRITE3()
presz optionally reads in a file containing gridded terrain heights, prompts the user for a (hydrostatic) vertical grid, and then constructs a time-independent layered gridded file containing the following variables for an MM5-style reference atmosphere:
- TA (meters), Temperataure (K) at the half-levels (i.e., at layer centers).
- ZH (meters), hypsometric-approximation heights at the half-levels (i.e., at layer centers).
- ZF (meters), heights at the full levels (i.e., at layer-tops).
- PRESH, pressures at the half-levels.
- PRESF, pressures at the full levels.
Uses
- MODULE M3UTILIO
- DESC3()
- DSCGRID()
- GETVAL(), as generic for GETDBLE(), GETMENU(), GETNUM(), GETREAL(), GETYN()
- GETSTR()
- M3EXIT()
- M3WARN()
- OPEN3()
- READ3()
- WRATT3()
- WRITE3()
vertintegral computes the vertical-column integral mass for each timestep of each variable in a user-specified GRIDDED Models-3 CMAQ CONC file and writes the result to a user-specified 1-layer GRIDDED output file. It requires the use of an MCIP output MET_CRO_3D file on the same grid and for the same time period, for variables DENS and ZF used in the calculation. This program also demonstrates OpenMP parallelism, and how to use command line arguments.
mpaswtest demonstrates uses of routines from module MODMPASFIO.
- MODULE M3UTILIO
- MODULE MODNCFIO
- MODULE MODMPASFIO
- INITMPGRID()
- FINDCELL()
- FINDVRTX()
- SPHEREDIST()
- ARC2MPAS()
- CREATEMPAS()
- DESCMPAS()
- READMPAS()
- WRITEMPAS()
- SHUTMPGRID()
- INIT3()
- M3MESG()
- GETVAL(), as generic for GETDBLE(), GETMENU(), GETNUM(), GETREAL(), GETYN()
- M3EXIT()

next: NCDUMP

Up: Related Programs

To: Models-3/EDSS I/O API: The Help Pages