#1359: LB: add function to print documentation for all LBs

DARMA-tasking · Sep 28, 2021 · 15624bf · 15624bf
1 parent 2b59441
commit 15624bf
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/src/vt/vrt/collection/balance/lb_invoke/lb_manager.cc b/src/vt/vrt/collection/balance/lb_invoke/lb_manager.cc
@@ -305,6 +305,22 @@ void LBManager::printLBArgsHelp(LBType lb) {
   }
 }
 
+/*static*/
+void LBManager::printLBArgsHelp(std::string lb_name) {
+  if (lb_name.compare("NoLB") == 0) {
+    for (auto&& lb : vrt::collection::balance::lb_names_) {
+      vrt::collection::balance::LBManager::printLBArgsHelp(lb.first);
+    }
+  } else {
+    for (auto&& lb : vrt::collection::balance::lb_names_) {
+      if (lb_name == lb.second) {
+        vrt::collection::balance::LBManager::printLBArgsHelp(lb.first);
+      break;
+      }
+    }
+  }
+}
+
 void LBManager::startup() {
   thePhase()->registerHookCollective(phase::PhaseHook::EndPostMigration, []{
     auto const phase = thePhase()->getCurrentPhase();

diff --git a/src/vt/vrt/collection/balance/lb_invoke/lb_manager.h b/src/vt/vrt/collection/balance/lb_invoke/lb_manager.h
@@ -141,6 +141,14 @@ struct LBManager : runtime::component::Component<LBManager> {
    */
   static void printLBArgsHelp(LBType lb);
 
+  /**
+   * \internal
+   * \brief Print documentation for LB args for all LBs or the one specified
+   *
+   * \param[in] lb the load balancer in use
+   */
+  static void printLBArgsHelp(std::string lb);
+
 protected:
   /**
    * \internal