EAMxx: enforce a single value for FillValue across eamxx

Author: bartgol

components/eamxx/src/diagnostics/aodvis.cpp

@@ -49,40 +49,38 @@ void AODVis::initialize_impl(const RunType /*run_type*/) {
       m_diagnostic_output.get_header().get_identifier().get_grid_name();
   const auto var_fill_value = constants::DefaultFillValue<Real>().value;
 
-  m_mask_val = m_params.get<double>("mask_value", var_fill_value);
-
   std::string mask_name = name() + " mask";
   FieldLayout mask_layout({COL}, {m_ncols});
   FieldIdentifier mask_fid(mask_name, mask_layout, nondim, grid_name);
   Field diag_mask(mask_fid);
   diag_mask.allocate_view();
 
-  m_diagnostic_output.get_header().set_extra_data("mask_data", diag_mask);
-  m_diagnostic_output.get_header().set_extra_data("mask_value", m_mask_val);
+  m_diagnostic_output.get_header().set_extra_data("mask_field", diag_mask);
 }
 
 void AODVis::compute_diagnostic_impl() {
   using KT  = KokkosTypes<DefaultDevice>;
   using MT  = typename KT::MemberType;
   using ESU = ekat::ExeSpaceUtils<typename KT::ExeSpace>;
 
+  constexpr auto fill_value = constants::fill_value<Real>();
+
   const auto aod     = m_diagnostic_output.get_view<Real *>();
   const auto mask    = m_diagnostic_output.get_header()
-                        .get_extra_data<Field>("mask_data")
+                        .get_extra_data<Field>("mask_field")
                         .get_view<Real *>();
   const auto tau_vis = get_field_in("aero_tau_sw")
                            .subfield(1, m_vis_bnd)
                            .get_view<const Real **>();
   const auto sunlit = get_field_in("sunlit").get_view<const Real *>();
 
   const auto num_levs = m_nlevs;
-  const auto var_fill_value = m_mask_val;
   const auto policy   = ESU::get_default_team_policy(m_ncols, m_nlevs);
   Kokkos::parallel_for(
       "Compute " + m_diagnostic_output.name(), policy, KOKKOS_LAMBDA(const MT &team) {
         const int icol = team.league_rank();
         if(sunlit(icol) == 0.0) {
-          aod(icol) = var_fill_value;
+          aod(icol) = fill_value;
           Kokkos::single(Kokkos::PerTeam(team), [&] { mask(icol) = 0; });
         } else {
           auto tau_icol = ekat::subview(tau_vis, icol);

components/eamxx/src/diagnostics/aodvis.hpp

@@ -36,8 +36,6 @@ class AODVis : public AtmosphereDiagnostic {
 
   int m_swbands = eamxx_swbands();
   int m_vis_bnd = eamxx_vis_swband_idx();
-
-  Real m_mask_val;
 };
 
 }  // namespace scream

components/eamxx/src/diagnostics/field_at_pressure_level.cpp

@@ -85,16 +85,14 @@ initialize_impl (const RunType /*run_type*/)
   // Add a field representing the mask as extra data to the diagnostic field.
   auto nondim = ekat::units::Units::nondimensional();
   const auto& gname = fid.get_grid_name();
-  m_mask_val = m_params.get<double>("mask_value",Real(constants::DefaultFillValue<float>::value));
-
 
   std::string mask_name = m_diag_name + " mask";
   FieldLayout mask_layout( {COL}, {num_cols});
   FieldIdentifier mask_fid (mask_name,mask_layout, nondim, gname);
   Field diag_mask(mask_fid);
   diag_mask.allocate_view();
-  m_diagnostic_output.get_header().set_extra_data("mask_data",diag_mask);
-  m_diagnostic_output.get_header().set_extra_data("mask_value",m_mask_val);
+  m_diagnostic_output.get_header().set_extra_data("mask_field",diag_mask);
+  m_diagnostic_output.get_header().set_may_be_filled(true);
 
   using stratts_t = std::map<std::string,std::string>;
 
@@ -126,11 +124,11 @@ void FieldAtPressureLevel::compute_diagnostic_impl()
   const int nlevs = pl.dim(1);
 
   auto p_tgt = m_pressure_level;
-  auto mval = m_mask_val;
+  constexpr auto fval = constants::fill_value<Real>();
   if (rank==2) {
     auto policy = KT::RangePolicy(0,ncols);
     auto diag = m_diagnostic_output.get_view<Real*>();
-    auto mask = m_diagnostic_output.get_header().get_extra_data<Field>("mask_data").get_view<Real*>();
+    auto mask = m_diagnostic_output.get_header().get_extra_data<Field>("mask_field").get_view<Real*>();
     auto f_v  = f.get_view<const Real**>();
     Kokkos::parallel_for(policy,KOKKOS_LAMBDA(const int icol) {
       auto x1 = ekat::subview(p_src_v,icol);
@@ -139,7 +137,7 @@ void FieldAtPressureLevel::compute_diagnostic_impl()
       auto end = beg + nlevs;
       auto last = beg + (nlevs-1);
       if (p_tgt<*beg or p_tgt>*last) {
-        diag(icol) = mval;
+        diag(icol) = fval;
         mask(icol) = 0;
       } else {
         auto ub = ekat::upper_bound(beg,end,p_tgt);     
@@ -161,7 +159,7 @@ void FieldAtPressureLevel::compute_diagnostic_impl()
     const int ndims = f.get_header().get_identifier().get_layout().get_vector_dim();
     auto policy = KT::TeamPolicy(ncols,ndims);
     auto diag = m_diagnostic_output.get_view<Real**>();
-    auto mask = m_diagnostic_output.get_header().get_extra_data<Field>("mask_data").get_view<Real*>();
+    auto mask = m_diagnostic_output.get_header().get_extra_data<Field>("mask_field").get_view<Real*>();
     auto f_v  = f.get_view<const Real***>();
     Kokkos::parallel_for(policy,KOKKOS_LAMBDA(const MemberType& team) {
       int icol = team.league_rank();
@@ -171,7 +169,7 @@ void FieldAtPressureLevel::compute_diagnostic_impl()
       auto last = beg + (nlevs-1);
       Kokkos::parallel_for(Kokkos::TeamVectorRange(team,ndims),[&](const int idim) {
         if (p_tgt<*beg or p_tgt>*last) {
-          diag(icol,idim) = mval;
+          diag(icol,idim) = fval;
           Kokkos::single(Kokkos::PerTeam(team),[&]{
             mask(icol) = 0;
           });

components/eamxx/src/diagnostics/field_at_pressure_level.hpp

@@ -39,8 +39,6 @@ class FieldAtPressureLevel : public AtmosphereDiagnostic
 
   Real                m_pressure_level;
   int                 m_num_levs;
-  Real                m_mask_val;
-
 }; // class FieldAtPressureLevel
 
 } //namespace scream

components/eamxx/src/diagnostics/tests/field_at_pressure_level_tests.cpp

@@ -104,7 +104,7 @@ TEST_CASE("field_at_pressure_level_p2")
       diag_f.sync_to_host();
       auto test2_diag_v = diag_f.get_view<const Real*, Host>();
       // Check the mask field inside the diag_f
-      auto mask_f = diag_f.get_header().get_extra_data<Field>("mask_data");
+      auto mask_f = diag_f.get_header().get_extra_data<Field>("mask_field");
       mask_f.sync_to_host();
       auto test2_mask_v = mask_f.get_view<const Real*, Host>();
       //
@@ -125,13 +125,13 @@ TEST_CASE("field_at_pressure_level_p2")
       diag_f.sync_to_host();
       auto test2_diag_v = diag_f.get_view<const Real*, Host>();
       // Check the mask field inside the diag_f
-      auto mask_f = diag_f.get_header().get_extra_data<Field>("mask_data");
+      auto mask_f = diag_f.get_header().get_extra_data<Field>("mask_field");
       mask_f.sync_to_host();
       auto test2_mask_v = mask_f.get_view<const Real*, Host>();
-      auto mask_val = diag_f.get_header().get_extra_data<Real>("mask_value");
+      auto fill_val = constants::fill_value<Real>();
       //
       for (int icol=0;icol<ncols;icol++) {
-        REQUIRE(approx(test2_diag_v(icol),Real(mask_val)));
+        REQUIRE(approx(test2_diag_v(icol),Real(fill_val)));
         REQUIRE(approx(test2_mask_v(icol),Real(0.0)));
       }
     }

components/eamxx/src/physics/nudging/eamxx_nudging_process_interface.cpp

@@ -344,11 +344,7 @@ void Nudging::run_impl (const double dt)
     const auto fl = f.get_header().get_identifier().get_layout();
     const auto v  = f.get_view<Real**>();
 
-    Real var_fill_value = constants::DefaultFillValue<Real>().value;
-    // Query the helper field for the fill value, if not present use default
-    if (f.get_header().has_extra_data("mask_value")) {
-      var_fill_value = f.get_header().get_extra_data<Real>("mask_value");
-    }
+    constexpr Real var_fill_value = constants::fill_value<Real>();
 
     const int ncols = fl.dim(0);
     const int nlevs = fl.dim(1);

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

@@ -89,6 +89,9 @@ class FieldHeader : public FamilyTracking<FieldHeader> {
   //   - they have the same tracking, alloc_prop and extra data (they were created by alias above)
   //   - they have the same parent field and their subview info (form alloc prop) are the same
   bool is_aliasing (const FieldHeader& rhs) const;
+
+  bool may_be_filled () const { return has_extra_data("may_be_filled") and get_extra_data<bool>("may_be_filled"); }
+  void set_may_be_filled (const bool value) { set_extra_data("may_be_filled",value); }
 protected:
 
   // Friend this function, so it can set up a subfield header