trend

- 4

Trapped Radiation ENvironment model Development

UC190

[ Name | Synopsis | Arguments | Description | Dependencies | See Also | Examples ]

Name

    Common block UC190 - control parameters, set 1

Synopsis

      INCLUDE 'structure.h'
      
      COMMON /UC190/ prop, stepx, stpmin, umsq, upsq, uk2, uk3, 
                     epskm, epsrel, stplst, xclat, kmflg, kum533       

      REAL*8         prop, stepx, stpmin
      REAL*8         umsq, upsq, uk2, uk3
      REAL*8         epskm, epsrel, stplst, xclat
      INTEGER*4      kmflg, kum533      

Arguments

    prop
    Proportionality factor between the radius of curvature and the step size
    stepx
    Maximum step size
    stpmin
    Minimum step size
    umsq, upsq, uk2, uk3
    Constants used in Runge-Kutta calculation
    epskm
    Altitude precision
    epsrel
    Relative magnetic field precision
    stplst
    Step size near a point of interest
    xclat
    Not used
    kmflg
    Flag for UL240 (see table below)
    kum533
    Flag for UM533

Description

    The common blocks UC190 and UC192 are used to specify parameters which control the execution of the UNILIB libray. The arguments of common block UC190 are more specific to the tracing of magnetic field line segment by the Runge-Kutta algorithm. The arguments of both common blocks are initialized by the subroutine ut990.htm.

    The table below describes the use of the kmflg argument.


    kmflg value
    0,10The magnetic dipole moment defined by McIlwain is used, e.g. to compute Hilton's function.
    1,11The magnetic dipole moment of the current magnetic field model is used, e.g. to compute Hilton's function.
    0,1 To evaluate the equatorial pitch angle, the lowest magnetic field intensity on a field line segment is defined by B0= M/L3 where M is the magnetic dipole moment.
    10,11The equatorial pitch angle is evaluated with the help of the lowest magnetic field intensity encountered along the current field line segment.

History

    In version 1.10 and earlier, the argument nxstp was defined in the common block UC190 instead of the argument kum533. The argument nxstp was used to control the maximum number of steps allowed during the tracing of a field line segment. The value of the maximum step number is now only fixed by the value of parameter nx170.

Dependencies

Used by

    UL225 (evaluate invariant radius and latitude):
    kmflg
    UL220 (get information on a magnetic field line segment):
    epsrel
    UL230 (evaluate the integral invariant coordinate I ):
    umsq, upsq and epsrel
    UL240 (evaluate the Hilton's function):
    kmflg
    UL242 (inverse the Hilton function):
    kmflg
    UL245 (equatorial pitch angle):
    kmflg
    UD319 (transfer a field line segment from common block UC170 to UC130):
    epsrel
    UD330 (evaluate the third invariant):
    kmflg
    UD332 (evaluate the magnetic flux through a spherical pie):
    epskm
    UF410 (search the geographic position of a magnetic field line):
    epskm
    UF411 (search a local magnetic equator):
    epskm
    UF415 (rebuild the labels of the field line):
    epsrel
    UF420 (trace a magnetic field line segment passing through a given position):
    epskm and epsrel
    UF422 (follow a field line until a boundary condition is reached):
    prop, stepx, stpmin, epskm, epsrel and stplst
    UF423 (Runge Kutta step):
    prop, stepx, stpmin, umsq and upsq
    UF426 (interpolating an extremum of B):
    prop, stepx, stpmin, epskm and stplst
    UF427 (interpolating a value of B):
    prop, stepx, stpmin, epsrel and stplst
    UF428 (interpolating an altitude):
    prop, stepx, stpmin, epskm and stplst
    UF429 (transpose a field line segment):
    uk2 and uk3
    UM533 (distance to the magnetopause):
    kum533
    UT986 (pass general variables to IDL):
    kmflg

Modified by

    UT990 (initialize the UNILIB libray):
    prop, stepx, stpmin, umsq, upsq, uk2, uk3, epskm, epsrel, stplst, kmflg and kum533

See also

    UC192, control parameters, set 2

Examples

    None