CALL SEQUENCE... pgen XIN POUT [LNSP] OUTPUT \ [-kind VAL0 -a VAL1 -d VAL2 -i VAL3 [VAL4] -def [AABB] ] DESCRIPTION... pgen - CREATES A FILE WITH VALUES SET EQUAL TO PRESSURE LEVEL AUTHOR - B.Dugas, NOV 29/83. LAST REVISION: $Header: Implementer-les-comdecks-toc_gest_formats-et-set_a_b_formats @ 2019-01-12 16:31:28 -0500 (dugas) $ PURPOSE - GENERATES A FILE WHOSE VALUES ARE SET TO THE PRESSURE LEVEL VALUE FOUND IN IBUF(4). NOTES 1) FOR SPECTRAL TYPE FILES, ONLY THE REAL PART OF THE (0,0) COEFFICIENT RECORD VALUES IS SET. 2) FOR CMPL TYPE FILES, ONLY THE REAL PART OF EACH WORD IS SET. INPUT FILE... XIN = FILE CONTAINING RECORDS AT PRESSURE LEVEL(S), IT CAN BE OF TYPE SPECTRAL, ZONAL CROSS-SECTIONS, COMPLEX ARRAYS OR GAUSSIAN GRID(S). LNSP = (OPTIONAL) LOG OF SURFACE PRESSURE FIELD USED BY THE TERRAIN FOLLOWING COORDINATES TO DETERMINE THE LOCAL PRESSURE. THIS IS ASSUMED TO BE IN UNITS OF LN(MB). OUTPUT FILE... POUT = FILE OF THE SAME TYPE AS XIN WITH THE VALUE(S) OF EACH RECORD SET EQUAL TO THE LOCAL PRESSURE VALUES (IN MB). THIS DATA IS FOUND IN IBUF(4) WHEN THE VERTICAL COORDINATE IS ITSELF PRESSURE. COMMAND-LINE PARAMETERS... COORD (kind) = INPUT VERTICAL COORDINATE: THE POSSIBLE OPTIONS ARE 'PRES'/'ETA' FOR PRESSURE/GCM-ETA AND 'GEM'/'GEM2'/'GEM3' /'GEM4' FOR DIFFERENT VERSIONS OF THE GEM COORDINATE. PTOIT (a) = PRESSURE (PA) AT THE LID OF MODEL. THE DEFAULT VALUE IS 0.01 OTHERWISE. THIS VALUE IS ONLY REQUIRED WITH THE CCCma GCM VERTICAL COORDINATES. The next parametres are only used when COORD='GEMx', x=2,3 or 4. PREF (d) = Ref pressure (DEF 80000 PA, except for 'GEM4', where the only acceptable value is 100000 Pa). R (i) = Reference exponent (DEF 1.0) R2 (i2) = Second reference exponent if COORD='GEM4' (DEF 1.0) NOTES: 1) THE PROGRAM REQUIRES THAT DATA TYPES BE EITHER OF 'GRID', 'SUBA' OR 'ZONL' WHEN OPERATING WITH ANY OF THE TERRAIN FOLLOWING VERTICAL COORDINATES. THE OTHER TYPES OF DATA ARE ONLY SUPPORTED WITH PRESSURE VERTICAL COORDINATES. 2) 'GEM' IS THE ORIGINAL GEM ETA COORDINATE, WHILE 'GEM2' IS THE FIRST GEM HYBRID COORDINATE AS IMPLEMENTED BY EDOUARD & GRAVEL IN GEM/DM V2.2.0. 'GEM3' IS THE NORMALIZED VERSION THAT WAS IMPLEMENTED IN THE V2.3.1 GEM/DM.'GEM4' is the staggered hybrid coordinate version of GEM/DM from v4.0.6. 3) THE DEFAULT VALUE OF COORD IS DETERMINED BY THE FILE TYPE AND THE PROGRAM WILL ALSO TRY TO DETERMINE IT BY THE (INTERNAL) CODING USED FOR THE COORDINATE ITSELF. 4) Specifying "-def AABB" will force the attempt to read a text file called aabb.nml, containing a FORTRAN namelist AABB_NML, which in turns will hold two arrays, A and B such that the local pressure at level K, PL(K), can be calculated as "A(K)+B(K)*PS" for most coordinates. For 'GEM4', the corresponding formula to calculate the K-level natural logaritm of the local pressure is rather "A(K)+B(K)*LN(PS/PREF)". The A and B terms should be such as to produce local pressures in Pa units, even though PS is usually read in units of hPa (before being converted to Pa units internally). In all cases, this approach then by-passes the normal COORD-related calculations for PL(K). ************* Given the above, correctly using the AABB option with a GEM4 file requires specifying the "-kind GEM4" argument. ************* EXIT CONDITIONS... 0 NO PROBLEMS 1 UNABLE TO READ XIN 2 MORE THAN ONE SIZE IN XIN 3 UNKNOWN DATA TYPE 4 ILLEGAL "COORD" VALUE 5 LNSP FILE MISSING OR EMPTY 6 LNSP AND XIN NOT THE SAME SIZE 7 UNABLE TO CONTINUE (SEE NOTE 1) 8 PROBLEM READING PARAMETRES 12 LNSP DOES NOT CONTAIN LN(SURFACE PRESSURES) FOR EARTH 16 UNSUPPORTED VERTICAL COORDINATE IN XIN 18 UNABLE TO FIND A GEM4 '!!' RECORD 19 UNABLE TO ALLOCATE WORKING MEMORY 20 UNABLE TO READ AABB NAMELIST 21 MORE THAN ONE VERTICAL COORDINATE IN XIN 22 WRONG NUMBER OF A,B IN AABB