#1672: document getTotalWork method

DARMA-tasking · Mar 16, 2022 · 7293993 · 7293993
1 parent ec715b7
commit 7293993
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/vt/vrt/collection/balance/model/load_model.h b/src/vt/vrt/collection/balance/model/load_model.h
@@ -227,6 +227,18 @@ struct LoadModel
     return {};
   }
 
+  /**
+   * \brief Provide an estimate of the total work for a given object during
+   * a specified interval
+   *
+   * \param[in] object The object whose total work is desired
+   * \param[in] when The interval in which the work takes place
+   *
+   * \return Estimated total time of work for the object
+   *
+   * The `updateLoads` method must have been called before any call to
+   * this.
+   */
   TimeType getTotalWork(
     ElementIDStruct object, PhaseOffset when,
     double alpha, double beta, double gamma