external/IDL_GEOPACK/t04s/
tt04s.pro
Procedure: tt04s Purpose: tplot wrapper for the functional interface to the IDL Geopack implementation of the Tsyganenko-Sitnov (2004) storm-time geomagnetic field model. Input: pos_gsm_tvar: the tplot variable storing the position in gsm coordinates Keywords: pdyn(optional): Solar wind pressure(nanoPascals) should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar dsti(optional): DST index(nanoTeslas) should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar yimf(optional): y component of the interplanetary magnetic field should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar zimf(optional): z component of the interplanetary magnetic field should either be a string naming a tplot variable or an array or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w1(optional): time integral from the beginning of a storm can be an array or a tplot variable(see paper reference below for definitions of w1-w6) or a single value. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w2(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w3(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w4(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w5(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar w6(optional): time integral from the beginning of a storm can be an array or a tplot variable or a single value If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar; parmod(optional): can input the Nx10 parmod array used by the fortran Tsyganenko model instead of inputing parameters as separate arrays. If passed as a raw array it will not be modified or interpolated so be sure its has the correct number of entries. It can also be passed as a tplot variable name in which case it will be interpolated. If values are passed individually and as par, the par values will be overwritten. period(optional): the amount of time between recalculations of geodipole tilt in seconds(default: 60) increase this value to decrease run time get_nperiod(optional): Return the number of periods used in the time interval newname(optional):the name of the output variable. (default: pos_gsm_tvar+'_bt04s') This option is ignored if globbing is used. error(optional): named variable in which to return the error state of this procedure call. 1 = success, 0 = failure get_tilt(optional): Set this value to a tplot variable name in which the geodipole tilt for each period will be returned One sample will be returned for each period with time at the center of the period. set_tilt(optional): Set this to a tplot variable name or an array of values containing the dipole tilt that should be used. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar add_tilt(optional): Set this to a tplot variable name or an array of values containing the values to be added to the dipole tilt that should be used for each period. If a tplot input is used it will be interpolated to match the time inputs from the position var. Non-tplot array values must match the number of times in the tplot input for pos_gsm_tvar geopack_2008 (optional): Set this keyword to use the latest version (2008) of the Geopack library. Version 9.2 of the IDL Geopack DLM is required for this keyword to work. Output: Stores the result of the field model calculations in tplot variables Notes: 1. converts from normal gsm to rgsm by dividing vectors by earth's radius(6374 km) ie inputs should be in km 2. Input must be in GSM coordinates 3. Haje Korth's IDL/Geopack DLM must be installed for this procedure to work 4. either the variables setting parmod or the variables setting the individual parameter arrays should be set because the defaults aren't scientifically accurate 5. model parameters that are input as tplot variables they will be interpolated to match the time values on the input position 6.Find more documentation on the inner workings of the model, any gotchas, and the meaning of the arguments at: http://geo.phys.spbu.ru/~tsyganenko/modeling.html -or- http://ampere.jhuapl.edu/code/idl_geopack.html 7. Definition of W1-W6 can be found at: N. A. Tsyganenko and M. I. Sitnov, Modeling the dynamics of the inner magnetosphere during strong geomagnetic storms, J. Geophys. Res., v. 110 (A3), A03208, doi: 10.1029/2004JA010798, 2005 $LastChangedBy: egrimes $ $LastChangedDate: 2014-03-18 13:03:40 -0700 (Tue, 18 Mar 2014) $ $LastChangedRevision: 14577 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/external/IDL_GEOPACK/t04s/tt04s.pro $
Routines
top source tt04s
tt04s, pos_gsm_tvar, pdyn=pdyn, dsti=dsti, yimf=yimf, zimf=zimf, w1=w1, w2=w2, w3=w3, w4=w4, w5=w5, w6=w6, parmod=parmod, period=period, get_nperiod=get_nperiod, newname=newname, error=error, get_tilt=get_tilt, set_tilt=set_tilt, add_tilt=add_tilt, geopack_2008=geopack_2008
Parameters
- pos_gsm_tvar
Keywords
- pdyn
- dsti
- yimf
- zimf
- w1
- w2
- w3
- w4
- w5
- w6
- parmod
- period
- get_nperiod
- newname
- error
- get_tilt
- set_tilt
- add_tilt
- geopack_2008
File attributes
Modification date: | Thu Apr 10 11:53:04 2014 |
Lines: | 155 |