Merge pull request #24 from SWIFTSIM/spherical_overdensity

Register Spherical Over-density Quantities

Author: JBorrow

velociraptor/catalogue/registration.py

@@ -970,6 +970,45 @@ def registration_species_fractions(
 
     return unit, full_name, snake_case
 
+def registration_spherical_overdensities(
+    field_path: str, unit_system: VelociraptorUnits
+) -> (unyt.Unit, str, str):
+    """
+    Registers SO aperture values by searching them with regex.
+    """
+
+    # Capture group 1: quantity
+    # Capture group 2: particle type
+    # Capture group 3: sf / nsf
+    # Capture group 4: size of aperture
+
+    match_string = "SO_([^_]*)_([a-zA-Z]*)?_?([a-zA-Z]*)?_?([0-9]*)_rhocrit"
+    regex = cached_regex(match_string)
+
+    match = regex.match(field_path)
+
+    if match:
+        quantity = match.group(1)
+        ptype = match.group(2)
+        star_forming = match.group(3)
+        aperture_size = int(match.group(4))
+
+        unit = get_aperture_unit(quantity, unit_system)
+        name = get_particle_property_name_conversion(quantity, ptype)
+
+        if star_forming:
+            sf_in_name = f"{star_forming.upper()} "
+        else:
+            sf_in_name = ""
+
+        full_name = f"{sf_in_name}{name} ({aperture_size} \\rho_{{\\rm crit}})"
+        snake_case = field_path.lower().replace("so_", "")
+
+        return unit, full_name, snake_case
+    else:
+        raise RegistrationDoesNotMatchError
+
+
 
 # TODO
 # lambda_B
@@ -997,6 +1036,7 @@ def registration_species_fractions(
         "ids",
         "energies",
         "stellar_age",
+        "spherical_overdensities",
         "rotational_support",
         "star_formation_rate",
         "masses",

velociraptor/catalogue/translator.py

@@ -28,15 +28,19 @@ def get_aperture_unit(unit_name: str, unit_system: VelociraptorUnits):
     """
 
     # Correct any typos
-    corrected_name = typo_correct(unit_name)
+    corrected_name = typo_correct(unit_name).lower()
 
     key = {
-        "SFR": unit_system.star_formation_rate,
-        "Zmet": unit_system.metallicity,
+        "sfr": unit_system.star_formation_rate,
+        "zmet": unit_system.metallicity,
         "mass": unit_system.mass,
         "npart": unyt.dimensionless,
         "rhalfmass": unit_system.length,
         "veldisp": unit_system.velocity,
+        "r": unit_system.length,
+        "lx": unit_system.length * unit_system.velocity,
+        "ly": unit_system.length * unit_system.velocity,
+        "lz": unit_system.length * unit_system.velocity,
     }
 
     return key.get(corrected_name, None)
@@ -51,15 +55,15 @@ def get_particle_property_name_conversion(name: str, ptype: str):
 
     corrected_name = typo_correct(name)
 
-    combined_name = f"{corrected_name}_{ptype}"
+    combined_name = f"{corrected_name}_{ptype}".lower()
 
     key = {
-        "SFR_": "SFR $\dot{\\rho}_*$",
-        "SFR_gas": "Gas SFR $\dot{\\rho}_*$",
-        "Zmet_": "Metallicity $Z$",
-        "Zmet_gas": "Gas Metallicity $Z_{\\rm g}$",
-        "Zmet_star": "Star Metallicity $Z_*$",
-        "Zmet_bh": "Black Hole Metallicity $Z_{\\rm BH}$",
+        "sfr_": "SFR $\dot{\\rho}_*$",
+        "sfr_gas": "Gas SFR $\dot{\\rho}_*$",
+        "zmet_": "Metallicity $Z$",
+        "zmet_gas": "Gas Metallicity $Z_{\\rm g}$",
+        "zmet_star": "Star Metallicity $Z_*$",
+        "zmet_bh": "Black Hole Metallicity $Z_{\\rm BH}$",
         "mass_": "Mass $M$",
         "mass_gas": "Gas Mass $M_{\\rm g}$",
         "mass_star": "Stellar Mass $M_*$",
@@ -74,11 +78,12 @@ def get_particle_property_name_conversion(name: str, ptype: str):
         "rhalfmass_gas": "Gas Half-mass Radius $R_{50, {\\rm g}}$",
         "rhalfmass_star": "Stellar Half-mass Radius $R_{50, *}$",
         "rhalfmass_bh": "Black Hole Half-mass Radius $R_{50, {\\rm BH}}$",
+        "r_": "Radius $R_{\\rm SO}$",
         "veldisp_": "Velocity Dispersion $\sigma$",
         "veldisp_gas": "Gas Velocity Dispersion $\sigma_{\\rm g}}$",
         "veldisp_star": "Stellar Velocity Dispersion $\sigma_{*}$",
         "veldisp_bh": "Black Hole Velocity Dispersion $\sigma_{\\rm BH}$",
-        "SubgridMasses_aperture_total_solar_mass_bh": "Subgrid Black Hole Mass $M_{\\rm BH}$",
+        "subgridmasses_aperture_total_solar_mass_bh": "Subgrid Black Hole Mass $M_{\\rm BH}$",
     }
 
     return key.get(combined_name, corrected_name)