Environment Variables for the I/O API
Generally, all OpenMP parallel programs use environment variable
OMP_NUM_THREADS to control how many parallel
threads/processors are used for program execution. In particular,
this applies to "m3tools" programs M3AGMASK, M3AGMAX,
M3COMBO, M3TPROC
and VERINTEGRAL
for I/O API
version 3.1 later than Nov. 21, 2013.
The following are standard environment variables supported or used
by the I/O API. These should be set using setenv,
for example, if you are using csh).
- LOGFILE is the physical pathname for
the program log. If this logical name is present, the
indicated file is opened for output; otherwise, Fortran
standard output to UNIT 6 for the log is assumed. This log
file is used throughout the I/O API, also, its unit
number is returned by INIT3() .
- SCENFILE is the physical pathname for the
scenario description file. The contents of this file will be
copied into the "update description" of files
opened for writing during this program execution. The file
may have up to
MXDESC3=60
lines of length at most
MXDLIN3=80.
- EXECUTION_ID is provided for use in
tracking the system ID of the current execution, and is
copied into the "execution ID" field of files
opened for writing during this program execution.
It is a character string of length at most
MXDLIN3=80.
- IOAPI_CHECK_HEADERS controls whether
consistency and validity checks are turned on for files
being created (value begins with 'Y' or 'y'), or not.
The default value is 'N', indicating that the check will not
take place.
- IOAPI_LOG_WRITE controls whether
a log message is written for each successful WRITE3()
operation (messages are always written for failures).
The default value is 'Y', indicating that the log messages
will be generated.
- IOAPI_KEEP_NSTEPS controls how
many time steps of data will be kept in active PVM
mailboxes for I/O API
coupling-mode virtual files, with a default value of 2.
The following environment variable is used by grid-description and
grid manipulation utility routines such as DSCGRID() and DSCOORD().
The following environment variable controls whether
routines GETDBLE(),
GETMENU(),
GETNUM(),
GETREAL(),
GETSTR(),
GETYN(),
PROMPTFFILE(), and
PROMPTMFILE(), prompt the user for
the value requested, or not. Setting PROMPTFLAG to "N"
can be used, in conjunction with the selection of "smart"
defaults within programs, to make it easier to write scripts for
running various programs.
Routines ENVDBLE ,
ENVINT ,
ENVREAL ,
ENVSTR , and
ENVYN can be used from programs
to find the values of environment values of types DOUBLE PRECISION,
INTEGER, REAL, CHARACTER STRING, and LOGICAL, respectively, log the
value retrieved, convert it to the indicated type, and return it to
the caller. Routine NAMEVAL, which
performs a similar function for CHARACTER STRINGs, but does not log
the transaction, is used internally by the I/O API. Routine
SETENV can be used to set environment
variables for the currently-executing program.
Previous Section: Logical Names
Next Section: Grids and Coordinate Systems
Up: Conventions
To: Models-3/EDSS I/O API: The Help Pages