add frequency scaling metric

Author: ptooley

pypop/metrics/openmp.py

@@ -49,7 +49,10 @@
     "The IPC rate can be reduced due to CPU data starvation, inefficient cache usage or "
     "high rates of branch misprediction."
 )
-
+k_FREQSC_desc = (
+    "Inefficiencies due to processor execution frequency changes. The frequency is typically "
+    "reduced due to either incorrect choice of CPU scheduler or overheating of the CPU."
+)
 
 class OpenMP_Metrics(MetricSet):
     """Proposed Hybrid MPI+OpenMP Metrics.
@@ -63,6 +66,7 @@ class OpenMP_Metrics(MetricSet):
         Metric("Computational Scaling", 1, desc=k_COMPSC_desc),
         Metric("Instruction Scaling", 2, desc=k_INSSC_desc),
         Metric("IPC Scaling", 2, "IPC Scaling", desc=k_IPCSC_desc),
+        Metric("Frequency Scaling", 2, "Frequency Scaling", desc=k_FREQSC_desc),
     ]
 
     _programming_model = "OpenMP"
@@ -138,6 +142,13 @@ def _calculate_metrics(self, ref_key=None, sort_keys=True):
                     / stats["Total Useful Computation"].sum()
                 )
 
+                metrics["Frequency Scaling"] = (
+                    stats["Useful Cycles"].sum() / stats["Total Useful Computation"].sum()
+                ) / (
+                    self._stats_dict[ref_key].statistics["Useful Cycles"].sum()
+                    / self._stats_dict[ref_key].statistics["Total Useful Computation"].sum()
+                )
+
                 metrics["Global Efficiency"] = (
                     metrics["Computational Scaling"] * metrics["Parallel Efficiency"]
                 )