Source code for gtsimulation.magnetic_field.galaxy._uf23

from enum import Enum

import numpy as np
from numba import njit

from gtsimulation.common import Units, Regions
from gtsimulation.magnetic_field import AbsBfield


[docs] class UF23ModelType(Enum): """ Available UF23 magnetic field models. """ base = 1 expX = 2 neCL = 3 twistX = 4 nebCor = 5 cre10 = 6 synCG = 7
[docs] class UF23(AbsBfield): """ Unger–Farrar 2023 model of the Galactic magnetic field. This class implements a comprehensive model of the Milky Way's magnetic field, including a logarithmic spiral disk, a toroidal halo, and a poloidal (X‑shaped) halo component. Several variants of the model are available, corresponding to different astrophysical constraints or physical assumptions. Parameters ---------- model_type : :py:class:`~gtsimulation.magnetic_field.galaxy.UF23ModelType` or str, optional The specific variant of the UF23 model to use. Can be given as an enum member (e.g., ``UF23ModelType.base``) or as its name (e.g., ``"base"``). The following strings are accepted: - ``"base"`` : baseline best‑fit model - ``"expX"`` : exponential suppression of the poloidal field - ``"neCL"`` : no extra‑galactic cosmic‑ray constraints - ``"nebCor"`` : nebula‑corrected model - ``"cre10"`` : model with CR electron constraints at 10 GeV - ``"synCG"`` : model fitted to synchrotron data and CMB foregrounds The variant ``"twistX"`` (twisted poloidal field) is listed in the original work but is **not yet implemented**. Default is ``UF23ModelType.base``. use_turb : bool, optional If `True`, turbulent field components are enabled. **Currently not implemented** – the parameter is accepted but has no effect. Default is `True`. Notes ----- The magnetic field model is implemented in accordance with [1]_; all parameters for each variant are hard‑coded to the best‑fit values given in Table 1 of the publication. The regular field consists of: - a logarithmic spiral disk field, - a toroidal halo field (north/south asymmetric), - a poloidal (X‑shaped) halo field. Coordinates are expected in **kiloparsecs (kpc)**. The returned field components are in **nanotesla (nT)**. References ---------- .. [1] Unger, Michael, and Glennys R. Farrar. "The coherent magnetic field of the Milky Way." The Astrophysical Journal 970.1 (2024): 95. Examples -------- >>> from gtsimulation.magnetic_field.galaxy import UF23 >>> model = UF23(model_type="base", use_turb=False) >>> Bx, By, Bz = model.calc_field(x=-8.2, y=0.0, z=0.0) # Sun's position >>> print(f"B = ({Bx:.3f}, {By:.3f}, {Bz:.3f}) nT") """ to_meters = Units.kpc def __init__(self, model_type: UF23ModelType | str = UF23ModelType.base, use_turb=True): super().__init__() self.Region = Regions.Galaxy self.ModelName = "UF23" self.model_type = model_type if isinstance(model_type, UF23ModelType) else UF23ModelType[model_type] self.use_turb = use_turb # Regular field # # Disk field self.r_0 = 5 # kpc self.r_1 = 5 # kpc self.r_2 = 20 # kpc self.w_1 = 0.5 # kpc self.w_2 = 0.5 # kpc # TODO add 'twistX' model match self.model_type: case UF23ModelType.base: # Disk field self.pitch = 10.11 * np.pi / 180 # rad self.z_disk = 0.794 # kpc self.w_disk = 0.107 # kpc self.B_1 = 1.09 # muG self.B_2 = 2.66 # muG self.B_3 = 3.12 # muG self.phi_1 = 263 * np.pi / 180 # rad self.phi_2 = 97.8 * np.pi / 180 # rad self.phi_3 = 35.1 * np.pi / 180 # rad # Toroidal halo self.B_n = 3.26 # muG self.B_s = -3.09 # muG self.z_t = 4.0 # kpc self.r_t = 10.19 # kpc self.w_t = 1.7 # kpc self.t = None # Myr # Poloidal halo self.B_p = 0.978 # muG self.p = 1.43 self.z_p = 4.5 # kpc self.r_p = 7.29 # kpc self.w_p = 0.112 # kpc self.a_c = 1e6 # kpc -- because 'a_c' -> inf # Other model parameters self.xi = 0.346 self.beta_str = 1 - (1 + self.xi) ** 2 case UF23ModelType.expX: # Disk field self.pitch = 10.03 * np.pi / 180 # rad self.z_disk = 0.715 # kpc self.w_disk = 0.099 # kpc self.B_1 = 0.99 # muG self.B_2 = 2.18 # muG self.B_3 = 3.12 # muG self.phi_1 = 247 * np.pi / 180 # rad self.phi_2 = 98.6 * np.pi / 180 # rad self.phi_3 = 34.9 * np.pi / 180 # rad # Toroidal halo self.B_n = 2.71 # muG self.B_s = -2.57 # muG self.z_t = 5.5 # kpc self.r_t = 10.13 # kpc self.w_t = 2.1 # kpc self.t = None # Myr # Poloidal halo self.B_p = 5.8 # muG self.p = 1.95 self.z_p = 2.37 # kpc self.r_p = 7.29 # kpc self.w_p = None # kpc self.a_c = 6.2 # kpc # Other model parameters self.xi = 0.51 self.beta_str = 1 - (1 + self.xi) ** 2 case UF23ModelType.neCL: # Disk field self.pitch = 11.9 * np.pi / 180 # rad self.z_disk = 0.674 # kpc self.w_disk = 0.061 # kpc self.B_1 = 1.43 # muG self.B_2 = 1.4 # muG self.B_3 = 3.44 # muG self.phi_1 = 200 * np.pi / 180 # rad self.phi_2 = 135 * np.pi / 180 # rad self.phi_3 = 65 * np.pi / 180 # rad # Toroidal halo self.B_n = 2.63 # muG self.B_s = -2.57 # muG self.z_t = 4.6 # kpc self.r_t = 10.13 # kpc self.w_t = 1.15 # kpc self.t = None # Myr # Poloidal halo self.B_p = 0.984 # muG self.p = 1.68 self.z_p = 3.65 # kpc self.r_p = 7.41 # kpc self.w_p = 0.142 # kpc self.a_c = 1e6 # kpc -- because 'a_c' -> inf # Other model parameters self.xi = 0.336 self.beta_str = 1 - (1 + self.xi) ** 2 case UF23ModelType.nebCor: # Disk field self.pitch = 10.15 * np.pi / 180 # rad self.z_disk = 0.812 # kpc self.w_disk = 0.119 # kpc self.B_1 = 1.41 # muG self.B_2 = 3.53 # muG self.B_3 = 4.13 # muG self.phi_1 = 264 * np.pi / 180 # rad self.phi_2 = 97.6 * np.pi / 180 # rad self.phi_3 = 36.4 * np.pi / 180 # rad # Toroidal halo self.B_n = 4.6 # muG self.B_s = -4.5 # muG self.z_t = 3.6 # kpc self.r_t = 10.21 # kpc self.w_t = 1.7 # kpc self.t = None # Myr # Poloidal halo self.B_p = 1.35 # muG self.p = 1.34 self.z_p = 4.8 # kpc self.r_p = 7.25 # kpc self.w_p = 0.143 # kpc self.a_c = 1e6 # kpc -- because 'a_c' -> inf # Other model parameters self.xi = 0.0 self.beta_str = 1 - (1 + self.xi) ** 2 case UF23ModelType.synCG: # Disk field self.pitch = 9.90 * np.pi / 180 # rad self.z_disk = 0.622 # kpc self.w_disk = 0.067 # kpc self.B_1 = 0.81 # muG self.B_2 = 2.06 # muG self.B_3 = 2.94 # muG self.phi_1 = 230 * np.pi / 180 # rad self.phi_2 = 97.4 * np.pi / 180 # rad self.phi_3 = 32.9 * np.pi / 180 # rad # Toroidal halo self.B_n = 2.40 # muG self.B_s = -2.09 # muG self.z_t = 5.6 # kpc self.r_t = 9.42 # kpc self.w_t = 0.92 # kpc self.t = None # Myr # Poloidal halo self.B_p = 0.809 # muG self.p = 1.58 self.z_p = 3.53 # kpc self.r_p = 7.46 # kpc self.w_p = 0.150 # kpc self.a_c = 1e6 # kpc -- because 'a_c' -> inf # Other model parameters self.xi = 0.63 self.beta_str = 1 - (1 + self.xi) ** 2 case UF23ModelType.cre10: # Disk field self.pitch = 10.16 * np.pi / 180 # rad self.z_disk = 0.808 # kpc self.w_disk = 0.108 # kpc self.B_1 = 1.20 # muG self.B_2 = 2.75 # muG self.B_3 = 3.21 # muG self.phi_1 = 265 * np.pi / 180 # rad self.phi_2 = 98.2 * np.pi / 180 # rad self.phi_3 = 35.9 * np.pi / 180 # rad # Toroidal halo self.B_n = 3.7 # muG self.B_s = -3.50 # muG self.z_t = 2.9 # kpc self.r_t = 10.41 # kpc self.w_t = 1.7 # kpc self.t = None # Myr # Poloidal halo self.B_p = 0.969 # muG self.p = 1.42 self.z_p = 4.6 # kpc self.r_p = 7.30 # kpc self.w_p = 0.109 # kpc self.a_c = 1e6 # kpc -- because 'a_c' -> inf # Other model parameters self.xi = 0.250 self.beta_str = 1 - (1 + self.xi) ** 2
[docs] def calc_field(self, x, y, z): """ Compute the magnetic field vector at a given Galactic position. Parameters ---------- x : float Galactic X‑coordinate (kpc). y : float Galactic Y‑coordinate (kpc). z : float Galactic Z‑coordinate (kpc). Returns ------- tuple of (float, float, float) The three components :math:`(B_x, B_y, B_z)` of the magnetic field in **nanotesla (nT)**. Notes ----- The field is evaluated using the parameters of the model variant selected at instantiation. The calculation includes the disk, toroidal halo, and poloidal halo contributions. No turbulent component is added even if `use_turb` was set to `True`. The position is expected to lie within the Galactic disk region (typically :math:`r < 20` kpc and :math:`|z| < 10` kpc); outside this range the field may be poorly constrained. """ return self.__calc_field(x, y, z, self.pitch, self.z_disk, self.w_disk, self.B_1, self.B_2, self.B_3, self.phi_1, self.phi_2, self.phi_3, self.r_0, self.r_1, self.r_2, self.w_1, self.w_2, self.B_n, self.B_s, self.z_t, self.r_t, self.w_t, self.t, self.B_p, self.p, self.z_p, self.r_p, self.w_p, self.a_c, self.use_turb, self.model_type.value)
@staticmethod @njit(fastmath=True) def __calc_field(x, y, z, pitch, z_disk, w_disk, B_1, B_2, B_3, phi_1, phi_2, phi_3, r_0, r_1, r_2, w_1, w_2, B_n, B_s, z_t, r_t, w_t, t, B_p, p, z_p, r_p, w_p, a_c, use_turb, model_type_value): R = np.sqrt(x ** 2 + y ** 2 + z ** 2) r = np.sqrt(x ** 2 + y ** 2) phi = np.arctan2(y, x) phi = phi if phi >= 0 else phi + 2 * np.pi # Disk phi_0 = phi - np.log(r / r_0) / np.tan(pitch) B_ref = (B_1 * np.cos(1 * (phi_0 - phi_1)) + B_2 * np.cos(2 * (phi_0 - phi_2)) + B_3 * np.cos(3 * (phi_0 - phi_3))) sigmoid = lambda x_arg: 1.0 / (1.0 + np.exp(-x_arg)) h_disk = lambda z_arg: 1 - sigmoid((np.abs(z_arg) - z_disk) / w_disk) g_disk = lambda r_arg: ((1 - sigmoid((r_arg - r_2) / w_2)) * sigmoid((r_arg - r_1) / w_1) * (1 - np.exp(-r_arg ** 2))) Br_d = np.sin(pitch) * r_0 / r * B_ref * h_disk(z) * g_disk(r) Bphi_d = np.cos(pitch) * r_0 / r * B_ref * h_disk(z) * g_disk(r) Bx_d = Br_d * np.cos(phi) - Bphi_d * np.sin(phi) By_d = Br_d * np.sin(phi) + Bphi_d * np.cos(phi) # Toroidal halo Bphi_t = (1 - h_disk(z)) * np.exp(-np.abs(z) / z_t) * (1 - sigmoid((r - r_t) / w_t)) if z > 0: Bphi_t *= B_n else: Bphi_t *= B_s Bx_t = Bphi_t * np.sin(phi) By_t = Bphi_t * np.cos(phi) # Poloidal halo c = np.power(a_c / z_p, p) delta = np.power(a_c, p) + c * np.power(np.abs(z), p) - np.power(r, p) k = 4 * np.power(a_c, p) * np.power(r, p) a_p = 0.5 * k / (np.sqrt(np.power(delta, 2) + k) + delta) a = np.power(a_p, 1 / p) r_over_a = 1 / np.power(2 * np.power(a_c, p) / (np.sqrt(np.power(delta, 2) + k) + delta), 1 / p) # sign_z = -1 if z < 0 else 1 # Radial functions if w_p is None: f_x = np.exp(-a / r_p) else: f_x = 1 - sigmoid((a - r_p) / w_p) B0 = B_p * f_x if r <= 1e-12: Br_p = 0.0 else: Br_p = B0 * c * a / r_over_a * np.sign(z) * np.power(np.abs(z), p - 1) / np.sqrt(np.power(delta, 2) + k) Bz_p = B0 * np.power(r_over_a, p - 2) * (a_p + np.power(a_c, p)) / np.sqrt(np.power(delta, 2) + k) Bx_p = Br_p * np.cos(phi) By_p = -Br_p * np.sin(phi) # Total regular field Bx = Bx_d + Bx_t + Bx_p By = By_d + By_t + By_p Bz = Bz_p Babs = np.sqrt(Bx ** 2 + By ** 2 + Bz ** 2) # TODO add irregular field return 0.1 * Bx, 0.1 * By, 0.1 * Bz
[docs] def update_state(self, new_date): pass
def __str__(self): return ( "UF23\n" f"\tModel type: {self.model_type.name}" )