EAMxx: use fill val in cosp for night indices

Author: mahf708

components/eamxx/cime_config/testdefs/testmods_dirs/eamxx/mvkpert/yaml_outs/monthly_average_coarse.yaml

@@ -84,7 +84,6 @@ fields:
     - isccp_ctptau
     - modis_ctptau
     - misr_cthtau
-    - cosp_sunlit
     - isccp_cldtot
 
 output_control:

components/eamxx/cime_config/testdefs/testmods_dirs/eamxx/prod/yaml_outs/eamxx_output.decadal.1hourlyAVG_native.yaml

@@ -11,7 +11,6 @@ fields:
     - isccp_ctptau
     - modis_ctptau
     - misr_cthtau
-    - cosp_sunlit
     - isccp_cldtot
 output_control:
   frequency: 1

components/eamxx/cime_config/testdefs/testmods_dirs/eamxx/prod/yaml_outs/eamxx_output.decadal.hourlyAVG_coarse.yaml

@@ -84,7 +84,6 @@ fields:
     - isccp_ctptau
     - modis_ctptau
     - misr_cthtau
-    - cosp_sunlit
     - isccp_cldtot
 
 output_control:

components/eamxx/src/physics/cosp/eamxx_cosp.cpp

@@ -1,6 +1,7 @@
 #include "eamxx_cosp.hpp"
 #include "cosp_functions.hpp"
 #include "physics/share/physics_constants.hpp"
+#include "share/util/eamxx_universal_constants.hpp"
 #include "share/property_checks/field_within_interval_check.hpp"
 #include "share/field/field_utils.hpp"
 
@@ -88,11 +89,11 @@ void Cosp::set_grids(const std::shared_ptr<const GridsManager> grids_manager)
   add_field<Required>("eff_radius_qc",     scalar3d_mid, micron,      grid_name);
   add_field<Required>("eff_radius_qi",     scalar3d_mid, micron,      grid_name);
   // Set of fields used strictly as output
+  // NOTE we set their correspond masks in init impl
   add_field<Computed>("isccp_cldtot", scalar2d, percent, grid_name);
   add_field<Computed>("isccp_ctptau", scalar4d_ctptau, percent, grid_name, 1);
   add_field<Computed>("modis_ctptau", scalar4d_ctptau, percent, grid_name, 1);
   add_field<Computed>("misr_cthtau", scalar4d_cthtau, percent, grid_name, 1);
-  add_field<Computed>("cosp_sunlit", scalar2d, nondim, grid_name);
 
   // We can allocate these now
   m_z_mid = Field(FieldIdentifier("z_mid",scalar3d_mid,m,grid_name));
@@ -107,15 +108,12 @@ void Cosp::initialize_impl (const RunType /* run_type */)
   // Set property checks for fields in this process
   CospFunc::initialize(m_num_cols, m_num_subcols, m_num_levs);
 
-
-  // Add note to output files about processing ISCCP fields that are only valid during
-  // daytime. This can go away once I/O can handle masked time averages.
+  // Set a mask field for each of the cosp computed fields
   using stratts_t = std::map<std::string,std::string>;
   std::list<std::string> vnames = {"isccp_cldtot", "isccp_ctptau", "modis_ctptau", "misr_cthtau"};
   for (const auto field_name : {"isccp_cldtot", "isccp_ctptau", "modis_ctptau", "misr_cthtau"}) {
       auto& f = get_field_out(field_name);
-      auto& atts = f.get_header().get_extra_data<stratts_t>("io: string attributes");
-      atts["note"] = "Night values are zero; divide by cosp_sunlit to get daytime mean";
+      f.get_header().set_extra_data("mask_field", f.clone(field_name + "_mask"));
   }
 }
 
@@ -221,31 +219,50 @@ void Cosp::run_impl (const double dt)
     const auto dtau105_h = get_field_in("dtau105").get_view<const Real**, Host>();
 
     auto isccp_cldtot_h = get_field_out("isccp_cldtot").get_view<Real*, Host>();
+    auto isccp_cldtot_h_mask = get_field_out("isccp_cldtot").get_header().get_extra_data<Field>("mask_field").get_view<Real*, Host>();
     auto isccp_ctptau_h = get_field_out("isccp_ctptau").get_view<Real***, Host>();
+    auto isccp_ctptau_h_mask = get_field_out("isccp_ctptau").get_header().get_extra_data<Field>("mask_field").get_view<Real***, Host>();
     auto modis_ctptau_h = get_field_out("modis_ctptau").get_view<Real***, Host>();
+    auto modis_ctptau_h_mask = get_field_out("modis_ctptau").get_header().get_extra_data<Field>("mask_field").get_view<Real***, Host>();
     auto misr_cthtau_h  = get_field_out("misr_cthtau").get_view<Real***, Host>();
-    auto cosp_sunlit_h  = get_field_out("cosp_sunlit").get_view<Real*, Host>();  // Copy of sunlit flag with COSP frequency for proper averaging
+    auto misr_cthtau_h_mask = get_field_out("misr_cthtau").get_header().get_extra_data<Field>("mask_field").get_view<Real***, Host>();
 
     Real emsfc_lw = 0.99;
-    Kokkos::deep_copy(cosp_sunlit_h, sunlit_h);
     CospFunc::main(
             m_num_cols, m_num_subcols, m_num_levs, m_num_tau, m_num_ctp, m_num_cth, emsfc_lw,
             sunlit_h, skt_h, T_mid_h, p_mid_h, p_int_h, z_mid_h, qv_h, qc_h, qi_h,
             cldfrac_h, reff_qc_h, reff_qi_h, dtau067_h, dtau105_h,
             isccp_cldtot_h, isccp_ctptau_h, modis_ctptau_h, misr_cthtau_h
     );
-    // Remask night values to ZERO since our I/O does not know how to handle masked/missing values
-    // in temporal averages; this is all host data, so we can just use host loops like its the 1980s
+    // Mask night values
+    constexpr auto fill_value = constants::fill_value<Real>;
     for (int i = 0; i < m_num_cols; i++) {
       if (sunlit_h(i) == 0) {
-        isccp_cldtot_h(i) = 0;
+        // if night, set to fill val and set mask to 0
+        isccp_cldtot_h(i) = fill_value;
+        isccp_cldtot_h_mask(i) = 0;
+        for (int j = 0; j < m_num_tau; j++) {
+          for (int k = 0; k < m_num_ctp; k++) {
+            isccp_ctptau_h(i,j,k) = fill_value;
+            isccp_ctptau_h_mask(i,j,k) = 0;
+            modis_ctptau_h(i,j,k) = fill_value;
+            modis_ctptau_h_mask(i,j,k) = 0;
+          }
+          for (int k = 0; k < m_num_cth; k++) {
+            misr_cthtau_h (i,j,k) = fill_value;
+            misr_cthtau_h_mask(i,j,k) = 0;
+          }
+        }
+      } else {
+        // if NOT night, persist and set mask to 1
+        isccp_cldtot_h_mask(i) = 1;
         for (int j = 0; j < m_num_tau; j++) {
           for (int k = 0; k < m_num_ctp; k++) {
-            isccp_ctptau_h(i,j,k) = 0;
-            modis_ctptau_h(i,j,k) = 0;
+            isccp_ctptau_h_mask(i,j,k) = 1;
+            modis_ctptau_h_mask(i,j,k) = 1;
           }
           for (int k = 0; k < m_num_cth; k++) {
-            misr_cthtau_h (i,j,k) = 0;
+            misr_cthtau_h_mask(i,j,k) = 1;
           }
         }
       }
@@ -256,7 +273,6 @@ void Cosp::run_impl (const double dt)
     get_field_out("isccp_ctptau").sync_to_dev();
     get_field_out("modis_ctptau").sync_to_dev();
     get_field_out("misr_cthtau").sync_to_dev();
-    get_field_out("cosp_sunlit").sync_to_dev();
   }
 }