#2201: added transfer type key to getInputKeysWithHelp()

DARMA-tasking · Oct 19, 2023 · fa249e6 · fa249e6
1 parent 8f29250
commit fa249e6
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 9 deletions.
diff --git a/src/vt/vrt/collection/balance/temperedlb/temperedlb.cc b/src/vt/vrt/collection/balance/temperedlb/temperedlb.cc
@@ -166,6 +166,27 @@ Default: AsyncInform
       loads when the first message for a round is received, avoiding the
       synchronization cost but delaying the propagation of some information
       until the following round.
+)"
+    },
+    {
+      "transfer",
+      R"(
+Values: {Original, Recursive, SwapClusters}
+Default: Original
+Description:
+    Transfer strategy to be used in transfer stage. Options are:
+    Original: transfer one object per transfer as in original Grapevine approach.                                     Recursive: original strategy improved by recursion.
+      When single object transfer is rejected, attempt to recurse in order to
+      pull more objects into the transfer and hereby minimize work added by
+      said transfer.
+      This is especially useful when communication is taken into account, as
+      object transfers typically disrupt local vs. global communication edges.
+    SwapClusters: form object clusters and attempt to perform swaps.
+      Object can be clustered according to arbitrary definition, and swaps
+      of entire clusters, according the nullset, between ranks are attempted.
+      This is especially useful when shared memory constraints are present,
+      as breaking shared memory clusters results in higher overall memory
+      footprint, in constrast with whole cluster swaps.
 )"
     },
     {
@@ -375,9 +396,9 @@ void TemperedLB::inputParams(balance::ConfigEntry* config) {
 
   balance::LBArgsEnumConverter<TransferTypeEnum> transfer_type_converter_(
     "cmf", "TransferTypeEnum", {
-      {TransferTypeEnum::Original,                   "Original"},
-      {TransferTypeEnum::Recursive,                  "Recursive"},
-      {TransferTypeEnum::SwapClusters,               "SwapClusters"}
+      {TransferTypeEnum::Original,        "Original"},
+      {TransferTypeEnum::Recursive,       "Recursive"},
+      {TransferTypeEnum::SwapClusters,    "SwapClusters"}
     }
   );
   transfer_type_ = transfer_type_converter_.getFromConfig(config, transfer_type_);

diff --git a/src/vt/vrt/collection/balance/temperedlb/temperedlb.h b/src/vt/vrt/collection/balance/temperedlb/temperedlb.h
@@ -172,12 +172,7 @@ struct TemperedLB : BaseLB {
   LoadType target_max_load_                         = 0.0;
   CriterionEnum criterion_                          = CriterionEnum::ModifiedGrapevine;
   InformTypeEnum inform_type_                       = InformTypeEnum::AsyncInform;
-  /**
-   * \brief Type of strategy to be used in transfer stage
-   *
-   * Available strategies include: Original, Recursive, and SwapClusters
-   * and are adapted to different kinds of problems.
-   */
+  /// Type of strategy to be used in transfer stage
   TransferTypeEnum transfer_type_                   = TransferTypeEnum::Original;
   ObjectOrderEnum obj_ordering_                     = ObjectOrderEnum::FewestMigrations;
   CMFTypeEnum cmf_type_                             = CMFTypeEnum::NormByMax;