trend

- 4

Trapped Radiation ENvironment model Development

structure.h

[ Name | Synopsis | Description | Definitions | See Also | Examples ]

Name

    Include file structure.h - structure definition

Synopsis

      INCLUDE 'structure.h'

Description

    Normally, the file structure.h should be included in each FORTRAN program or subroutine that uses the UNILIB libray. The file contains a IMPLICIT NONE statement, a list of structure definitions and the definitions of some global parameters. The global parameters are listed in the table below.

    ParameterDescription
    nx120 Size of the common block UC120 that determines the maximum number of magnetic field lines used to describe a magnetic drift shell
    nx130 Size of the common block UC130 that determines the maximum number of stored points for a magnetic drift shell
    nx140 Maximum size for the spherical harmonic expansion of the geomagnetic field model, used in the definition of the structure /zimf/
    nx170 Size of the common block UC170 that determines the maximum number of geographic locations used to describe a magnetic field line segments

    In the next section, the different structure used in the UNILIB library are described. When declaring a structure without the help of the file structure.h, be aware to check the order of the variable list.

Definitions

[ zatm | zdat | zemf | zfln | zgeo | zimf | zind | zlbl | zpnt | zseg | zsun | zvec | zxyz ]

Structure /zatm/, refer to an atmospheric model

    INTEGER*4 KATM
  • Number of the atmospheric model
    INTEGER*4 KION
  • Number of the ionospheric and/or plasmaspheric model
    INTEGER*4 KYEAR, KDAY
  • Year and day of the year
    REAL*8 UT
  • Universal Time in degrees
    REAL*8 RZSS
  • Sun spots number
    REAL*8 F107A, F107
  • 81-Day average of the radio flux F10.7 and daily radio flux F10.7 of the previous day
    REAL*8 APIND(7)
  • 3-Hour Ap index for different times, see table below
    REAL*8 FKPX
  • Maximum value of the 3-hour Kp index

    Index in APINDDescription
    1Daily Ap index
    23-Hour Ap index for the current time
    33-Hour Ap index for the third hour before the current time
    43-Hour Ap index for the sixth hour before the current time
    53-Hour Ap index for the ninth hour before the current time
    624-Hour average of the 3-hour Ap index from the 12th to the 35th hour prior to the current time
    724-Hour average of the 3-hour Ap index from the 36th to the 59th hour prior to the current time

Structure /zdat/, refer to a date and time

    INTEGER*4 IYEAR, IMONTH, IDAY
  • Date, e.g. 1 January 1995 is coded 1995, 1, 1
    INTEGER*4 IHOUR, IMIN
    REAL*8 SECS
  • Time
    REAL*8 AMJD
  • Modified Julian Day based on the 1st of January 1950, see UT540

Structure /zemf/, refer to an external magnetic field model

    CHARACTER*20 LABEL
  • Name of the model
    INTEGER*4 KOUTER
  • Number of the model
    REAL*8 VDST
  • Value of the storm activity index Dst in nT
    REAL*8 WDENS, WVEL
  • Value of the solar wind density and velocity in cm-3 and km/s, respectively
    REAL*8 VKP
  • Value of the planetary activity index Kp
    REAL*8 PDYN
  • Solar wind pressure (nanoPascal)
    REAL*8 BXIMF, BYIMF, BZIMF
  • Components of the interplanetary magnetic field (nanotesla)
    REAL*8 STDOFF
  • Standoff distance to the subsolar point
    INTEGER*4 IKP
  • Internal parameter based on VKP, see UM521
    CHARACTER*4 LBLTNS
  • Coordinate system on which the model is based, e.g. 'SM' or 'GSM'
    REAL*8 TRANS(3,3)
  • Transformation array from GEO to the LBLTNS coordinate system
    REAL*8 TILT
  • Magnetic dipole tilt angle in degrees
Warning
    The arguments PDYN, BXIMF, BYIMF, BZIMF and STDOFF were not present in version 1.06 and earlier.

Structure /zfln/, refer to the description of a magnetic field line segment

    RECORD/ZPNT/ EQUAT
  • Geographic point which corresponds to the lowest magnetic field intensity along the field line
    RECORD/ZGEO/ FOOTPN
  • Geographic position of the northern foot point of the magnetic field line
    RECORD/ZGEO/ FOOTPS
  • Geographic position of the southern foot point of the magnetic field line
    RECORD/ZVEC/ DRIFT
  • Vector proportional to the drift velocity evaluated at the point EQUAT
    REAL*8 DTDFT
  • Value proportional to the time need by a particle to drift to the next field line segment
    INTEGER*4 KWEST
  • Index of the western previous magnetic field line segment of the drift shell
    INTEGER*4 KEAST
  • Index of the eastern next magnetic field line segment of the drift shell
    RECORD/ZIND/ IND
  • Indices of the magnetic field line segment

Structure /zgeo/, refer to a geographic location

    REAL*8 RADIUS
  • Geocentric radius in km
    REAL*8 COLAT
  • Value of the co-latitude (90o - latitude) in degrees
    REAL*8 ELONG
  • Value of the longitude in degrees
  • When the structure /zgeo/ refers to geodetic coordinates (e.g. in subroutine UM535), the argument RADIUS corresponds to the geodetic altitude incremented by the mean Earth's radius (stored in the argument RE of the common block UC160 and equal to 6371.2 km).

Structure /zimf/, refer to a geomagnetic field model

    CHARACTER*32 LABEL
  • Name of the geomagnetic field model
    INTEGER*4 KINNER
  • Number of the geomagnetic field model
    INTEGER*4 NORDER
  • Order of the spherical harmonic expansion increased by one
    REAL*8 COEF(nx140,nx140)
  • Spherical harmonic expansion coefficients (nx140 = 16)
    REAL*8 COLAT
  • Co-latitude of the boreal dipole pole, in degrees
    REAL*8 ELONG
  • East longitude of the boreal dipole pole, in degrees
    REAL*8 GMMO
  • Moment of the magnetic dipole, in Gauss Re3
    REAL*8 TZERO
  • Base epoch of the model
    REAL*8 EPOCH
  • Epoch of the geomagnetic field evaluation, in years
    REAL*8 SAAROT
  • Longitude correction for the secular drift of the South Atlantic Anomaly, in degrees

Structure /zind/, refer to pointers into an array of structure zseg

    INTEGER*4 JBEG
  • Index of the first element of the field line segment
    INTEGER*4 JEND
  • Index of the last element of the field line segment
    INTEGER*4 JMIRPN
  • Index of the northern mirror point
    INTEGER*4 JMIRPS
  • Index of the southern mirror point

Structure /zlbl/, refer to a magnetic drift shell

    CHARACTER*1 LABEL
  • User's label of the drift shell
    LOGICAL*1 LINV, LBMP, LKAUF, LLMI, LALP0, LPHI, LTIM
  • Booleans which validate FINV, FBMP, FKAUF, FLMI, FALP0, FPHI, FTIM
    REAL*8 FINV
  • Value of the integral invariant I
    REAL*8 FBMP
  • Value of the magnetic field intensity at the mirror points
    REAL*8 FKAUF
  • Value of the Kaufmann's adiabatic invariant K
    REAL*8 FLMI
  • Value of the McIlwain parameter L
    REAL*8 FALP0
  • Value of the equatorial pitch angle
    REAL*8 FPHI
  • Value of the third adiabatic invariant
    REAL*8 FTIM
  • Not defined

Structure /zpnt/, refer to a location on a magnetic field line

    RECORD/ZGEO/ COORD
  • Geographic position of the point
    RECORD/ZVEC/ B
  • Magnetic field vector at the point
    REAL*8 RCURV
  • Radius of curvature of the magnetic field line at the point

Structure /zseg/, refer to an elementary segment of a magnetic field line segment

    RECORD/ZPNT/ BEG
  • Start location of the segment
    REAL*8 ARCL
  • Arc length along the field line
    REAL*8 CSALP
  • Cosine of the local pitch-angle
    REAL*8 DTBND
  • Not defined
    REAL*8 RKSTP(3)
  • Intermediate values of the magnetic field intensity obtained during the Runge-Kutta integration

Structure /zsun/, refer to the Sun location

    REAL*8 UTDEG
  • Universal Time in degrees
    REAL*8 GHA
  • Greenwich angle of equinox in degrees
    RECORD/ZXYZ/ DIR
  • Cartesian GEO direction of the Sun, normalized to unity

Structure /zvec/, refer to the spherical components of a vector

    REAL*8 DNRM
  • Norm of the vector
    REAL*8 RHO
  • Radial component
    REAL*8 THETA
  • Component along the co-latitude
    REAL*8 PHI
  • Component along the longitude
Note
    Both values of DNRM, RHO, THETA and PHI are expressed in the same units. For example, they are all given in Gauss when they are used to characterize the magnetic field vector.

Structure /zxyz/, refer to the cartesian components of a vector or to cartesian coordinates

    REAL*8 X, Y, Z
  • Values of the cartesian coordinates

See also

    UC110, magnetic drift shell description
    UC120, magnetic field line description
    UC120, set of magnetic field line segments
    UC140, magnetic field description
    UC150, atmospheric model description
    UC170, temporary magnetic field line

Examples

    None