Commit 078e7658a735ea2deabee8601a905287f57712fb

Authored by Elena.Budnik
1 parent 480b6504

functions.xml fairfield

Showing 1 changed file with 15 additions and 27 deletions   Show diff stats
generic_data/Functions/functions.xml
... ... @@ -79,17 +79,17 @@
79 79  
80 80 <function name="shiftT_(,)" args="1" kind="amda">
81 81 <prompt>input time interval T in secs to delay by</prompt>
82   - <info_brief>Delays array by T secs back (T &lt; 0) and forth (T &gt; 0))</info_brief>
  82 + <info_brief>Shifts parameter by T secs back (T &lt; 0) and forth (T &gt; 0))</info_brief>
83 83 <new_kernel>#timeShift</new_kernel>
84 84 </function>
85 85  
86   - <function name="Valfven(,)" params="2" kind="physics">
  86 + <function name="vAlfven(,)" params="2" kind="physics">
87 87 <prompt>Alfven velocity Valfven(density[cm^⁻3], mag[nT])</prompt>
88 88 <info_brief>Alfven velocity Valfven(density[cm^⁻3], mag[nT])</info_brief>
89 89 <new_kernel>alfvenVelocity</new_kernel>
90 90 </function>
91 91  
92   - <function name="perreault78()" params="3" kind="physics">
  92 + <function name="perreault78(,,)" params="3" kind="physics">
93 93 <info_brief>Perreault and Akasofu 1978 model u = perreault78(E_mag, B_mag, theta_p)</info_brief>
94 94 <new_kernel>perreault78</new_kernel>
95 95 </function>
... ... @@ -98,26 +98,20 @@
98 98 <info_brief>NEWELL et al 2007 solar wind-magnetosphere coupling function d_phi/d_t = newell2007(mu, B_mag, theta) </info_brief>
99 99 <new_kernel>newell2007</new_kernel>
100 100 </function>
101   -
  101 +
  102 + <!--<function name="fairfield70(,tilt_angle_60)" params="2" kind="physics">-->
102 103 <function name="fairfield70(,)" params="2" kind="physics">
103   - <prompt>FAIRFIELD 1970 model of neutral sheet position Z = fairfield70(xyz_sm, x_ss)
104   - where y_sm and z_sm are the solar magnetospheric coordinates of the spacecraft
105   - and x_ss is tilt angle</prompt>
106   -
107   - <info_brief>FAIRFIELD 1970 model of neutral sheet position Z = fairfield70(xyz_sm, x_ss)
108   - where y_sm and z_sm are the solar magnetospheric coordinates of the spacecraft
109   - and x_ss is tilt angle</info_brief>
  104 + <prompt>xyz_sm in Re and dipole tilt angle in degrees</prompt>
  105 + <info_brief>Distance (Re) from s/c location to Fairfield1970 model neutral sheet position.&lt;br/&gt;
  106 + dZ = fairfield70(xyz_sm, tilt_angle),&lt;br/&gt; xyz_sm is the s/c SM coordinates (Re) and tilt angle is in degrees.&lt;br/&gt; Valid for y_sm &lt; 15 Re.</info_brief>
110 107 <new_kernel>fairfield70</new_kernel>
111 108 </function>
112 109  
113 110 <function name="fairfield80(,)" params="2" kind="physics">
114   - <prompt>FAIRFIELD 1980 model of neutral sheet position Z = fairfield80(xyz_sm, x_ss)
115   - where xyz_sm are the solar magnetospheric coordinates of the spacecraft
116   - and x_ss is tilt angle</prompt>
  111 + <prompt>xyz_sm in Re and dipole tilt angle in degrees</prompt>
117 112  
118   - <info_brief>FAIRFIELD 1980 model of neutral sheet position Z = fairfield80(xyz_sm, x_ss)
119   - where xyz_sm are the solar magnetospheric coordinates of the spacecraft
120   - and x_ss is tilt angle</info_brief>
  113 + <info_brief>Distance (Re) from s/c location to Fairfield1980 model neutral sheet position.&lt;br/&gt;
  114 + dZ = fairfield80(xyz_sm, tilt_angle),&lt;br/&gt; xyz_sm is the s/c SM coordinates (Re) and tilt angle is in degrees.&lt;br/&gt;</info_brief>
121 115 <new_kernel>fairfield80</new_kernel>
122 116 </function>
123 117  
... ... @@ -134,17 +128,11 @@
134 128 </info_brief>
135 129 <new_kernel>lopez90</new_kernel>
136 130 </function>
137   -
138   - <!--<function name="gsegsm_()" argv="vector" kind="amda">
139   - <prompt/>
140   - <info_brief>GSE to GSM transformation</info_brief>
141   - <new_kernel>#framesTransformation</new_kernel>
142   - </function>
143   - <function name="gsesm_()" argv="vector" kind="amda">
144   - <prompt/>
145   - <info_brief>GSE to SM transformation</info_brief>
  131 + <!--<function name="frameTransformation(,,)" args="2" kind="vectors">
  132 + <prompt>FROM, TO</prompt>
  133 + <info_brief>frame transformation</info_brief>
  134 + <new_kernel>#framesTransformation</new_kernel>
146 135 </function>-->
147   -
148 136 <function name="angle(,)" params="2" kind="vectors">
149 137 <info_brief>Angle between two vectors</info_brief>
150 138 <new_kernel>angle</new_kernel>
... ...