Revert "Convert bundling to bool"

This reverts commit 6237c87.

Adds back the enum for bundling

Author: tcclevenger

components/eamxx/src/dynamics/homme/eamxx_homme_process_interface.cpp

@@ -180,7 +180,7 @@ void HommeDynamics::set_grids (const std::shared_ptr<const GridsManager> grids_m
   add_field<Computed>("omega",              pg_scalar3d_mid, Pa/s,  pgn,N);
 
   add_tracer<Updated >("qv", m_phys_grid, kg/kg, N);
-  add_group<Updated>("tracers",pgn,N, true);
+  add_group<Updated>("tracers",pgn,N, Bundling::Required);
 
   if (fv_phys_active()) {
     // [CGLL ICs in pg2] Read CGLL IC data even though our in/out format is
@@ -196,7 +196,7 @@ void HommeDynamics::set_grids (const std::shared_ptr<const GridsManager> grids_m
     add_field<Required>("T_mid",         rg_scalar3d_mid,K,     rgn,N);
     add_field<Required>("ps",            rg_scalar2d    ,Pa,    rgn);
     add_field<Required>("phis",          rg_scalar2d    ,m2/s2, rgn);
-    add_group<Required>("tracers",rgn,N, true);
+    add_group<Required>("tracers",rgn,N, Bundling::Required);
     fv_phys_rrtmgp_active_gases_init(grids_manager);
     // This is needed for the dp_ref init in initialize_homme_state.
     add_field<Computed>("pseudo_density",rg_scalar3d_mid,Pa,    rgn,N);

components/eamxx/src/physics/iop_forcing/eamxx_iop_forcing_process_interface.cpp

@@ -29,7 +29,7 @@ void IOPForcing::set_grids(const std::shared_ptr<const GridsManager> grids_manag
   add_field<Updated>("T_mid", scalar3d_mid, K, grid_name, pack_size);
 
   add_tracer<Updated>("qv", m_grid, kg/kg, pack_size);
-  add_group<Updated>("tracers", grid_name, pack_size, true);
+  add_group<Updated>("tracers", grid_name, pack_size, Bundling::Required);
 
   // Sanity check that iop data manager is setup by driver
   EKAT_REQUIRE_MSG(m_iop_data_manager,

components/eamxx/src/physics/ml_correction/eamxx_ml_correction_process_interface.cpp

@@ -67,7 +67,7 @@ void MLCorrection::set_grids(
   add_field<Updated>("precip_ice_surf_mass", scalar2d,     kg/m2,  grid_name);
   /* ----------------------- WARNING --------------------------------*/
   add_tracer<Updated>("qv", m_grid, kg/kg, ps);
-  add_group<Updated>("tracers", grid_name, 1, true);
+  add_group<Updated>("tracers", grid_name, 1, Bundling::Required);
 }
 
 // =========================================================================================

components/eamxx/src/physics/shoc/eamxx_shoc_process_interface.cpp

@@ -111,7 +111,7 @@ void SHOCMacrophysics::set_grids(const std::shared_ptr<const GridsManager> grids
   } // Extra SHOC output diagnostics
 
   // Tracer group
-  add_group<Updated>("turbulence_advected_tracers", grid_name, ps, true);
+  add_group<Updated>("turbulence_advected_tracers", grid_name, ps, Bundling::Required);
 
   // Boundary flux fields for energy and mass conservation checks
   if (has_column_conservation_check()) {

components/eamxx/src/share/atm_process/atmosphere_process.hpp

@@ -369,13 +369,13 @@ class AtmosphereProcess : public ekat::enable_shared_from_this<AtmosphereProcess
   // Group requests
   template<RequestType RT>
   void add_group (const std::string& name, const std::string& grid_name,
-                  const bool bundled = false)
-  { add_group<RT> (GroupRequest(name,grid_name,bundled)); }
+                  const Bundling b = Bundling::NotNeeded)
+  { add_group<RT> (GroupRequest(name,grid_name,b)); }
 
   template<RequestType RT>
   void add_group (const std::string& name, const std::string& grid_name,
-                  const int pack_size, const bool bundled = false)
-  { add_group<RT> (GroupRequest(name,grid_name,pack_size,bundled)); }
+                  const int pack_size, const Bundling b = Bundling::NotNeeded)
+  { add_group<RT> (GroupRequest(name,grid_name,pack_size,b)); }
 
   template<RequestType RT>
   void add_field (const FieldRequest& req)

components/eamxx/src/share/field/field_manager.cpp

@@ -120,9 +120,9 @@ void FieldManager::register_group (const GroupRequest& req)
   auto& group_info = m_field_group_info[req.name];
   if (not group_info) {
     group_info = std::make_shared<FieldGroupInfo>(req.name);
-    group_info->m_bundled = (req.bundled);
+    group_info->m_bundled = (req.bundling==Bundling::Required);
   } else if (not group_info->m_bundled) {
-    group_info->m_bundled = (req.bundled);
+    group_info->m_bundled = (req.bundling==Bundling::Required);
   }
 
   if (not ekat::contains(group_info->m_requested_grids, req.grid)) {
@@ -409,7 +409,7 @@ void FieldManager::registration_ends ()
   for (auto& grid_it : m_grids_mgr->get_repo()) {
     for (const auto& greqs : m_group_requests.at(grid_it.second->name())) {
       for (const auto& r : greqs.second) {
-        if (r.bundled) {
+        if (r.bundling==Bundling::Required) {
           // There's at least one request for this group to be bundled.
           groups_to_bundle.push_back(greqs.first);
           break;

components/eamxx/src/share/field/field_request.hpp

@@ -13,6 +13,12 @@ enum RequestType {
   Updated   // For convenience, triggers Required+Computed
 };
 
+// Whether the bundling of a field group (see below) is needed, optional, or not needed.
+enum class Bundling : int {
+  Required,
+  NotNeeded
+};
+
 /*
  * A struct used to request a group of fields.
  *
@@ -34,26 +40,26 @@ struct GroupRequest {
   //  - grid: the grid where the group is requested
   //  - ps: the pack size that the allocation of the fields in the group
   //        (and the bundled field, if any) should accommodate (see field_alloc_prop.hpp)
-  //  - bundled: whether the group should be bundled (see field_group.hpp)
-  GroupRequest (const std::string& name_, const std::string& grid_, const int ps, const bool bundled_ = false)
-   : name(name_), grid(grid_), pack_size(ps), bundled(bundled_)
+  //  - bundling: whether the group should be bundled (see field_group.hpp)
+  GroupRequest (const std::string& name_, const std::string& grid_, const int ps, const Bundling b = Bundling::NotNeeded)
+   : name(name_), grid(grid_), pack_size(ps), bundling(b)
   {
     EKAT_REQUIRE_MSG(pack_size>=1, "Error! Invalid pack size request.\n");
   }
 
   GroupRequest (const std::string& name_, const std::string& grid_,
-                const bool bundled = false)
-   : GroupRequest(name_,grid_,1,bundled)
+                const Bundling b = Bundling::NotNeeded)
+   : GroupRequest(name_,grid_,1,b)
   { /* Nothing to do here */ }
 
   // Default copy ctor is perfectly fine
   GroupRequest (const GroupRequest&) = default;
 
   // Main parts of a group request
-  std::string name; // Group name
-  std::string grid; // Grid name
-  int pack_size;    // Request an allocation that can accomodate Pack<Real,pack_size>
-  bool bundled;     // Whether the group should be allocated as a single n+1 dimensional field
+  std::string name;   // Group name
+  std::string grid;   // Grid name
+  int pack_size;      // Request an allocation that can accomodate Pack<Real,pack_size>
+  Bundling bundling;  // Whether the group should be allocated as a single n+1 dimensional field
 };
 
 // In order to use GroupRequest in std sorted containers (like std::set),
@@ -83,7 +89,7 @@ inline bool operator< (const GroupRequest& lhs,
   }
 
   // Same pack size, order by bundling
-  return lhs.bundled<rhs.bundled;
+  return etoi(lhs.bundling)<etoi(rhs.bundling);
 }
 
 /*

components/eamxx/src/share/tests/field_tests.cpp

@@ -596,9 +596,10 @@ TEST_CASE("tracers_bundle", "") {
   field_mgr.register_field(FR{b_id,los{"tracers", "subtracers"}});
   field_mgr.register_field(FR{c_id,los{"tracers", "subtracers"}});
 
-  field_mgr.register_group(GroupRequest("tracers",gn1,true));
-  field_mgr.register_group(GroupRequest("tracers",gn2,true));
-  field_mgr.register_group(GroupRequest("subtracers",gn1,true));
+  field_mgr.register_group(GroupRequest("tracers",gn1,Bundling::Required));
+  field_mgr.register_group(GroupRequest("tracers",gn2,Bundling::Required));
+  field_mgr.register_group(GroupRequest("subtracers",gn1,Bundling::Required));
+  //field_mgr.register_group(GroupRequest("subtracers",gn2,Bundling::Required));
 
   field_mgr.registration_ends();