Merge branch 'bartgol/eamxx/dump-fields-dictionary' (PR #6842)

The option (off by default) allows to save a yaml file containing a dictionary of the fields on the "Physics" grid, with some of their details.

Author: bartgol

components/eamxx/cime_config/namelist_defaults_scream.xml

@@ -717,6 +717,7 @@ be lost if SCREAM_HACK_XML is not enabled.
   <!-- driver_options options for scream -->
   <driver_options>
     <atmosphere_dag_verbosity_level>0</atmosphere_dag_verbosity_level>
+    <save_field_manager_dictionary type="logical">false</save_field_manager_dictionary>
     <atm_log_level type="string"
                    valid_values="trace,debug,info,warn,error"
                    doc="Verbosity level for the atm logger">

components/eamxx/src/control/atmosphere_driver.cpp

@@ -687,6 +687,47 @@ void AtmosphereDriver::create_fields()
 
   m_ad_status |= s_fields_created;
 
+  // If the user requested it, we can save a dictionary of the FM fields to file
+  auto& driver_options_pl = m_atm_params.sublist("driver_options");
+  if (driver_options_pl.get("save_field_manager_content",false)) {
+    auto pg = m_grids_manager->get_grid("Physics");
+    const auto& fm = m_field_mgrs.at(pg->name());
+    ekat::ParameterList pl_out("field_manager_content");
+    pl_out.sublist("provenance") = m_atm_params.sublist("provenance");
+    DefaultMetadata std_names;
+    std::string desc;
+    desc = "content of the EAMxx FieldManager corresponding to the 'Physics' grid.\n"
+           "The dict keys are the field names as used in EAMxx.\n"
+           "For each field, we add the following entries:\n"
+           "  - standard_name: the name commonly used to refer to this field in atm sciences (if applicable)\n"
+           "  - units: the units for this field used in EAMxx\n"
+           "  - layout: the names of the dimensions for this field (time excluded)\n"
+           "  - providers: the atm processes that update/compute this field\n"
+           "  - customers: the atm processes that require this field as an input\n";
+    pl_out.set("description", desc);
+    auto& dict = pl_out.sublist("fields");
+    for (const auto& it : *fm) {
+      const auto& fid = it.second->get_header().get_identifier();
+      auto& pl = dict.sublist(fid.name());
+
+      pl.set("units",fid.get_units().to_string());
+      pl.set("layout",fid.get_layout().names());
+      pl.set("standard_name",std_names.get_standardname(fid.name()));
+      std::vector<std::string> providers,customers;
+      const auto& track = it.second->get_header().get_tracking();
+      for (auto ap : track.get_providers()) {
+        providers.push_back(ap.lock()->name());
+      }
+      for (auto ap : track.get_customers()) {
+        customers.push_back(ap.lock()->name());
+      }
+      pl.set("providers",providers);
+      pl.set("customers",customers);
+    }
+
+    ekat::write_yaml_file("eamxx_field_manager_content.yaml",pl_out);
+  }
+
   stop_timer("EAMxx::create_fields");
   stop_timer("EAMxx::init");
   m_atm_logger->info("[EAMxx] create_fields ... done!");

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

@@ -896,6 +896,8 @@ get_field_in_impl(const std::string& field_name, const std::string& grid_name) c
         "   field name: " + field_name + "\n"
         "   grid name: " + grid_name + "\n");
   }
+  static Field f;
+  return f;
 }
 
 Field& AtmosphereProcess::
@@ -917,6 +919,8 @@ get_field_in_impl(const std::string& field_name) const {
         "   atm proc name: " + this->name() + "\n"
         "   field name: " + field_name + "\n");
   }
+  static Field f;
+  return f;
 }
 
 Field& AtmosphereProcess::
@@ -932,6 +936,8 @@ get_field_out_impl(const std::string& field_name, const std::string& grid_name)
         "   field name: " + field_name + "\n"
         "   grid name: " + grid_name + "\n");
   }
+  static Field f;
+  return f;
 }
 
 Field& AtmosphereProcess::
@@ -953,6 +959,8 @@ get_field_out_impl(const std::string& field_name) const {
         "   atm proc name: " + this->name() + "\n"
         "   field name: " + field_name + "\n");
   }
+  static Field f;
+  return f;
 }
 
 FieldGroup& AtmosphereProcess::
@@ -968,6 +976,8 @@ get_group_in_impl(const std::string& group_name, const std::string& grid_name) c
         "   group name: " + group_name + "\n"
         "   grid name: " + grid_name + "\n");
   }
+  static FieldGroup g("");
+  return g;
 }
 
 FieldGroup& AtmosphereProcess::
@@ -989,6 +999,8 @@ get_group_in_impl(const std::string& group_name) const {
         "   atm proc name: " + this->name() + "\n"
         "   group name: " + group_name + "\n");
   }
+  static FieldGroup g("");
+  return g;
 }
 
 FieldGroup& AtmosphereProcess::
@@ -1004,6 +1016,8 @@ get_group_out_impl(const std::string& group_name, const std::string& grid_name)
         "   group name: " + group_name + "\n"
         "   grid name: " + grid_name + "\n");
   }
+  static FieldGroup g("");
+  return g;
 }
 
 FieldGroup& AtmosphereProcess::
@@ -1025,6 +1039,8 @@ get_group_out_impl(const std::string& group_name) const {
         "   atm proc name: " + this->name() + "\n"
         "   group name: " + group_name + "\n");
   }
+  static FieldGroup g("");
+  return g;
 }
 
 Field& AtmosphereProcess::
@@ -1040,6 +1056,8 @@ get_internal_field_impl(const std::string& field_name, const std::string& grid_n
         "   field name: " + field_name + "\n"
         "   grid name: " + grid_name + "\n");
   }
+  static Field f;
+  return f;
 }
 
 Field& AtmosphereProcess::
@@ -1061,6 +1079,8 @@ get_internal_field_impl(const std::string& field_name) const {
         "   atm proc name: " + this->name() + "\n"
         "   field name: " + field_name + "\n");
   }
+  static Field f;
+  return f;
 }
 
 void AtmosphereProcess

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

@@ -349,6 +349,7 @@ class Field {
   get_subview_1 (const get_view_type<data_nd_t<T,N>,HD>&, const int) const {
     EKAT_ERROR_MSG ("Error! Cannot subview a rank2 view along the second "
                     "dimension without losing LayoutRight.\n");
+    return get_view_type<data_nd_t<T,N-1>,HD>();
   }
 
   template<HostOrDevice HD,typename T,int N>

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

@@ -966,6 +966,7 @@ auto Field::get_ND_view () const
                  "MaxRank = 6.\n"
                  "This should never be called at run time.\n"
                  "Please contact developer if this functionality is required\n");
+  return get_view_type<data_nd_t<T,N>,HD>();
 }
 
 } // namespace scream

components/eamxx/src/share/grid/library_grids_manager.hpp

@@ -41,6 +41,7 @@ class LibraryGridsManager : public GridsManager
         "Error! LibraryGridsManager is not capable of creating remappers.\n"
         " - from_grid: " + from_grid->name() + "\n"
         " - to_grid:   " + to_grid->name() + "\n");
+    return nullptr;
   }
 };
 

components/eamxx/src/share/grid/remap/vertical_remapper.cpp

@@ -81,6 +81,7 @@ create_src_layout (const FieldLayout& tgt_layout) const
   // we cannot infer what the corresponding src layout was.
   // This function should never be used for this remapper.
   EKAT_ERROR_MSG ("Error! VerticalRemapper does not support creating a src layout from a tgt layout.\n");
+  return FieldLayout();
 }
 
 FieldLayout VerticalRemapper::

components/eamxx/src/share/io/scorpio_output.cpp

@@ -1314,6 +1314,8 @@ get_field(const std::string& name, const std::string& mode) const
   } else {
     EKAT_ERROR_MSG ("ERROR::AtmosphereOutput::get_field Field " + name + " not found in " + mode + " field manager or diagnostics list.");
   }
+  static Field f;
+  return f;
 }
 /* ---------------------------------------------------------- */
 void AtmosphereOutput::set_diagnostics()

components/eamxx/src/share/io/scorpio_output.hpp

@@ -6,7 +6,8 @@
 #include "share/field/field_manager.hpp"
 #include "share/grid/abstract_grid.hpp"
 #include "share/grid/grids_manager.hpp"
-#include "share/util//scream_time_stamp.hpp"
+#include "share/util/scream_time_stamp.hpp"
+#include "share/util/scream_utils.hpp"
 #include "share/atm_process/atmosphere_diagnostic.hpp"
 
 #include "ekat/ekat_parameter_list.hpp"

components/eamxx/src/share/io/scream_io_file_specs.hpp

@@ -56,6 +56,7 @@ struct StorageSpecs {
       default:
         EKAT_ERROR_MSG ("Error! Unrecognized/unsupported file storage type.\n");
     }
+    return false;
   }
 
   void update_storage (const util::TimeStamp& t) {