Rename find_eclipse! to mutual_shadowing!

Astroshaper · Aug 17, 2023 · 1b5446c · 1b5446c
1 parent bd792e0
commit 1b5446c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 10 deletions.
diff --git a/src/TPM.jl b/src/TPM.jl
@@ -267,8 +267,8 @@ function run_TPM!(btpm::BinaryTPM, ephem, savepath)
         update_flux_scat_single!(btpm)
         update_flux_rad_single!(btpm, nₜ)
 
-        ## Mutual-shadowing
-        find_eclipse!(btpm, r☉₁, sec_from_pri, R₂₁)
+        ## Mutual-shadowing (eclipse)
+        mutual_shadowing!(btpm, r☉₁, sec_from_pri, R₂₁)
 
         ## Mutual-heating
         #

diff --git a/src/energy_flux.jl b/src/energy_flux.jl
@@ -272,22 +272,17 @@ end
 
 
 """
-    find_eclipse!(btpm::BinaryTPM, r☉, rₛ, R₂₁)
+    mutual_shadowing!(btpm::BinaryTPM, r☉, rₛ, R₂₁)
 
-Find eclipse events between the primary and secondary, and update the solar fluxes of the faces.
+Detect eclipse events between the primary and secondary, and update the solar fluxes of the faces.
 
 # Arguments
 - `btpm` : Thermophysical model for a binary asteroid
 - `r☉`   : Position of the sun relative to the primary       (NOT normalized)
 - `rₛ`   : Position of the secondary relative to the primary (NOT normalized)
 - `R₂₁`  : Rotation matrix from secondary to primary
-
-# TO DO:
-- r₁ = minimum_radius(shape1)
-- r₂ = minimum_radius(shape2)
-Use these radii and conduct early out of shadowed faces before calling `raycast`.
 """
-function find_eclipse!(btpm::BinaryTPM, r☉, rₛ, R₂₁)
+function mutual_shadowing!(btpm::BinaryTPM, r☉, rₛ, R₂₁)
 
     shape1 = btpm.pri.shape
     shape2 = btpm.sec.shape