This document describes use of the tgcmproc post-model processor. Input parameters are described alphabetically below. Please refer to the example run scripts tgcmproc_sut (single-ut mode) and tgcmproc_mut (multi-ut mode) for how these input parameters may be functionally grouped and submitted to obtain the model results.
This processor is to be run on Cray systems only. (see tgcmidl for IDL-based interactive post-model processing) For information about NCAR Cray computers, including how to obtain logins, please see Information for NCAR Computer Users
This processor will read any tigcm, tiegcm, or time-gcm model histories, including secondary (limited fields) histories, and tgcm history volumes from ccm2/tgcm coupled runs. It also distinguishes dynamo vs non-dynamo runs. The vertical dimension is determined dynamically when reading the histories, but the geographic latitude/longitude grid is fixed (-87.5 to +87.5 latitude by 5 degrees, and -180 to +180 longitude by 5 degrees).
Each plot or data frame from the single-ut (sut) branch of the processor are from a single model history, representing model results from a single time. One or more histories (ut's) may be requested in a given run.
Each frame from the multi-ut (mut) branch of the processor displays data from multiple model histories, representing time-dependent results. Plots from the mut branch typically have ut (time) on the x-axis. Three or more histories must be specified.
The following diagram illustrates the types of 1d (xy plots) and 2d (contour) plotting available:
|-- global (lon vs lat)
| (at selected zp/ht)
|
|
|--- maps ---|-- polar (pole in center)
| (2d) | (at selected zp/ht)
| |
| |
| |-- satellite view
| | (at selected zp/ht)
|
|
|-- lon slices (2d lat vs zp/ht)
| (at selected longitudes, zm, or slt)
|
|-- single-ut --|
| (sut) |
| |-- lat slices (2d lon vs zp/ht)
| | (at selected latitudes)
| |
| |
| |
| |-- xy locations (1d field vs zp/ht)
| | (at selected lat,lon locations)
|
tgcmproc --|
|
|
| |-- ut vs zp/ht (2d)
| | (at selected lat,lon)
| |
| |
| |-- ut vs lat (2d)
| | (at selected lon,zp/ht)
|--- multi-ut --|
(mut) |
|-- ut vs longitude/slt (2d)
| (at selected lat,zp/ht)
|
|
|-- ut vs field (1d)
| (at selected lat,lon,zp/ht)
Input parameters are provided by the user to configure a run of the processor. These parameters determine which model histories will be obtained and the types of plots and/or output files that will be produced.
The inputs are given in standard fortran "namelist" form. Please see the scripts tgcmproc_sut and tgcmproc_mut for examples of inputs for single-ut (sut) and multi-ut (mut) modes respectively.
Note that all inputs (including the comment symbol, the semicolon), start in column 2 or later. Column one is ignored, except for the "E", which means echo the input to stdout. White space is also generally ignored by namelist.
Alphabeticaly listing of valid tgcmproc input parameters (links jump to explanations below):
Comma separated list of strings specifying the field(s) desired to be processed. Quotes are not necessary. Each value must match one of the following:
TN UN VN O2 OX N4S NOZ CO CO2 H2O H2 HOX O+ CH4 AR HE O21D NO2 NO O3 O1 OH HO2 H N2D TI TE NE O2+ W Z POTEN UI VI WI N2 RHO UN+VN UI+VI FOF2 HMF2 O/O2 O/N2 N2/O O2/N2 O/O2+N2 E6300 E5577 EO200 EOH83 ECO215u ENO53u
Fields need not be given in the above order. Fields will be processed in the order given in cfields. If invalid values are given, or requested fields are not available on the histories, a warning message will be printed to stdout and those cfields values will be ignored.
The last six fields are emission rates. Please see IEMIS for how these are calculated.
Data type: string array
Default: none -- at least one valid value required
Examples:
Note: as of 9/3/96, cfields replaces IFIELDS, and IEMIS
Single float specifying the 10.7 cm 80-day averaged solar flux to be used in the IEOHV calculation. If not given, the f107a from the tgcm history header will be used. This parameter ignored if ieohv(*)=0.
Data type: single float
Default: from tgcm header
Single float specifying the 10.7 cm daily solar flux to be used in the IEOHV calculation. If not given, the f107d from the tgcm history header will be used. This parameter ignored if ieohv(*)=0.
Data type: single float
Default: from tgcm header
Two floats specifying the vertical range (ln(p0/p)) for the y-axis of latitude slices. The two values are bottom and top of the desired range, respectively. If the first value is less than (below) the bottom of the model, it will be raised to the bottom of the model. Likewise, if the second value given is greater than (above) the top of the model it will be lowered to the top. (e.g., flat_zprange = -100.,100. will be changed to the full vertical pressure resolution of the current history).
This parameter ignored if ipltlon=0. (note both flat_zprange and flat_htscale may be specified in the same run). Resolution (delta zp) will always be that of the model, i.e., 0.5. This parameter ignored if ipltlat=0.
Data type: Two floats.
Default: The full pressure range of the current history (-7 to +5 for ti(e)gcm, -17 to +5 for uncoupled time-gcm)
See also: IPLTLAT, FLAT_HTSCALE
Three floats specifying the vertical scale (km) for the y-axis of latitude slices. The first two values are bottom and top of the desired scale, and the third value is the delta resolution (km). Model values are interpolated to the requested heights. This parameter ignored if ipltlat=0.
Data type: Three floats.
Default: none
Example: flat_htscale = 80.,120.,1. ; plot from 80 to 120 km, every 1 km
See also: IPLTLAT, FLAT_ZPRANGE,
One or more (up to 73) real values giving selected longitudes for longitude slices (see ipltlon). Valid longitudes are from -180 (west) to +180 (east). If one of the values is 'zm', slices will be made in which the field values are averaged around all longitudes. This parameter is ignored if ipltlon = 0.
Data type: Array of floats (or the string 'zm')
Example: flons = 0., -180., 'zm', -70.
See also: IPLTLON, FSLTS, FLON_ZPRANGE, FLON_HTSCALE, ILON_LOG10
Two floats specifying the vertical range (ln(p0/p)) for the y-axis of longitude slices. The two values are bottom and top of the desired range, respectively. If the first value is less than (below) the bottom of the model, it will be raised to the bottom of the model. Likewise, if the second value given is greater than (above) the top of the model it will be lowered to the top. (e.g., flon_zprange = -100.,100. will be changed to the full vertical resolution of the current history). This parameter ignored if ipltlon=0. (note both flon_zprange and flon_htscale may be specified in the same run). Resolution (delta zp) will always be that of the model, i.e., 0.5.
Data type: Two floats.
Default: The full pressure range of the current history (-7 to +5 for ti(e)gcm, -17 to +5 for uncoupled time-gcm)
See also: IPLTLON, FLON_HTSCALE
Three floats specifying the vertical scale (km) for the y-axis of longitude slices. The first two values are bottom and top of the desired scale, and the third value is the delta resolution (km). Model values are interpolated to the requested heights. This parameter ignored if ipltlon=0.
Data type: Three floats.
Default: none
Example: flon_htscale = 80.,120.,1. ; plot from 80 to 120 km, every 1 km
See also: IPLTLON, FLON_ZPRANGE
One or more (up to 36) floats specifying perimeter latitude(s) for polar stereographic mapped projections. If the given latitude is > 0., then the north pole will appear in the center of the projection, otherwise the south pole will be at the center. This parameter ignored if ipltmaps=0 or map_polar=0.
Data type: One or more (up to 36) floats
Two floats specifying the latitude and longitude of the center of a satellite view projection. Latitude may be -90 to +90, longitude may be -180 to +180. This parameter ignored if ipltmaps=0 or map_satview=0. Note if both fmap_satview_latlon and fmap_satview_latslt are set on input, only fmap_satview_latlon will be used.
Data type: Two floats
Default: 40.,0.
Two floats specifying the latitude and local time of the center of a satellite view projection. Latitude may be -90 to +90, local time may be 0 to 24. This parameter ignored if ipltmaps=0 or map_satview=0. Note if both fmap_satview_latlon and fmap_satview_latslt are set on input, only fmap_satview_latlon will be used.
Data type: Two floats
Default: none
Single float specifying the number of earth radii from the viewpoint (position of the viewing eye) to the center of the earth in a satellite view projection. This parameter ignored if map_satview=0 or ipltmaps=0. This parameter must be > 1. (if given <= 1., it will be reset to default). Values < 6.631 will "zoom in" on the earth. Larger values make very little difference in the plot.
Data type: Single float
Default: 6.631 (geosynchronous orbit)
Zero or more (up to 50) real values giving selected log pressure (zp, i.e., alog(p0/p)) and/or height surfaces for mapped plots. If a value is greater than 5., it is assumed to be a height surface (km), otherwise it is assumed to be a log pressure. If a given pressure value is below the bottom of the model, it is raised to the bottom (e.g., -99. would be raised to -17. for a standard time-gcm history, or to -7. for a ti(e)gcm history). Height and zp values may be mixed in fmap_zpht.
If no values are given for fmap_zpht (it is commented out), then fmap_zpht will default to -4., unless *only* emissions fields are requested, in which case only height-integrated emissions fields will be made.
If model results are not available for a given height surface (e.g., 500km may be above the model at certain grid points), data is not plotted, and is given the special value 1.e36 in the ascii data output file.
fmap_zpht is ignored if ipltmaps=0
Data type: real, up to 50 values
Examples:
Optional series of 4 values: 'FIELD',fmin,fmax,cint, where fmin,fmax are the minimum and maximum value for plotting of field, and cint is the contour interval for contouring. FIELD must be one of the field labels given in comments to cfields (and, unlike cfields, it must be quoted). If fmin > fmax, the minimum and maximum of the field is calculated and used. If cint = 0., the interval will be chosed in the software. Note fmnmxint is used *after* any application of fscale.
Data type: Groups of four values: string,float,float,float
Default: 'FIELD',1.,0.,0. for all fields
Example: fmnmxint = 'TN',480.,1640.,40., 'POTEN',-18000.,14000.,2000.
In this example, Temperature (TN) is to be plotted from 480 to 1640, with contour interval of 40. Electric potential (POTEN) is to be plotted from -18000 to 14000 by 2000.
Optional series of 2 values: 'FIELD',scale, where FIELD is one of the field labels given in comments to cfields (and, unlike cfields, it must be quoted), and scale is a scale factor to be multiplied by the field values before plotting. Note scale is applied before fmnmxint for the given field.
Data type: Pairs of string,float
Example: fscale = 'O1',1.e-11
In this example, Atomic oxygen (O1) is to be multipled by 1.e-11 before plotting.
Default: 'FIELD',1. for all fields
One or more (up to 73) real values specifying local times at which to make longitude slices (see ipltlon). Valid values are 0 to 23.9. The processor will plot the fields at the longitudes corresponding to the requested local times at the ut of the current history. This parameter is ignored if ipltlon = 0.
Data type: Array of floats
Example: fslts = 0., 6., 12., 18.
See also: IPLTLON, FLONS, FLON_ZPRANGE, FLON_HTSCALE, ILON_LOG10
Specifies the mss path(s) to model history volume(s) from which model results are to be read. A model history volume is an mss file containing one or more model histories, i.e., model results at a specific day, hour, and minute (see mtimes). Typically, tgcm history volumes have a 3-part path: /USER/DIR/FLNM. Each history volume given is enclosed in quotes (up to 32 characters). Up to 50 comma separated history volumes may be specified. The processor will search these files for the given mtimes.
Data type: one or more character strings
Default: none. At least one value required.
History volume(s) for control case of a difference fields run. I.e., if histvols_cntr and mtimes_cntr are given, the output will be difference fields of histvols (at mtimes) minus histvols_cntr (at mtimes_cntr). See description of histvols for details on how to provide history volumes.
Notes on difference fields runs:
Data type: one or more character strings
See also: MTIMES_CNTR
One or more integer flags requesting plots of OH emission bands. Each flag is a 2-digit integer in which the 10's digit indicates the high range and the 1's digit indicates the low range of the requested emission band. Valid emission bands (high-low) are:
1-0 2-1 3-2 4-3 5-4 6-5 7-6 8-7 9-8
2-0 3-1 4-2 5-3 6-4 7-5 8-6 9-7
3-0 4-1 5-2 6-3 7-4 8-5 9-6
4-0 5-1 6-2 7-3 8-4 9-5
5-0 6-1 7-2 8-3 9-4
6-0 7-1 8-2 9-3
OH emission bands are calculated for the following plot types:
Units of volume emission rate are photons/cm3-sec if ibohv_watts=0, or watts/cm3 if ibohv_watts=1.
Units of brightness (height-integrations) are kilo-rayleighs if ibohv_watts=0, or watts/cm2-steradian if ibohv_watts=1.
Note that ibohv=83 (the 8-3 OH band) is a different calculation than that given by cfields=EOH83 (see IEMIS).
Example: ibohv = 98,97,96,95,94,93
Data type: one or more 2-digit integers
Default: none (comment out in input file if not wanted)
See also: IEOHV, IBOHV_WATTS,
Integer flag specifying units for OH emission bands (ibohv). If ibohv_watts = 0 (the default), then the volume emission rate of the OH emission bands will be in photons/cm3-sec, and the brightness (height-integrated) will be in kilo-rayleighs. If ibohv_watts = 1, then the volume emission rates will be in watts/cm3 and the brightness will be in watts/cm2-steradian.
Data type: single integer
Default: 0
See also: IBOHV
Single integer flag. If ibox_clabs = 1, contour line labels will be boxed, otherwise they are not. Boxed contour line labels are sometimes easier to read, esp with color fill contours.
Data type: Single integer
Default: 0
Single integer flag specifying monochrome contours (icolor=0), or color fill contours (icolor=1).
Data type: Single integer
Default: 0
Single integer flag specifying conversion of species densities as follows:
Data type: single integer
Default: 1
Integer flag specifying whether or not to generate doppler t,u,v fields for each emission field given by iemis (except ECO215u and ENO53u). This is for ut vs field line plots only (this parameter ignored if ipltxyut=0, or iemis(*)=0). This parameter accepted only for multi-ut (mut) runs.
Data type: single integer (all doppler fields plotted if idoppler=1)
Default: 0
Ten integer flags for the 10 oh vibrational states (ieohv(1) is ground) Each state is plotted as separate field if iehov(i) > 0 for plot type ipltxyloc (1d xy location line plots) or ipltutvert (2d ut vs zp or ht). Zonal and global means are not available. (fmnmxint and fscale are not implemented for ieohv)
Data type: ten integers
Default: 0,0,0,0,0,0,0,0,0,0
AS OF 9/3/96, THIS IS NO LONGER A VALID INPUT PARAMETER. (The flags iemis_integ, ie6300, and ie5577 are still valid (see below))
Please use cfields for requesting fields, including emissions fields.
cfields may be used to specify one or more of the six volume emissions fields calculated by the processor. These fields are calculated only from time-gcm histories. Also, iden must be = 1 (cm3 species) for these fields to be calculated.
The six possible fields, as given by cfields, are:
See the file mkemiss.f for how these fields are calculated.
See also: IEMIS_INTEG, IE6300, IE5577
Six integer flags for whether or not to plot height integrations of emissions fields requested by cfields. Height integrations are plotted on mapped projections (see ipltmaps). The order of the integer flags is E6300, E5577, EO200, EOH83, ECO215u, ENO53u. This parameter ignored if ipltmaps=0, or none of the emissions fields are requested via cfields.
Default: 0,0,0,0,0,0
Data type: 6 integers
Integer flag specifying which of 5 components to include in the calculation of E5577 emission:
Data type: 5 integers
Example: (also the default) ; (o1 recomb) (o2+ recomb) (photoe) (airglow) (o2 ly-beta) ie5577 = 1, 1, 1, 1, 1
Integer flag for whether or not to call solred and add SR63 to the E6300 emission calculation.
Data type: single integer
Default: 0
AS OF 9/3/96, THIS IS NO LONGER A VALID INPUT PARAMETER.
Please use cfields for requesting fields.
Integer flag specifying whether or not to plot log10 of species densities in latitude slices. (does not affect other fields such as temperature and winds). This parameter ignored if ipltlat=0.
Data type: Single integer (0 or 1)
Default: 1
Integer flag specifying whether or not to plot log10 of species densities in longitude slices. (does not affect other fields such as temperature and winds). This parameter ignored if ipltlon=0.
Data type: Single integer (0 or 1)
Default: 1
Single integer flag specifying the type of ion drift velocities to be calculated, as follows (This applies only to fields UI, VI, WI, and UIVI):
The source for this calculation is in the file mkdrifts.f (see the subroutine mkuivi)
Data type: single integer
Default: 1
Single integer to set the processor to multi-ut mode. This should always be set to 1 (one) in input files for multi-ut mode.
Data type: single integer
Default: none (required in multi-ut mode input files)
See also: INPUT_SUT,
Single integer to set the processor to single-ut mode. This should always be set to 1 (one) in input files for single-ut mode.
Data type: single integer
Default: none (required in single-ut mode input files)
See also: INPUT_MUT,
Single integer flag specifying whether or not to make latitude slices: ipltlat = 0 -> do not make latitude slices ipltlat = 1 -> make latitude slices
Latitude slices are contour plots with longitude on the x-axis and height or pressure on the y-axis, at selected latitudes. If ipltlat = 0, then the other related input parameters (listed below in "see also") will be ignored.
Data type: single integer
Default: 0
See also: FLATS, FLAT_ZPRANGE, FLAT_HTSCALE, ILAT_LOG10, LAT_TOP_ANNO, ILAT_YAXRIGHT
Single integer flag specifying whether or not to make longitude slices: ipltlon = 0 -> do not make longitude slices ipltlon = 1 -> make longitude slices
Longitude slices are contour plots with latitude on the x-axis and height or pressure on the y-axis, at selected longitudes (or zonal means or local times). If ipltlon = 0, then the other related input parameters (listed below in "see also") will be ignored.
Data type: single integer
Default: 0
See also: FLONS, FLON_ZPRANGE, FLON_HTSCALE, ILON_LOG10, LON_TOP_ANNO, ILON_YAXRIGHT
Single integer flag specifying whether or not to make map plots (i.e., data contours over geographic mapped projections. There are 3 map projections available, namely cylindrical equidistant (map_global=1), polar stereographic (map_polar=1), and satellite view (map_satv=1). If ipltmaps=0, then all mapping parameters are ignored (i.e., the "see also" parameter listing below)
Data type: single integer
Default: 0
See also: FMAP_ZPHT, MAP_CONTINENTS, MAP_TN_UNVN, MAP_EP_UIVI, IVEC_LABEL, MAP_GLOBAL, MAP_GLOBAL_CENLON, MAP_GLOBAL_CENSLT, MAP_POLAR, MAP_POLAR_PERIMLAT, MAP_SATVIEW, FMAP_SATVIEW_LATLON, FMAP_SATVIEW_ERADII
Two integers specifying the number of rows and columns respectively of plots drawn on each frame. ipltrowcol is used only when multiplt=1. Note that if row.ne.col then aspect ratio distortion will occur in the x direction (row > col), or in the y direction (col > row). Also be aware that larger numbers of rows or columns will result in smaller plots. Greater than 9 plots per frame (ipltrowcol=3,3) will result in very small text labeling (however the zoom feature of idt with cgm files is useful for enlarging small plots).
Data type: Two integers
Default: 2,2
See also: MULTIPLT, MULTIADVFR
Integer flag specifying whether or not ut vs latitude contours are to be made (ut on the x-axis, latitude on the y-axis, at selected longitude and zp or ht).
Data type: single integer
Default: 0
See also: UTLAT_ZPHTLON, IUTLAT_LOG10
Integer flag specifying whether or not ut vs longitude/slt contours are to be made ( ut on the x-axis, longitude or local time on the y-axis, at selected latitude and zp or ht).
Data type: single integer
Default: 0
See also: IUTLON_LOG10, IUTLON_YSLT
Integer flag specifying whether or not to make ut vs vertical contours at specified locations (ut on x-axis, zp or ht on y-axis).
Data type: single integer
Default: 0
See also: UTVERT_LOCS, UTVERT_LOCNAME, UTVERT_ZPRANGE, UTVERT_HTSCALE, IUTVERT_LOG10
Integer flag specifying whether or not to make xy vertical profile line plots at specified locations (field on x-axis, zp or ht on y-axis).
Data type: single integer
See also: XYLOCS, XYLOC_ZPRANGE, XYLOC_HTSCALE
Integer flag specifying whether or not to make xy line plots with ut on the x-axis, field on the y-axis, at selected locations and zp or height.
Data type: single integer
Default: 0
See also: XYUT_LOCS, XYUT_ZPHT
Integer flag specifying whether or not to continue searching for histories if a current history is not found. By default (isearch=0), if a history is not found after all history volumes have been searched, the sut processor will send any accumulated data/metacode files, and will not search for the next history. If isearch=1, all histories will be searched for even when one is not found. isearch does not affect mut processor at this time.
Data type: single integer
Default: 0
Integer flag specifying whether or not to plot log10 of species densities in ut vs latitude contours. (does not affect other fields such as temperature and winds). This parameter ignored if ipltutlat=0.
Data type: Single integer (0 or 1)
Default: 1
Integer flag specifying whether or not to plot log10 of species densities in ut vs longitude/slt contours. (does not affect other fields such as temperature and winds). This parameter ignored if ipltutlon=0.
Data type: Single integer (0 or 1)
Default: 1
See also: IPLTUTLON, IUTLON_YSLT
Integer flag which, if set to 1, will put local time on y-axis of ut vs longitude (ipltutlon) plots instead of longitude.
Data type: Single integer (0 or 1)
Default: 1
See also: IPLTUTLON, IUTLON_LOG10
Integer flag specifying whether or not to plot log10 of species densities in ut vs vertical contours. (does not affect other fields such as temperature and winds). This parameter ignored if ipltutvert=0.
Data type: Single integer (0 or 1)
Default: 1
Integer flag specifying whether or not to draw magnitudes (m/s) at *every* vector arrow on a vector plot (fields unvn, uivi, or when map_ep_uivi=1, or map_ht_unvn=1, or map_tn_unvn=1). This is primarilly for debug purposes and should not be used when generating many frames in a production run. The numbers are small, but may be read using zoom on idt.
Data type: Single integer
Default: 0
Integer flag specifying x-axis type and whether log10 of the field is to be plotted for xy location line plots. Note ixyut_log10 > 0 applies only to species densities, i.e., log10 of temperature, winds, etc. are not plotted.
Data type: Single integer
Default: 1
Single 5-digit integer specifying the year-day (yyddd) to be used in ieohv calculation. If not given, the iyd from the tgcm history header will be used. This parameter ignored if ieohv(*)=0.
Data type: single integer
Default: from tgcm header
Optional character variable (up to 80 chars) to be drawn as annotation at the top of all latitude slice plots. This parameter ignored if ipltlat=0.
Data type: character*80 (must be enclosed in quotes)
Default: none
Optional character variable (up to 80 chars) to be drawn as annotation at the top of all longitude slice plots. This parameter ignored if ipltlon=0.
Data type: character*80 (must be enclosed in quotes)
Default: none
Integer flag specifying whether or not to draw continental outlines on mapped projections (map_continents = 1 -> draw continents, otherwise do not). The outlines are drawn in geographic coordinates with a dashed line. This parameter ignored if ipltmaps=0.
Data type: Single integer
Default: 0
Integer flag specifying whether or not to plot ion drift vectors over a mapped contour of electric potential. The vectors are represented by arrows with length proportional to magnitude (sqrt(ui**2 + vi**2)). This parameter ignored if ipltmaps=0 or epot not flagged. (note you do not need to flag the fields ui or vi for map_tn_uivi=1 to work).
Data type: Single integer
Default: 1
Integer flag specifying whether or not to produce global mapped plots. This is the cylindrical equidistant map projection (longitude on x-axis, latitude on y-axis). This parameter ignored if ipltmaps=0.
Data type: Single integer
Default: 0
See also: MAP_GLOBAL, MAP_GLOBAL_CENLON, MAP_GLOBAL_CENSLT
Single integer specifying a center longitude on the x-axis of global cylindrical equidistant plots (map_global=1). Note this is not a float, so only full degrees may be specified. Longitude is given from -180 degrees west to +180 degrees east. Note if multiple frames are produced at different ut's, continental outlines will be fixed, and local time will vary with ut. (note you cannot set both map_global_cenlon and map_global_censlt in the same run. If both are set, map_global_censlt is ignored). This parameter ignored if ipltmaps=0 or map_global=0.
Data type: Single integer.
Default: 0
See also: MAP_GLOBAL_CENSLT
Single integer specifying a center local time (hrs) on the x-axis of global cylindrical equidistant plots (map_global=1). Note this is not a float, so only full hours may be specified. Valid values are 0 to 23. Note if multiple frames are produced at different ut's, continental outlines will move across the plots and local time will be fixed. This parameter ignored if ipltmap=0 or map_global=0. (note you cannot set both map_global_cenlon and map_global_censlt in the same run. If both are set on input, map_global_censlt is ignored).
Data type: Single integer.
Default: none
See also: MAP_GLOBAL_CENLON
Single integer flag specifying whether or not to produce polar stereographic mapped projections. This is a stereographic projection with north or south pole in the center (see fmap_polar_perimlat), and with local noon at the top, local midnight at the bottom. This parameter ignored if ipltmaps=0.
Data type: Single integer
Default: 0
See also: FMAP_POLAR_PERIMLAT
Integer flag specifying whether or not to plot neutral wind vectors over a mapped contour of height (z field). The vectors are represented by arrows with length proportional to magnitude (sqrt(un**2 + vn**2)). This parameter ignored if ipltmaps=0 or z not flagged. (note you do not need to flag the fields un or vn for map_ht_unvn=1 to work).
Data type: Single integer
Default: 0
Integer flag specifying whether or not to produce satellite view mapped projections. This parameter ignored if ipltmaps=0.
Data type: Single integer
Default: 0
FMAP_SATVIEW_LATLON, FMAP_SATVIEW_ERADII
Integer flag specifying whether or not to plot neutral wind vectors over a mapped contour of neutral temperature. The vectors are represented by arrows with length proportional to magnitude (sqrt(un**2 + vn**2)). This parameter ignored if ipltmaps=0 or tn not flagged. (note you do not need to flag the fields un or vn for map_tn_unvn=1 to work).
Data type: Single integer
Default: 1
Optional character variable (up to 80 chars) to be drawn as annotation at the top of all map projection plots. This parameter ignored if ipltmaps=0.
Data type character*80
Default: none
Single integer flag specifying acquisition of the heights field:
If modelhts = 0, then the heights on the history are ignored, and instead, heights (hts) are calculated at each geographic grid point as follows, where tn is neutral temperature, xmas is mean mass, and dz is delta log pressure (usually 0.5):
data go/980.665/, ro/6356.766e+5/, boltz/1.38e-16/
g(1) = go*(ro/(ro+hts(1)))**2 ! gravity at bottom
do k=2,kmx ! loop over vertical levels
hts(k) = hts(k-1) + boltz*dz*tn(k-1) / (xmas(k-1)*g(k-1))
g(k) = go*(ro/(ro+hts(k)))**2 ! gravity at next level
enddo
When modelhts = 0, the lower boundary (hts(1)) is fixed according to the bottom pressure level zp1 as follows:
Data type: single integer
Default: 1 (use heights on the history)
List of model times (histories) to read from given history volumes (see histvols). Each model time given as a comma separated integer triplet specifying the model day, hour, minute of the desired history. (the ut will be the model hour + model minute/60). Valid model days are 0 to 366, however model days given > 366 will result in reading all given history volumes (histvols) and reporting histories (times) found on each volume. Valid hours are 0-23, valid minutes are 0-59. A maximum of 241 model times (723 integers) may be specified.
mtimes may also be given as a beginning time (integer triplet) followed by the string 'to', followed by an ending time (integer triplet), followed by the string 'by', followed by delta time (single integer in minutes). See the example below.
Data type: one or more integer triplets, or special "do-loop" notation as in below example.
The first example specifies hours 0, 6, and 12 from model day 0. The second example will expand to hourly histories from 0,0,0 to 1,0,0 (i.e., 25 histories, 0,0,0, 0,1,0, 0,2,0,...0,23,0, 1,0,0).
Default: none
Control (base case) times for a difference fields run. Must also provide histvols_cntr. mtimes_cntr are given in same manner as mtimes. (see histvols_cntr for notes on difference fields)
Data type: one or more integer triplets, or special "do-loop" notation as in below example.
Default: none
See also: HISTVOLS_CNTR, MTIMES
Single integer flag indicating whether or not frame should be advanced between plot types (maps, slices, etc) and ut's (histories). Multiadvfr is ignored if multiplt=0.
multiadvfr = 0 -> advance frame *only* when page is full according to ipltrowcol. multiadvfr = 1 -> advance frame with full page, *and* between plot types (maps, slices, xy plots) and ut's
Typically, multiadvfr=1. However, multiadvfr=0 is useful if a time series is desired, so the frame is not advanced between ut's.
Data type: Integer, single value.
Default: 1
Single integer flag which, if set = 1, requests multiple plots per frame, according to ipltrowcol. If multiplt = 0, only one plot will appear per frame and ipltrowcol is ignored.
Data type: Integer, single value.
Default: 0
See also: MULTIADVFR
Character variable specifying the type(s) of plot output desired. Maximum of two values: 'cgm' for metacode (ncar computer graphics metafile, (which may be viewed using ictrans or idt), and/or 'ps' for postscript. Both cgm and ps will work with monochrome and color fill plots. Also, multiple plots per frame will work (see multiplt). Either portrait or landscape modes may be chosen for ps (see psmode).
Data type: Character, with one or two values
Default: 'cgm'
Examples:
outplt = 'cgm','ps' ; make both ncgm and postscript output files
outplt = 'cgm' ; make ncgm metafile only
outplt = 'ps' ; make postscript only
See also: PSMODE, SENDPS, SENDCGM
Character variable specifying the mode for postscript plots. Valid values are 'port', for portrait mode, and 'land' for landscape mode. This parameter is ignored if outplt does not include ps.
Data type: Character, single value
Default: 'port'
Character variable specifying the machine:path address to which the cgm output metafile is to be sent. This may be either a directory path or a full path including file name. If it is a directory only, the file name will be "tgcmproc.cgm".
The metafile is sent to the given location by rcp (remote copy), from the executing machine. Therefore the user must insure that rcp is allowed between the executing machine and the machine specified in the sendcgm (i.e., .rhost files must have entries on both machines). Also make sure there is enough disk space available on the specified directory -- metafiles can get quite large (multiple megabytes) when many frames (say, over 100) are generated.
If there is a failure of the rcp to sendcgm, the plot file will be disposed to the mss, and the mss path used will be given in the output listing of the run. The rcp will fail if the remote machine is down, if permissions are not correct, if the directory does not exist, or if the network link between the two machines is down.
Sendcgm is ignored if outplt does not include 'cgm'. Also note that if both sendcgm and sendps are *not* given, plots will not be made (only ascii data file will be made, assuming senddat is provided).
Data type: Character, single value
Default: none
See also: SENDPS, SENDDAT, OUTPLT
Examples:
sendcgm = 'vishnu.hao:/d/foster/tgcmproc/tgcmproc_sut.cgm' ; full file path sendcgm = 'vishnu.hao:/d/foster/tgcmproc' ; dir
Character variable specifying the machine:path address to which the ascii data output file is to be sent. This may be either a directory path or a full path including file name. If it is a directory only, the file name will be "tgcmproc.dat". An ascii data file will *not* be generated if senddat is not given.
The data file is sent to the given location by rcp (remote copy), from the executing machine. Therefore the user must insure that rcp is allowed between the executing machine and the machine specified in the sendps (i.e., .rhost files must have entries on both machines). Also make sure there is enough disk space available on the specified directory.
If there is a failure of the rcp to senddat, the data file will be disposed to the mss, and the mss path used will be given in the output listing of the run. The rcp will fail if the remote machine is down, if permissions are not correct, if the directory does not exist, or if the network link between the two machines is down.
The basic format of the ascii data file is: for *each* *plot* produced, four 80-char header lines are appended to the file followed by the x and y coordinates values, followed by the data (with x varying first). The data is written with a 6e13.5 format statement. See hao ~foster/tgcmvis/pltdat for an example idl code that reads and plots from these data files.
If you are running the processor to get ascii output data only, you should *not* provide sendcgm or sendps. This way the processor will not produce graphics, saving probably 90% of the cpu time.
Data type: Character, single value
Default: none
See also: SENDCGM, SENDDAT, SENDDATMS
Examples:
senddat = 'vishnu.hao:/d/foster/tgcmproc/tgcmproc_sut.dat' ; full file path senddat = 'vishnu.hao:/d/foster/tgcmproc' ; dir
Character variable specifying an ncar mss path to which ascii data file is to be disposed (see senddat). If either or both of senddat and senddatms are set, an ascii data file will be written. Note subdirectories will be made recursively on the mss as needed, e.g., in the example below, the mss directory /FOSTER/tgcmproc need not pre-exist.
Data type: Character, single value
Default: none
See also: SENDCGM, SENDDAT, SENDPS
Example: senddatms = '/FOSTER/tgcmproc/tgcmproc.dat'
Character variable specifying the machine:path address to which the postscript output plot file is to be sent. This may be either a directory path or a full path including file name. If it is a directory only, the file name will be "tgcmproc.ps".
The metafile is sent to the given location by rcp (remote copy), from the executing machine. Therefore the user must insure that rcp is allowed between the executing machine and the machine specified in the sendps (i.e., .rhost files must have entries on both machines). Also make sure there is enough disk space available on the specified directory -- postscript files can get quite large (multiple megabytes) when many frames (say, over 100) are generated.
If there is a failure of the rcp to sendps, the plot file will be disposed to the mss, and the mss path used will be given in the output listing of the run. The rcp will fail if the remote machine is down, if permissions are not correct, if the directory does not exist, or if the network link between the two machines is down.
Sendps is ignored if outplt does not include 'ps'. Also note that if both sendcgm and sendps are *not* given, plots will not be made (only ascii data file will be made, assuming senddat is provided).
Data type: Character, single value
Default: none
See also: SENDCGM, SENDDAT, OUTPLT
Examples:
sendps = 'vishnu.hao:/d/foster/tgcmproc/tgcmproc_sut.ps' ; full file path sendps = 'vishnu.hao:/d/foster/tgcmproc' ; dir
Character variable specifying the machine:path address to which xdr output data file is to be sent. This may be either a directory path or a full path including file name. If it is a directory only, the file name will be "tgcmproc.xdr".
Xdr is "transparent data format", meaning is it machine transparent. Any machine that supports xdr can read these files which are written on the ncar cray's. These are binary files, and so are much smaller that the ascii data files (see senddat and senddatms).
The xdr files written by tgcmproc are readable by IDL. The following idl code fragment will read a frame from an xdr file written by tgcmproc, and create a frame structure:
frsize = 0
readu,lu,frsize
hdr1='' & hdr2='' & hdr3='' & hdr4=''
readu,lu,hdr1,hdr2,hdr3,hdr4
nx = 0 & xlab='' & readu,lu,nx,xlab
xx = fltarr(nx) & readu,lu,xx
ny = 0 & ylab='' & readu,lu,ny,ylab
yy = fltarr(ny) & readu,lu,yy
f = fltarr(nx,ny) & readu,lu,f
frame = { $
size:frsize, $ frame size (only a dummy as of 2/96)
hdr1:hdr1, $ 1st header line
hdr2:hdr2, $ 2nd header line
hdr3:hdr3, $ 3rd header line
hdr4:hdr4, $ 4th header line
nx:nx, $ number of x coords
xlab:xlab, $ x-axis label
xx:xx, $ x coords
ny:ny, $ number of y coords
ylab:ylab, $ y-axis label
yy:yy, $ y coords
f:f $ data
}
If all frames are the same size (same plot type from tgcmproc), subsequent reads can be simply "readu,lu,frame". Also note that you can use the idl function point_lun to point to the beginning of the desired frame. When all frame structures are the same size, this is effectively a random access file. However, idl does not allow use of the assoc function with xdr files.
As with senddat, if sendxdr is given, but sendcgm and sendps are not, the processor will not make plots at all, and will make only the output data files.
Data type: Character, single value
Default: none
See also: SENDCGM, SENDDAT, SENDPS
Examples:
sendxdr = 'vishnu.hao:/d/foster/tgcmproc/tgcmproc_sut.xdr' ; full file path sendxdr = 'vishnu.hao:/d/foster/tgcmproc' ; dir
Character variable specifying an ncar mss path to which xdr data file is to be disposed (see sendxdr). If either or both of sendxdr and sendxdrms are set, an xdr data file will be written. Note subdirectories will be made recursively on the mss as needed, e.g., in the example below, the mss directory /FOSTER/tgcmproc need not pre-exist.
Data type: Character, single value
Default: none
See also: SENDCGM, SENDDAT, SENDPS, SENDXDR
Example: sendxdrms = '/FOSTER/tgcmproc/tgcmproc.xdr'
Pairs of floats (up to 50 pairs) specifying the zp (or height), and the longitude (or local time), respectively, at which to contour ut vs latitude. If the first value of a pair is > 5 it is assumed to be a height, otherwise is a log pressure. The second of a pair may be 'LTxx', specifying local time xx instead of longitude (zonal means not available). This parameter ignored if ipltutlat=0.
Data type: Up to 50 pairs of floats
Example: utlat_zphtlon = 97.,'LT0.', -10.,180. In this example, plot first at 97 km and local time midnight, then zp -10 at longitude 180
Series of character variables (up to 50) of location names for each location given by utvert_locs. These are optional, but if given, there should be a name for each pair of utvert_locs (give a single blank for no name at a particular location). This parameter ignored if ipltutvert=0.
Data type: character variable (up to 50 names , each enclosed in quotes, and each with a maximum of 56 characters)
Examples:
utvert_locs = -140.,62.5, 41.9,-111.4 utvert_locname = 'POKER FLAT','BEAR LAKE'
See also: IPLTUTVERT, UTVERT_LOCS
Three floats specifying the vertical scale (km) for the y-axis of ut vs vertical contours (ipltutvert=1). The first two values are bottom and top of the desired scale, and the third value is the delta resolution (km). Model values are interpolated to the requested heights. This parameter ignored if ipltutvert=0.
Data type: Three floats.
Default: none
Example: utvert_htscale = 80.,120.,1. ; plot from 80 to 120 km, every 1 km
See also: IPLTUTVERT, UTVERT_ZPRANGE
Two floats specifying the vertical range (ln(p0/p)) for the y-axis of ut vs vertical contours (ipltutvert=1). The two values are bottom and top of the desired range, respectively. If the first value is less than (below) the bottom of the model, it will be raised to the bottom of the model. Likewise, if the second value given is greater than (above) the top of the model it will be lowered to the top. (e.g., flat_zprange = -100.,100. will be changed to the full vertical resolution of the current history). (note both flat_zprange and flat_htscale may be specified in the same run). Resolution (delta zp) will always be that of the model, i.e., 0.5. This parameter ignored if ipltutvert=0.
Data type: Two floats.
Default: The full pressure range of the current history (-7 to +5 for ti(e)gcm, -17 to +5 for uncoupled time-gcm)
See also: IPLTUTVERT, UTVERT_HTSCALE
Series (up to 50) of pairs of floats specifying lat,lon locations respectively for ut vs vertical contours (ipltutvert=1). Longitudes may be -180 to +180, or 'zm' for zonal means, or 'LTxx' for local time. See examples below. Latitude must be -90 to +90. Note nearest model grid points will be used, i.e., bilinear interpolation not available. For global means specify 'zm','zm'. This parameter ignored if ipltutvert = 0.
Data type: Series of float pairs (or special chars for second of each pair)
Default: none (ipltutvert turned off if no locations are given)
Examples:
xylocs = 67.5,-150. ; 67.5 latitude, -150 longitude
xylocs = 0.,'ZM', 'zm','zm' ; 0 latitude at zonal means, and global means
xylocs = 0.,'LT0.', -60.,'LT12.' ; 0 latitude at local midnight, and
Series (up to 50) of pairs of floats specifying lat,lon locations respectively for xy line plots (field on x-axis, zp or ht on y-axis). Longitudes may be -180 to +180, or 'zm' for zonal means, or 'LTxx' for local time. See examples below. Latitude must be -90 to +90. Note nearest model grid points will be used, i.e., bilinear interpolation not available. For global means specify 'zm','zm'. This parameter ignored if ipltxyloc = 0.
Data type: Series of float pairs (or special chars for second of each pair)
Default: none (ipltxyloc turned off if no locations are given)
Examples:
xylocs = 67.5,-150. ; 67.5 latitude, -150 longitude
xylocs = 0.,'ZM', 'zm','zm' ; 0 latitude at zonal means, and global means
xylocs = 0.,'LT0.', -60.,'LT12.' ; 0 latitude at local midnight, and
; -60 latitude at local noon
Two floats specifying the vertical range (ln(p0/p)) for the y-axis of xy vertical profiles (field on x-axis, zp or ht on y-axis). The two values are bottom and top of the desired range, respectively. If the first value is less than (below) the bottom of the model, it will be raised to the bottom of the model. Likewise, if the second value given is greater than (above) the top of the model it will be lowered to the top. (e.g., flat_zprange = -100.,100. will be changed to the full vertical pressure resolution of the current history). This parameter ignored if ipltxyloc=0. (note both flat_zprange and flat_htscale may be specified in the same run). Resolution (delta zp) will always be that of the model, i.e., 0.5. This parameter ignored if ipltlat=0.
Data type: Two floats.
Default: The full pressure range of the current history (-7 to +5 for ti(e)gcm, -17 to +5 for uncoupled time-gcm)
See also: IPLTXYLOC, XYLOC_HTSCALE
Three floats specifying the vertical scale (km) for the y-axis of xy vertical profiles (field on x-axis, zp or ht on y-axis). The first two values are bottom and top of the desired scale, and the third value is the delta resolution (km). Model values are interpolated to the requested heights. This parameter ignored if ipltxyloc=0.
Data type: Three floats.
Default: none
Example: xyloc_htscale = 80.,120.,1. ; plot from 80 to 120 km, every 1 km
See also: IPLTXYLOC, XYLOC_ZPRANGE
Series of character variables (up to 50) of location names for each location given by xylocs. These are optional, but if given, there should be a name for each pair of xylocs (give a single blank for no name at a particular location). This parameter ignored if ipltxyloc=0.
Data type: character variable (up to 50 names , each enclosed in quotes, and each with a maximum of 56 characters)
Example:
xylocs = -140.,62.5, 41.9,-111.4, 'zm','zm' xyloc_locname = 'POKER FLAT','BEAR LAKE', ' ' ; no name for global meansSee also: IPLTXYLOC, XYLOCS
Optional character variable (up to 80 chars) to be drawn as annotation at the top of all xy location line plots. This parameter ignored if ipltxyloc=0.
Data type character*80
Default: none
Series of pairs of floats (up to 50 pairs) giving latitude and longitude grid point locations at which to make xy plots with ut on x-axis, field on y-axis. Second of pair may be local time rather than longitude (see example below). This parameter ignored if ipltxyut=0.
Data type: Pairs of floats (second of pair may contain chars for local time)
Default: none
Example:
; plot first at 0 latitude and local midnight, then at 40 latitude, ; -105 longitude. xyut_locs = 0.,'LT0.', 40.,-105.
One or more (up to 50) real values giving selected log pressure (zp, i.e., alog(p0/p)) and/or height surfaces for ut vs field line plots. If a value is greater than 5., it is assumed to be a height surface (km), otherwise it is assumed to be a log pressure. If a given pressure value is below the bottom of the model, it is raised to the bottom (e.g., -99. would be raised to -17. for a standard time-gcm history, or to -7. for a ti(e)gcm history). Height and zp values may be mixed in xyut_zpht.
If model results are not available for a given height surface (e.g., 500km may be above the model at certain grid points), data is not plotted, and is given the special value 1.e36 in the ascii data output file. This parameter ignored if ipltxyut=0.
If ipltxyut=1 and xyut_zpht not given, height-integrated emissions fields (iemis and iemis_integ) may still be plotted, as well as doppler (idoppler) and/or oh-vib (ieohv) fields.
Data type: real, up to 50 values
Example:
xyut_zpht = -10.,-9.,-8.,-7.,-6. ; plot at given zp pressures xyut_zpht = 80.,85.,90.,95.,100. ; plot at given km heights xyut_zpht = -4., 100. ; plot at zp -4 and 100 km.
Related links:
Please send questions or comments to: foster@ucar.edu.
----------------------------------------------------------------------- Ben Foster High Altitude Observatory (HAO) foster@ncar.ucar.edu phone: 303-497-1595 fax: 303-497-1589 Nat. Center for Atmos. Res. P.O. Box 3000 Boulder CO 80307 USA -----------------------------------------------------------------------