European Space Agency

European Space Agency

Royal Belgian Institute for Aeronomy

Royal Belgian Institute for Aeronomy

../_images/whiteSpace.png

ut985 - transfer a field line of the drift shell to IDL

subroutine  ut985(kindex, klength, mdata)
Parameters:

  • kindex [integer4,in] :: Field line segment index.

  • klength [integer4,in/out] :: Number of elementary segments

  • mdata (*) [zseg,out] :: Field line segment description

Description

The subroutine ut985() provides a bridge to transfer magnetic field line segment from the UNILIB library to an IDL programme. The behaviour of the subroutine is function of the argument kindex.

when kindex=0, the magnetic field line segment stored in the common block uc170 is copied in argument mdata; otherwise, one of the magnetic field line segments stored in the common blocks uc110, uc120 and uc130 is copied in argument mdata.

To transfer a whole drift shell, the subroutine ut985() has to be called as many times as the number of magnetic field line segments included in the shell. When kindex=-1, the first field line segment of the drift shell is transfered. As output, the argument kindex returns the index of the next field line segment in the drift shell.

As input, the argument klength has to be set to the number of elements available in argument mdata. When the field line segment contains a number of elementary segments larger than klength, the argument klength is set to this minimum and no data is assigned to argument mdata. Otherwize the argument klength is returned with the exact number of elementary segments and the magnetic field line segments are copied into argument mdata.

References

History

Diagnostics

  • When an error occurs in subroutine ut985(), the value -999999999 is assigned to argument klength.

Common Blocks

Dependencies

Called by

None

Calls

None

See also

None

Reported Bugs

  • v1.05, Malfunction when field line extended to foot points; fixed in next versions

Examples

UNILIB/tags/v3.02