#2099: Types: Make NodeType a strong type and use it across the codebase

docs/md/active-messenger.md

@@ -49,35 +49,35 @@ struct MyMsg : vt::Message {
 
 // Active function pointer
 void myHandler(MyMsg* m) {
-  vt::NodeType this_node = vt::theContext()->getNode();
+  vt::NodeT this_node = vt::theContext()->getNode();
   fmt::print("{}: val={}, vec size={}\n", this_node, m->val, m->my_vec.size());
 }
 
 // Active functor
 struct MyFunctor {
   void operator()(MyMsg* m) {
-    vt::NodeType this_node = vt::theContext()->getNode();
+    vt::NodeT this_node = vt::theContext()->getNode();
     fmt::print("{}: val={}, vec size={}\n", this_node, m->val, m->my_vec.size());
   }
 };
 
 int main(int argc, char** argv) {
   vt::initialize(argc, argv);
 
-  vt::NodeType this_node = vt::theContext()->getNode();
+  vt::NodeT this_node = vt::theContext()->getNode();
 
-  if (this_node == 0) {
+  if (this_node == vt::NodeT{0}) {
     // spins in scheduler until termination of the enclosed work
     vt::runInEpochRooted([=]{
       std::vector<double> vec_to_send;
       vec_to_send.push_back(29.);
       vec_to_send.push_back(54.);
 
       auto msg = vt::makeMessage<MyMsg>(10, vec_to_send);
-      vt::theMsg()->sendMsg<MyMsg, myHandler>(1, msg); // send to node 1
+      vt::theMsg()->sendMsg<MyMsg, myHandler>(vt::NodeT{1}, msg); // send to node 1
 
       auto msg2 = vt::makeMessage<MyMsg>(11, vec_to_send);
-      vt::theMsg()->sendMsg<MyFunctor>(1, msg2);  // send to node 1
+      vt::theMsg()->sendMsg<MyFunctor>(vt::NodeT{1}, msg2);  // send to node 1
     });
   }
 

docs/md/collection.md

@@ -73,7 +73,7 @@ template argument to `.mapperFunc<my_map>()`, where `my_map` has the following
 definition (shown for a 1-dimensional collection):
 
 \code{.cpp}
-vt::NodeType my_map(vt::Index1D* idx, vt::Index1D* bounds, vt::NodeType num_nodes) {
+vt::NodeT my_map(vt::Index1D* idx, vt::Index1D* bounds, vt::NodeT num_nodes) {
   return idx->x() % num_nodes;
 }
 \endcode
@@ -85,7 +85,7 @@ group instance that already exists by passing the proxy to it. Otherwise, one
 may just give the type and constructor arguments to create a new instance:
 `.mapperObjGroupConstruct<MyObjectGroup>(args...)`. An object group mapper must
 inherit from `vt::mapping::BaseMapper` and implement the pure virtual method
-`NodeType map(IdxT* idx, int ndim, NodeType num_nodes)` to define the mapping
+`NodeT map(IdxT* idx, int ndim, NodeT num_nodes)` to define the mapping
 for the runtime. As an example, the object group mapper used by default for
 unbounded collections is implemented as follows:
 
@@ -97,7 +97,7 @@ struct UnboundedDefaultMap : vt::mapping::BaseMapper<IdxT> {
     return proxy.getProxy();
   }
 
-  NodeType map(IdxT* idx, int ndim, NodeType num_nodes) override {
+  NodeT map(IdxT* idx, int ndim, NodeT num_nodes) override {
     typename IdxT::DenseIndexType val = 0;
     for (int i = 0; i < ndim; i++) {
       val ^= idx->get(i);
@@ -157,8 +157,8 @@ collective interface):
   auto range = vt::Index1D(num_elms);
   auto token = proxy.beginModification();
   for (int i = 0; i < range.x() / 2; i++) {
-    if (i % num_nodes == this_node) {
-      proxy[i].insertAt(token, i % 2);
+    if (vt::NodeT{i} % num_nodes == this_node) {
+      proxy[i].insertAt(token, vt::NodeT{i % 2});
     }
   }
   proxy.finishModification(std::move(token));

docs/md/collective.md

@@ -53,7 +53,7 @@ int main(int argc, char** argv) {
 
   auto reduce_msg = vt::makeMessage<ReduceDataMsg>(50);
 
-  NodeType const root_reduce_node = 0;
+  NodeT const root_reduce_node = 0;
   vt::theCollective()->global()->reduce<vt::collective::PlusOp<int>,ReduceResult>(
     root_reduce_node, reduce_msg.get()
   );

docs/md/context.md

@@ -18,7 +18,7 @@ provides the MPI communicator that an instance of \vt is currently using.
 To get the current node, one may query this method:
 
 \code{.cpp}
-vt::NodeType this_node = vt::theContext()->getNode();
+vt::NodeT this_node = vt::theContext()->getNode();
 \endcode
 
 \subsection get-num-nodes Number of nodes/ranks
@@ -29,7 +29,7 @@ To get the number of nodes or ranks that an instance of \vt is using, one may
 query this method:
 
 \code{.cpp}
-vt::NodeType num_nodes = vt::theContext()->getNumNodes();
+vt::NodeT num_nodes = vt::theContext()->getNumNodes();
 \endcode
 
 \note The result from \c getNode or \c getNumNodes will depend on the

docs/md/vt.md

@@ -78,23 +78,23 @@ management.
         bool done = false;
 
         struct HelloMsg : vt::Message {
-          HelloMsg(vt::NodeType in_from) : from(in_from) { }
-          vt::NodeType from = 0;
+          HelloMsg(vt::NodeT in_from) : from(in_from) { }
+          vt::NodeT from = 0;
         };
 
         void hello_world(HelloMsg* msg) {
-          vt::NodeType this_node = vt::theContext()->getNode();
+          vt::NodeT this_node = vt::theContext()->getNode();
           fmt::print("{}: Hello from node {}\n", this_node, msg->from);
           done = true;
         }
 
         int main(int argc, char** argv) {
           vt::initialize(argc, arv);
 
-          vt::NodeType this_node = vt::theContext()->getNode();
-          vt::NodeType num_nodes = vt::theContext()->getNumNodes();
+          vt::NodeT this_node = vt::theContext()->getNode();
+          vt::NodeT num_nodes = vt::theContext()->getNumNodes();
 
-          if (this_node == 0) {
+          if (this_node == vt::NodeT{0}) {
             auto msg = vt::makeMessage<HelloMsg>(this_node);
             vt::theMsg()->broadcastMsg<HelloMsg, hello_world>(msg);
             done = true;

examples/callback/callback.cc

@@ -84,7 +84,7 @@ void hello_world(HelloMsg* msg) {
 }
 
 void printOutput(TestMsg* msg, std::string type) {
-  vt::NodeType this_node = vt::theContext()->getNode();
+  auto this_node = vt::theContext()->getNode();
   fmt::print("{}: cb {}: val={}, str={}\n", this_node, type, msg->val_, msg->s_);
 }
 
@@ -116,16 +116,16 @@ void colHan(MyCol* col, TestMsg* msg) {
 
 void bounceCallback(vt::Callback<TestMsg> cb) {
   auto msg = vt::makeMessage<HelloMsg>(cb);
-  vt::theMsg()->sendMsg<hello_world>(1, msg);
+  vt::theMsg()->sendMsg<hello_world>(vt::NodeT{1}, msg);
 }
 
 int main(int argc, char** argv) {
   vt::initialize(argc, argv);
 
-  vt::NodeType this_node = vt::theContext()->getNode();
-  vt::NodeType num_nodes = vt::theContext()->getNumNodes();
+  auto this_node = vt::theContext()->getNode();
+  auto num_nodes = vt::theContext()->getNumNodes();
 
-  if (num_nodes == 1) {
+  if (num_nodes == vt::NodeT{1}) {
     return vt::rerror("requires at least 2 nodes");
   }
 
@@ -135,8 +135,8 @@ int main(int argc, char** argv) {
     .bulkInsert()
     .wait();
 
-  if (this_node == 0) {
-    vt::NodeType dest = num_nodes > 2 ? 2 : 0;
+  if (this_node == vt::NodeT{0}) {
+    vt::NodeT dest = num_nodes > vt::NodeT{2} ? vt::NodeT{2} : vt::NodeT{0};
 
     auto cb_functor = vt::theCB()->makeSend<CallbackFunctor>(dest);
     bounceCallback(cb_functor);

examples/callback/callback_context.cc

@@ -103,9 +103,9 @@ int main(int argc, char** argv) {
     return 0;
   }
 
-  vt::NodeType this_node = vt::theContext()->getNode();
+  auto this_node = vt::theContext()->getNode();
 
-  if (this_node == 0) {
+  if (this_node == vt::NodeT{0}) {
     my_global_ctx.x = 1283;
 
     // Make a callback that triggers the callback with a context
@@ -114,7 +114,7 @@ int main(int argc, char** argv) {
     );
 
     auto const default_proxy = vt::theObjGroup()->getDefault();
-    default_proxy[1].send<CallbackMsg, handler>(cb);
+    default_proxy[vt::NodeT{1}].send<CallbackMsg, handler>(cb);
   }
 
   vt::finalize();

examples/collection/insertable_collection.cc

@@ -47,7 +47,7 @@ static constexpr int32_t const default_num_elms = 64;
 
 struct InsertCol : vt::Collection<InsertCol, vt::Index1D> {
   InsertCol() {
-    vt::NodeType this_node = vt::theContext()->getNode();
+    auto this_node = vt::theContext()->getNode();
     ::fmt::print("{}: constructing: idx={}\n", this_node, getIndex().x());
   }
 };
@@ -60,8 +60,8 @@ int main(int argc, char** argv) {
     return 0;
   }
 
-  vt::NodeType this_node = vt::theContext()->getNode();
-  vt::NodeType num_nodes = vt::theContext()->getNumNodes();
+  auto this_node = vt::theContext()->getNode();
+  auto num_nodes = vt::theContext()->getNumNodes();
 
   int32_t num_elms = default_num_elms;
   if (argc > 1) {
@@ -77,8 +77,8 @@ int main(int argc, char** argv) {
     auto token = proxy.beginModification();
 
     for (int i = 0; i < range.x() / 2; i++) {
-      if (i % num_nodes == this_node) {
-        proxy[i].insertAt(token, i % 2);
+      if (vt::NodeT{i} % num_nodes == this_node) {
+        proxy[i].insertAt(token, vt::NodeT{i % 2});
       }
     }
 
@@ -90,8 +90,8 @@ int main(int argc, char** argv) {
     auto token = proxy.beginModification();
 
     for (int i = range.x()/2; i < range.x(); i++) {
-      if (i % num_nodes == this_node) {
-        proxy[i].insertAt(token, i % 2);
+      if (vt::NodeT{i} % num_nodes == this_node) {
+        proxy[i].insertAt(token, vt::NodeT{i % 2});
       }
     }
     proxy.finishModification(std::move(token));

examples/collection/jacobi1d_vt.cc

@@ -335,11 +335,11 @@ int main(int argc, char** argv) {
 
   vt::initialize(argc, argv);
 
-  vt::NodeType this_node = vt::theContext()->getNode();
-  vt::NodeType num_nodes = vt::theContext()->getNumNodes();
+  auto this_node = vt::theContext()->getNode();
+  auto num_nodes = vt::theContext()->getNumNodes();
 
   if (argc == 1) {
-    if (this_node == 0) {
+    if (this_node == vt::NodeT{0}) {
       fmt::print(
         stderr, "{}: using default arguments since none provided\n", name
       );

examples/collection/jacobi2d_vt.cc

@@ -440,10 +440,10 @@ int main(int argc, char** argv) {
 
   vt::initialize(argc, argv);
 
-  vt::NodeType this_node = vt::theContext()->getNode();
+  auto this_node = vt::theContext()->getNode();
 
   if (argc == 1) {
-    if (this_node == 0) {
+    if (this_node == vt::NodeT{0}) {
       fmt::print(
         stderr, "{}: using default arguments since none provided\n", name
       );
@@ -469,7 +469,7 @@ int main(int argc, char** argv) {
 
   /* --- Print information about the simulation */
 
-  if (this_node == 0) {
+  if (this_node == vt::NodeT{0}) {
     fmt::print(
       stdout, "\n - Solve the linear system for the Laplacian with homogeneous Dirichlet"
       " on [0, 1] x [0, 1]\n"

examples/collection/lb_iter.cc

@@ -97,9 +97,9 @@ int main(int argc, char** argv) {
     num_iter = atoi(argv[3]);
   }
 
-  vt::NodeType this_node = vt::theContext()->getNode();
+  auto this_node = vt::theContext()->getNode();
 
-  if (this_node == 0) {
+  if (this_node == vt::NodeT{0}) {
     fmt::print(
       "lb_iter: elms={}, weight={}, num_iter={}\n",
       num_elms, weight, num_iter
@@ -126,7 +126,7 @@ int main(int argc, char** argv) {
     });
 
     auto total_time = vt::timing::getCurrentTime() - cur_time;
-    if (this_node == 0) {
+    if (this_node == vt::NodeT{0}) {
       fmt::print("iteration: iter={},time={}\n", i, total_time);
     }
 

examples/collection/migrate_collection.cc

@@ -49,7 +49,7 @@ static constexpr int32_t const default_num_elms = 16;
 struct Hello : vt::Collection<Hello, vt::Index1D> {
 
   Hello() {
-    vt::NodeType this_node = vt::theContext()->getNode();
+    auto this_node = vt::theContext()->getNode();
     fmt::print("{}: Hello: index={}\n", this_node, getIndex());
     test_val = getIndex().x() * 29.3;
   }
@@ -66,14 +66,14 @@ struct Hello : vt::Collection<Hello, vt::Index1D> {
 };
 
 static void doWork(Hello* col) {
-  vt::NodeType this_node = vt::theContext()->getNode();
+  auto this_node = vt::theContext()->getNode();
   fmt::print("{}: idx={}: val={}\n", this_node, col->getIndex(), col->test_val);
 }
 
 static void migrateToNext(Hello* col) {
-  vt::NodeType this_node = vt::theContext()->getNode();
-  vt::NodeType num_nodes = vt::theContext()->getNumNodes();
-  vt::NodeType next_node = (this_node + 1) % num_nodes;
+  auto this_node = vt::theContext()->getNode();
+  auto num_nodes = vt::theContext()->getNumNodes();
+  vt::NodeT next_node = (this_node + vt::NodeT{1}) % num_nodes;
 
   fmt::print("{}: migrateToNext: idx={}\n", this_node, col->getIndex());
   col->migrate(next_node);
@@ -82,10 +82,10 @@ static void migrateToNext(Hello* col) {
 int main(int argc, char** argv) {
   vt::initialize(argc, argv);
 
-  vt::NodeType this_node = vt::theContext()->getNode();
-  vt::NodeType num_nodes = vt::theContext()->getNumNodes();
+  auto this_node = vt::theContext()->getNode();
+  auto num_nodes = vt::theContext()->getNumNodes();
 
-  if (num_nodes == 1) {
+  if (num_nodes == vt::NodeT{1}) {
     return vt::rerror("requires at least 2 nodes");
   }
 
@@ -100,7 +100,7 @@ int main(int argc, char** argv) {
     .bulkInsert()
     .wait();
 
-  if (this_node == 0) {
+  if (this_node == vt::NodeT{0}) {
     vt::runInEpochRooted([=] { proxy.broadcast<doWork>(); });
     vt::runInEpochRooted([=] { proxy.broadcast<migrateToNext>(); });
     vt::runInEpochRooted([=] { proxy.broadcast<doWork>(); });

examples/collection/polymorphic_collection.cc

@@ -139,9 +139,9 @@ void Hello::doWork() {
 
 
 static void migrateToNext(Hello* col) {
-  vt::NodeType this_node = vt::theContext()->getNode();
-  vt::NodeType num_nodes = vt::theContext()->getNumNodes();
-  vt::NodeType next_node = (this_node + 1) % num_nodes;
+  auto this_node = vt::theContext()->getNode();
+  auto num_nodes = vt::theContext()->getNumNodes();
+  vt::NodeT next_node = (this_node + vt::NodeT{1}) % num_nodes;
 
   fmt::print("{}: migrateToNext: idx={}\n", this_node, col->getIndex());
   col->migrate(next_node);
@@ -150,8 +150,8 @@ static void migrateToNext(Hello* col) {
 int main(int argc, char** argv) {
   vt::initialize(argc, argv);
 
-  vt::NodeType this_node = vt::theContext()->getNode();
-  vt::NodeType num_nodes = vt::theContext()->getNumNodes();
+  auto this_node = vt::theContext()->getNode();
+  auto num_nodes = vt::theContext()->getNumNodes();
 
   auto num_elms = std::max(static_cast<int32_t>(num_nodes), default_num_elms);
 
@@ -165,12 +165,12 @@ int main(int argc, char** argv) {
   vtAbortIf(num_elms % num_nodes != 0, "Must be even number of elements per rank");
   auto const num_per = num_elms / num_nodes;
   if (this_node % 2 == 0) {
-    for (int i = this_node*num_per; i < (this_node+1)*num_per; i++) {
+    for (int i = this_node.get()*num_per; i < (this_node.get()+1)*num_per; i++) {
       vt::Index1D idx{i};
       elms.emplace_back(idx, std::make_unique<HelloTyped<int>>(InitialConsTag{}));
     }
   } else if (this_node % 2 == 1) {
-    for (int i = this_node*num_per; i < (this_node+1)*num_per; i++) {
+    for (int i = this_node.get()*num_per; i < (this_node.get()+1)*num_per; i++) {
       vt::Index1D idx{i};
       elms.emplace_back(idx, std::make_unique<HelloTyped<double>>(InitialConsTag{}));
     }