added comment

BranniganLab · Dec 9, 2024 · dc3c70c · dc3c70c
1 parent 84e34e2
commit dc3c70c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/TCL/polarDensity_for_DTA.tcl b/TCL/polarDensity_for_DTA.tcl
@@ -574,6 +574,12 @@ proc polarDensityBin { config_file_script } {
     global params
     set_parameters $config_file_script
     source $params(utils)/BinTools.tcl
+
+    ;# check to make sure Rmax is evenly divisible by dr.
+    ;# Cannot ensure that Rmax and dr are both ints, so divisibility_test
+    ;# multiplies both by 10,000 before converting to int as a reasonable
+    ;# precaution. Specifying Rmax and dr to greater than 5 decimal places is
+    ;# a questionable life choice.
     set divisibility_test [expr [expr int([expr $params(Rmax) * 10000])] % [expr int([expr $params(dr) * 10000])]]
     if {$divisibility_test != 0} {
         puts "Rmax must be evenly divisible by dr."