#1359: LB: add nominal doc output for missing LBs

DARMA-tasking · Sep 30, 2021 · ebf395c · ebf395c
1 parent 720ce15
commit ebf395c
Show file tree

Hide file tree

Showing 4 changed files with 44 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
@@ -284,6 +284,14 @@ void LBManager::printLBArgsHelp(LBType lb) {
   case LBType::RandomLB:
     help = lb::RandomLB::getInputKeysWithHelp();
     break;
+  case LBType::StatsMapLB:
+    help = lb::StatsMapLB::getInputKeysWithHelp();
+    break;
+# if vt_check_enabled(zoltan)
+  case LBType::ZoltanLB:
+    help = lb::ZoltanLB::getInputKeysWithHelp();
+    break;
+# endif
   case LBType::NoLB:
     // deliberately skip retrieving arguments
     break;

diff --git a/src/vt/vrt/collection/balance/statsmaplb/statsmaplb.h b/src/vt/vrt/collection/balance/statsmaplb/statsmaplb.h
@@ -46,6 +46,8 @@
 
 #include "vt/objgroup/proxy/proxy_objgroup.h"
 
+#include <unordered_map>
+
 namespace vt { namespace vrt { namespace collection { namespace lb {
 
 struct BaseLB;
@@ -62,6 +64,10 @@ struct StatsMapLB : BaseLB {
   void runLB() override;
   void inputParams(balance::SpecEntry* spec) override { }
 
+  static std::unordered_map<std::string, std::string> getInputKeysWithHelp() {
+    return std::unordered_map<std::string, std::string>{};
+  }
+
 private:
   objgroup::proxy::Proxy<StatsMapLB> proxy_ = {};
 };

diff --git a/src/vt/vrt/collection/balance/zoltanlb/zoltanlb.cc b/src/vt/vrt/collection/balance/zoltanlb/zoltanlb.cc
@@ -62,6 +62,34 @@ void ZoltanLB::init(objgroup::proxy::Proxy<ZoltanLB> in_proxy) {
   proxy = in_proxy;
 }
 
+/*static*/ std::unordered_map<std::string, std::string>
+ZoltanLB::getInputKeysWithHelp() {
+  std::string const read_manual = "Please read Zoltan manual.";
+  std::unordered_map<std::string, std::string> const keys_help = {
+    {"LB_APPROACH",                   read_manual },
+    {"DEBUG_LEVEL",                   read_manual },
+    {"FINAL_OUTPUT",                  read_manual },
+    {"DEBUG_PROCESSOR",               read_manual },
+    {"CHECK_HYPERGRAPH",              read_manual },
+    {"PHG_EDGE_WEIGHT_OPERATION",     read_manual },
+    {"IMBALANCE_TOL",                 read_manual },
+    {"PHG_REPART_MULTIPLIER",         read_manual },
+    {"PHG_EDGE_WEIGHT_OPERATION",     read_manual },
+    {"PHG_CUT_OBJECTIVE",             read_manual },
+    {"PHG_OUTPUT_LEVEL",              read_manual },
+    {"PHG_COARSENING_METHOD",         read_manual },
+    {"PHG_COARSEPARTITION_METHOD",    read_manual },
+    {"PHG_REFINEMENT_QUALITY",        read_manual },
+    {"PHG_RANDOMIZE_INPUT",           read_manual },
+    {"PHG_EDGE_SIZE_THRESHOLD",       read_manual },
+    {"PHG_PROCESSOR_REDUCTION_LIMIT", read_manual },
+    {"PHG_REFINEMENT_METHOD",         read_manual },
+    {"PHG_MULTILEVEL",                read_manual },
+    {"SEED",                          read_manual }
+  };
+  return keys_help;
+}
+
 void ZoltanLB::inputParams(balance::SpecEntry* spec) {
   zoltan_config_ = {
     {"LB_APPROACH",                   "REPARTITION" },

diff --git a/src/vt/vrt/collection/balance/zoltanlb/zoltanlb.h b/src/vt/vrt/collection/balance/zoltanlb/zoltanlb.h
@@ -67,6 +67,8 @@ struct ZoltanLB : BaseLB {
   void runLB() override;
   void inputParams(balance::SpecEntry* spec) override;
 
+  static std::unordered_map<std::string, std::string> getInputKeysWithHelp();
+
 private:
   struct Graph {
     using GID = std::unique_ptr<ZOLTAN_ID_TYPE[]>;