hfpytrace.model.dispersion¶
Package
Vectorized magneto-ionic dispersion formulations for refractive index, absorption, and phase metrics.
Key Classes¶
Class AppletonHartreeDispersion
Class SenWyllerDispersion
Class DispersionResult
Key Methods¶
Method refractive_index()
Method evaluate()
API¶
hfpytrace.model.dispersion
¶
Dispersion relations for magneto-ionic refractive index and absorption.
This module implements two formulations:
- Appleton-Hartree
- Sen-Wyller
Both formulations are designed for fully broadcasted NumPy workflows, so all input fields may be scalar, 1D, 2D, or 3D (or any broadcast-compatible shape).
DispersionResult
dataclass
¶
Container for derived propagation metrics.
Attributes¶
np.ndarray
Complex refractive index (same shape as broadcasted input fields).
np.ndarray
Absorption coefficient in dB/km.
np.ndarray
Phase constant in rad/km.
np.ndarray
Phase constant in deg/km.
Source code in hfpytrace/model/dispersion.py
DispersionBase
¶
Base utilities shared by dispersion formulations.
Parameters¶
float
Wave frequency in Hz.
array_like
Electron density in m^-3.
array_like
Effective collision frequency in Hz.
array_like, optional
Magnetic field magnitude in Tesla.
array_like, optional
Angle between propagation direction and magnetic field (deg).
te_k, ti_k, tn_k : array_like, optional Electron, ion, and neutral temperatures (K). These are accepted as metadata inputs for downstream/extended models.
Notes¶
All array-like parameters can be scalars or N-D arrays. They are broadcast internally to a common shape before evaluation.
Source code in hfpytrace/model/dispersion.py
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | |
omega: float
property
¶
Angular frequency omega = 2pif [rad/s].
k0: float
property
¶
Vacuum wavenumber k0 = omega/c [rad/m].
refractive_index(mode='O')
¶
evaluate(mode='O')
¶
Evaluate refractive index and derived absorption/phase products.
Parameters¶
str, optional
Propagation mode selector. Supported values depend on subclass.
Returns¶
DispersionResult Complex refractive index plus absorption and phase metrics.
Source code in hfpytrace/model/dispersion.py
AppletonHartreeDispersion
¶
Bases: DispersionBase
Appleton-Hartree style magneto-ionic formulation.
Supported modes¶
- "N"/"NO"/"ISO": isotropic-like branch
- "O": ordinary
- "X": extraordinary
- "R": right-hand circular
- "L": left-hand circular
Source code in hfpytrace/model/dispersion.py
refractive_index(mode='O')
¶
Compute Appleton-Hartree refractive index for the selected mode.
Source code in hfpytrace/model/dispersion.py
SenWyllerDispersion
¶
Bases: DispersionBase
Sen-Wyller generalized formulation.
Notes¶
This implementation follows the structure used in the existing project
absorption workflow and evaluates C(p,y) numerically with scipy.integrate.quad.
Source code in hfpytrace/model/dispersion.py
refractive_index(mode='O')
¶
Compute Sen-Wyller refractive index for the selected mode.
Supported modes: "N"/"NO"/"ISO", "O", "X", "R", "L".
Source code in hfpytrace/model/dispersion.py
Source Code¶
| hfpytrace/model/dispersion.py | |
|---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | |