;+
; Defines the SAGE II DMP structure using the IDL __define method.
;
; To use, put this procedure in your IDL_PATH. Then create the
; structure by executing
;
;    IDL> struct={sage2_dmp_data}
;
; which will create 1 structure. If you need an array of them, use
; replicate, as in
;
;   IDL> array_of_structs=replicate({sage2_dmp_data},100,200)
;
;  which will create a 100 by 200 array of SAGE II DMP structures.
;
;-

PRO sage2_dmp_data__define

   dmp = {sage2_dmp_data, $         ;; [1]
           sun_alt  : fltarr(110),$ ;; Altitude (km) - from SAGE_SUN files
           sun_lat  : fltarr(110),$ ;; N latitude - from SAGE_SUN files
           sun_lon  : fltarr(110),$ ;; E longitude - from SAGE_SUN files
           sun_dir  : fltarr(110),$ ;; in deg (cw from N) - from SAGE_SUN 
           Theta    : fltarr(110),$ ;; Potential Temperature (K)
           Temp     : fltarr(110),$ ;;  Temperature (K)
           DelHT    : fltarr(110),$ ;; magnitude of horizontal Temperature o
                                    ;; Gradient (K/km)
           LOSDelT  : fltarr(110),$ ;; T Gradient along Line-of-Sight (K/km)
           GeopHgt  : fltarr(110),$ ;; Geopotential Height (m)
           ZonWnd   : fltarr(110),$ ;; Analysis Zonal Wind (m/s)      [2] 
           MerWnd   : fltarr(110),$ ;; Analysis Meridional Wind (m/s) [2] 
           PV       : fltarr(110),$ ;; Analysis PV (1e-4 K m^2 (kg s)^-1)
           sPV      : fltarr(110),$ ;; ("scaled PV" (1e-4 1/s, "vorticity units")
           EqL      : fltarr(110),$ ;; Equivalent Latitude from PV 
           DelHPV   : fltarr(110),$ ;; magnitude of horizontal PV gradient
                                    ;; (normalized w/re average at theta level)
           LOSDelPV : fltarr(110),$ ;; PV gradient along Line-of-Sight
                                    ;; ((1e-4 K m^2 (kg s)^-1)/km)

          ;; The following 3 fields are in deg of Equivalent Latitude

           EqL_VEC  : fltarr(110),$ ;Distance from vortex edge center [2]
           EqL_VEI  : fltarr(110),$ ;Distance from inner vortex edge
           EqL_VEO  : fltarr(110),$ ;Distance  outer vortex edge
           DynTropo : 0.0,$     ;Dynamical tropopause altitude (km)   [4]
           TmpTropo : 0.0 }     ;WMO tropopause altitude (km)         [5]


;
; [1] Bad data is signified with a -999
;
; [2] Winds from NCEP/CPC analyses are "balance" winds (Randel, 1987,
;     JAS, 44, 2179--2186).
;
; [3] For the Vortex Edge Criteria fields (EqL_{VEC,VEI,VEO}) a value
;     of 500 is given when the input data are good, but the vortex is
;     not defined in that hemisphere at that potential temperature.
;
; [4] Dynamical tropopause - PV = 3.5x10e-6 K m^2 (kg s)^-1, 380K
;     in tropics (+/-20deg) if value from PV is at pressure less than 65hPa.
;
; [5] WMO Tropopause definition - lowest altitude where dT/dz < 2 K/km
;     and remains less then 2 K/km for at least 2 km above.

  RETURN
END 

;+
;@file_comments
; <pre>
; NAME:  
; $Id: sage2_dmp_data__define.pro,v 1.2 2007/02/07 18:53:00 whdaffer Exp $
; PURPOSE:   Define a structure useful in reading SAGE II DMP data
;
; AUTHOR:  William H. Daffer
;          818-354-4007
;          William.Daffer@jpl.nasa.gov
;
; </pre>
;-
; MODIFICATION HISTORY:
;
; $Log: sage2_dmp_data__define.pro,v $
; Revision 1.2  2007/02/07 18:53:00  whdaffer
; Cleanup documentation
;
; Revision 1.1  2007/02/07 15:56:03  whdaffer
; Initial rev (DMP struct definer)
;
;
;
;Copyright 2007, by the California Institute of Technology.
;ALL RIGHTS RESERVED.  United States Government Sponsorship
;acknowledged.  Any commercial use must be negotiated with the Office
;of Technology Transfer at the California Institute of Technology.
;
;This software may be subject to U.S.  export control laws and
;regulations.  By accepting this document, the user agrees to comply
;with all applicable U.S.  export laws and regulations.  User has the
;responsibility to obtain export licenses, or other export authority as
;may be required before exporting such information to foreign countries
;or providing access to foreign persons.
;
;