EAMxx: turn on/off linoz.

Author: odiazib

components/eamxx/cime_config/namelist_defaults_eamxx.xml

@@ -229,7 +229,7 @@ be lost if SCREAM_HACK_XML is not enabled.
       <constant_mu_rain type="real" doc="Constant shape parameter (mu) in the rain droplet distribution">1.0</constant_mu_rain>
       <spa_ccn_to_nc_factor type="real" doc="Scaling factor for turning SPA ccn into P3 nc">2000.0</spa_ccn_to_nc_factor>
       <spa_ccn_to_nc_factor hgrid="ne256np4.pg2">1000.0</spa_ccn_to_nc_factor>
-      <spa_ccn_to_nc_exponent type="real" doc="Exponent for turning SPA ccn into P3 nc">0.55</spa_ccn_to_nc_exponent>      
+      <spa_ccn_to_nc_exponent type="real" doc="Exponent for turning SPA ccn into P3 nc">0.55</spa_ccn_to_nc_exponent>
       <cldliq_to_ice_collection_factor type="real" doc="Cloud liquid to ice collection scaling factor">0.5</cldliq_to_ice_collection_factor>
       <rain_to_ice_collection_factor type="real" doc="Rain to ice collection scaling factor">1.0</rain_to_ice_collection_factor>
       <min_rime_rho type="real" doc="Minimum rime density in kg/m3">50.0</min_rime_rho>
@@ -312,6 +312,7 @@ be lost if SCREAM_HACK_XML is not enabled.
       <mam4_do_coag   type="logical" doc="Switch to enable aerosol microphysics coagulation process">true</mam4_do_coag>
       <mam4_do_rename type="logical" doc="Switch to enable aerosol microphysics rename process">true</mam4_do_rename>
       <!-- LINOZ parameters -->
+      <mam4_run_linoz    type="logical"    doc="turn on/off linoz computation">true</mam4_run_linoz>
       <mam4_o3_tau    type="real"    doc="Linoz tau parameter">172800.0</mam4_o3_tau>
       <mam4_o3_sfc    type="real"    doc="Linoz surface parameter">3.0E-008</mam4_o3_sfc>
       <mam4_o3_lbl    type="integer" doc="Linoz lbl parameter">4</mam4_o3_lbl>
@@ -562,6 +563,7 @@ be lost if SCREAM_HACK_XML is not enabled.
       </do_subcol_sampling>
       <pool_size_multiplier type="real">1.0</pool_size_multiplier>
       <force_run_after_restart type="logical" doc="Force rad to run on first step after restart, regardless of rad frequency">false</force_run_after_restart>
+
     </rrtmgp>
 
     <mac_aero_mic inherit="atm_proc_group">

components/eamxx/src/physics/mam/eamxx_mam_microphysics_process_interface.cpp

@@ -35,10 +35,15 @@ MAMMicrophysics::MAMMicrophysics(const ekat::Comm &comm,
   config_.amicphys.newnuc_h2so4_conc_optaa = 2;
 
   // LINOZ namelist parameters
-  config_.linoz.o3_lbl = m_params.get<int>("mam4_o3_lbl");
-  config_.linoz.o3_tau = m_params.get<double>("mam4_o3_tau");
-  config_.linoz.o3_sfc = m_params.get<double>("mam4_o3_sfc");
-  config_.linoz.psc_T  = m_params.get<double>("mam4_psc_T");
+  config_.linoz.compute = m_params.get<bool>("mam4_run_linoz", true);
+
+  if (config_.linoz.compute) {
+    config_.linoz.o3_lbl = m_params.get<int>("mam4_o3_lbl");
+    config_.linoz.o3_tau = m_params.get<double>("mam4_o3_tau");
+    config_.linoz.o3_sfc = m_params.get<double>("mam4_o3_sfc");
+    config_.linoz.psc_T  = m_params.get<double>("mam4_psc_T");
+  }
+
 }
 // ================================================================
 //  SET_GRIDS
@@ -231,7 +236,7 @@ void MAMMicrophysics::set_grids(
 
   // Creating a Linoz reader and setting Linoz parameters involves reading data
   // from a file and configuring the necessary parameters for the Linoz model.
-  {
+  if (config_.linoz.compute) {
     linoz_file_name_ = m_params.get<std::string>("mam4_linoz_file_name");
     const std::string linoz_map_file =
         m_params.get<std::string>("aero_microphys_remap_file", "");
@@ -383,6 +388,7 @@ void MAMMicrophysics::set_grids(
     mam_coupling::find_season_index_reader(season_wes_file, clat,
                                            index_season_lai_);
   }
+
 }  // set_grids
 
 // ================================================================
@@ -531,39 +537,39 @@ void MAMMicrophysics::initialize_impl(const RunType run_type) {
     //the units are mixed and the user should be careful when using these fields.
     //Following map contains the map of fields with mixed units and their long names.
     const std::map<std::string, std::string>  mixed_units_fields = {
-      {"mam4_microphysics_tendency_gas_phase_chemistry", 
+      {"mam4_microphysics_tendency_gas_phase_chemistry",
       "MAM4xx microphysics tendencies due to gas phase chemistry [mixed units: kg/kg/s or #/kg/s]"},
 
       {"mam4_microphysics_tendency_aqueous_chemistry",
       "MAM4xx microphysics tendencies due to aqueous chemistry [mixed units: kg/kg/s or #/kg/s]"},
 
-      {"mam4_microphysics_tendency_aqso4", 
+      {"mam4_microphysics_tendency_aqso4",
       "MAM4xx microphysics tendencies due to aqueous SO4 [mixed units: kg/kg/s or #/kg/s]"},
 
-      {"mam4_microphysics_tendency_aqh2so4", 
+      {"mam4_microphysics_tendency_aqh2so4",
       "MAM4xx microphysics tendencies due to aqueous H2SO4 [mixed units: kg/kg/s or #/kg/s]"},
 
-      {"mam4_microphysics_tendency_condensation", 
+      {"mam4_microphysics_tendency_condensation",
       "MAM4xx microphysics tendencies due to gas aerosol exchange (condensation) [mixed units: mol/mol/s or #/mol/s]"},
 
-      {"mam4_microphysics_tendency_renaming", 
+      {"mam4_microphysics_tendency_renaming",
       "MAM4xx microphysics tendencies due to gas aerosol exchange (renaming) [mixed units: mol/mol/s or #/mol/s]"},
 
-      {"mam4_microphysics_tendency_nucleation", 
+      {"mam4_microphysics_tendency_nucleation",
       "MAM4xx microphysics tendencies due to gas aerosol exchange (nucleation) [mixed units: mol/mol/s or #/mol/s]"},
 
-      {"mam4_microphysics_tendency_coagulation", 
+      {"mam4_microphysics_tendency_coagulation",
       "MAM4xx microphysics tendencies due to gas aerosol exchange (coagulation) [mixed units: mol/mol/s or #/mol/s]"},
 
-      {"mam4_microphysics_tendency_renaming_cloud_borne", 
+      {"mam4_microphysics_tendency_renaming_cloud_borne",
       "MAM4xx microphysics tendencies due to gas aerosol exchange (renaming cloud borne) [mixed units: mol/mol/s or #/mol/s]"},
-      
+
     };
     // Add docstring to the fields with mixed units
     add_io_docstring_to_fields_with_mixed_units(mixed_units_fields);
   }
 
-   
+
   // set field property checks for the fields in this process
   /* e.g.
   using Interval = FieldWithinIntervalCheck;
@@ -574,7 +580,7 @@ void MAMMicrophysics::initialize_impl(const RunType run_type) {
   add_postcondition_check<LowerBound>(get_field_out("tke"),m_grid,0);
   */
 
-  {
+  if (config_.linoz.compute) {
     // climatology data for linear stratospheric chemistry
     auto linoz_o3_clim = buffer_.scratch[0];  // ozone (climatology) [vmr]
     auto linoz_o3col_clim =
@@ -599,7 +605,7 @@ void MAMMicrophysics::initialize_impl(const RunType run_type) {
     scream::mam_coupling::create_linoz_chlorine_reader(
         linoz_chlorine_file, ts, chlorine_loading_ymd, chlorine_values_,
         chlorine_time_secs_);
-  }  // LINOZ
+  }
 
   init_temporary_views();
   // FIXME : why are we only using nlev_ instead of ncol_xnlev?
@@ -608,10 +614,10 @@ void MAMMicrophysics::initialize_impl(const RunType run_type) {
   // Note: At the first time step, the data will be moved into extfrc_lst_beg,
   //       and extfrc_lst_end will be reloaded from file with the new month.
   const int curr_month = start_of_step_ts().get_month() - 1;  // 0-based
-
-  scream::mam_coupling::update_tracer_data_from_file(
+  if (config_.linoz.compute) {
+    scream::mam_coupling::update_tracer_data_from_file(
       LinozDataReader_, curr_month, *LinozHorizInterp_, linoz_data_);
-
+  }
   scream::mam_coupling::update_tracer_data_from_file(
       TracerDataReader_, curr_month, *TracerHorizInterp_, tracer_data_);
 
@@ -730,38 +736,44 @@ void MAMMicrophysics::run_impl(const double dt) {
 
   // climatology data for linear stratospheric chemistry
   // ozone (climatology) [vmr]
-  auto linoz_o3_clim = buffer_.scratch[0];
+  view_2d linoz_o3_clim;
   // column o3 above box (climatology) [Dobson Units (DU)]
-  auto linoz_o3col_clim = buffer_.scratch[1];
-  auto linoz_t_clim     = buffer_.scratch[2];  // temperature (climatology) [K]
-  auto linoz_PmL_clim = buffer_.scratch[3];  // P minus L (climatology) [vmr/s]
+  view_2d linoz_o3col_clim;
+  // temperature (climatology) [K]
+  view_2d linoz_t_clim;
+  // P minus L (climatology) [vmr/s]
+  view_2d linoz_PmL_clim;
   // sensitivity of P minus L to O3 [1/s]
-  auto linoz_dPmL_dO3 = buffer_.scratch[4];
+  view_2d linoz_dPmL_dO3;
   // sensitivity of P minus L to T3 [K]
-  auto linoz_dPmL_dT = buffer_.scratch[5];
+  view_2d linoz_dPmL_dT;
   // sensitivity of P minus L to overhead O3 column [vmr/DU]
-  auto linoz_dPmL_dO3col = buffer_.scratch[6];
+  view_2d linoz_dPmL_dO3col;
   // Cariolle parameter for PSC loss of ozone [1/s]
-  auto linoz_cariolle_pscs = buffer_.scratch[7];
-
-  view_2d linoz_output[8];
-  linoz_output[0] = linoz_o3_clim;
-  linoz_output[1] = linoz_o3col_clim;
-  linoz_output[2] = linoz_t_clim;
-  linoz_output[3] = linoz_PmL_clim;
-  linoz_output[4] = linoz_dPmL_dO3;
-  linoz_output[5] = linoz_dPmL_dT;
-  linoz_output[6] = linoz_dPmL_dO3col;
-  linoz_output[7] = linoz_cariolle_pscs;
+  view_2d linoz_cariolle_pscs;
+
+  if (config_.linoz.compute) {
+    linoz_o3_clim = buffer_.scratch[0];
+    linoz_o3col_clim = buffer_.scratch[1];
+    linoz_t_clim     = buffer_.scratch[2];
+    linoz_PmL_clim = buffer_.scratch[3];
+    linoz_dPmL_dO3 = buffer_.scratch[4];
+    linoz_dPmL_dT = buffer_.scratch[5];
+    linoz_dPmL_dO3col = buffer_.scratch[6];
+    linoz_cariolle_pscs = buffer_.scratch[7];
+  }
   // it's a bit wasteful to store this for all columns, but simpler from an
   // allocation perspective
   auto o3_col_dens = buffer_.scratch[8];
 
   /* Gather time and state information for interpolation */
   const auto ts = end_of_step_ts();
 
+  if (config_.linoz.compute) {
   const Real chlorine_loading = scream::mam_coupling::chlorine_loading_advance(
       ts, chlorine_values_, chlorine_time_secs_);
+    config_.linoz.chlorine_loading=chlorine_loading;
+  }
 
   // Update the TracerTimeState to reflect the current time
   trace_time_state_.t_now = ts.frac_of_year_in_days();
@@ -774,15 +786,26 @@ void MAMMicrophysics::run_impl(const double dt) {
       cnst_offline_);                    // out
   Kokkos::fence();
 
-  scream::mam_coupling::advance_tracer_data(
+  if (config_.linoz.compute) {
+    view_2d linoz_output[8];
+    linoz_output[0] = linoz_o3_clim;
+    linoz_output[1] = linoz_o3col_clim;
+    linoz_output[2] = linoz_t_clim;
+    linoz_output[3] = linoz_PmL_clim;
+    linoz_output[4] = linoz_dPmL_dO3;
+    linoz_output[5] = linoz_dPmL_dT;
+    linoz_output[6] = linoz_dPmL_dO3col;
+    linoz_output[7] = linoz_cariolle_pscs;
+
+    scream::mam_coupling::advance_tracer_data(
       LinozDataReader_,                  // in
       *LinozHorizInterp_,                // out
       ts,                                // in
       linoz_time_state_, linoz_data_,    // out
       dry_atm_.p_mid, dry_atm_.z_iface,  // in
       linoz_output);                     // out
-  Kokkos::fence();
-
+    Kokkos::fence();
+  }
 
   int i                            = 0;
   for(const auto &var_name : extfrc_lst_) {
@@ -804,6 +827,7 @@ void MAMMicrophysics::run_impl(const double dt) {
   mam_coupling::DryAtmosphere &dry_atm = dry_atm_;
   mam_coupling::AerosolState &dry_aero = dry_aero_;
 
+
   mam4::mo_photo::PhotoTableData &photo_table = photo_table_;
   const Config &config                        = config_;
   const auto &work_photo_table                = work_photo_table_;
@@ -894,10 +918,10 @@ void MAMMicrophysics::run_impl(const double dt) {
   const auto &index_season_lai = index_season_lai_;
   const int pcnst              = mam4::pcnst;
   const bool extra_mam4_aero_microphys_diags  = extra_mam4_aero_microphys_diags_;
-
   //NOTE: we need to initialize photo_rates_
   Kokkos::deep_copy(photo_rates_,0.0);
-  // loop over atmosphere columns and compute aerosol microphyscs
+  // loop over atmosphere columns and compute aerosol microphysics
+
   Kokkos::parallel_for(
       "MAMMicrophysics::run_impl", policy,
       KOKKOS_LAMBDA(const ThreadTeam &team) {
@@ -943,7 +967,6 @@ void MAMMicrophysics::run_impl(const double dt) {
         for(int i = 0; i < mam4::mo_setinv::num_tracer_cnst; ++i) {
           cnst_offline_icol[i] = ekat::subview(cnst_offline[i], icol);
         }
-
         // calculate o3 column densities (first component of col_dens in Fortran
         // code)
         auto o3_col_dens_i = ekat::subview(o3_col_dens, icol);
@@ -952,17 +975,20 @@ void MAMMicrophysics::run_impl(const double dt) {
 
         const auto &photo_rates_icol = ekat::subview(photo_rates, icol);
 
-        const auto linoz_o3_clim_icol = ekat::subview(linoz_o3_clim, icol);
-        const auto linoz_t_clim_icol  = ekat::subview(linoz_t_clim, icol);
-        const auto linoz_o3col_clim_icol =
+        mam4::microphysics::LinozData linoz_data;
+        if (config.linoz.compute) {
+          linoz_data.linoz_o3_clim_icol = ekat::subview(linoz_o3_clim, icol);
+          linoz_data.linoz_t_clim_icol  = ekat::subview(linoz_t_clim, icol);
+          linoz_data.linoz_o3col_clim_icol =
             ekat::subview(linoz_o3col_clim, icol);
-        const auto linoz_PmL_clim_icol = ekat::subview(linoz_PmL_clim, icol);
-        const auto linoz_dPmL_dO3_icol = ekat::subview(linoz_dPmL_dO3, icol);
-        const auto linoz_dPmL_dT_icol  = ekat::subview(linoz_dPmL_dT, icol);
-        const auto linoz_dPmL_dO3col_icol =
+          linoz_data.linoz_PmL_clim_icol = ekat::subview(linoz_PmL_clim, icol);
+          linoz_data.linoz_dPmL_dO3_icol = ekat::subview(linoz_dPmL_dO3, icol);
+          linoz_data.linoz_dPmL_dT_icol  = ekat::subview(linoz_dPmL_dT, icol);
+          linoz_data.linoz_dPmL_dO3col_icol =
             ekat::subview(linoz_dPmL_dO3col, icol);
-        const auto linoz_cariolle_pscs_icol =
+          linoz_data.linoz_cariolle_pscs_icol =
             ekat::subview(linoz_cariolle_pscs, icol);
+        }
         const auto nevapr_icol       = ekat::subview(nevapr, icol);
         const auto prain_icol        = ekat::subview(prain, icol);
         const auto work_set_het_icol = ekat::subview(work_set_het, icol);
@@ -1036,16 +1062,15 @@ void MAMMicrophysics::run_impl(const double dt) {
         mam4::microphysics::perform_atmospheric_chemistry_and_microphysics(
             team, dt, rlats, sfc_temperature(icol), sfc_pressure(icol),
             wind_speed, rain, solar_flux, cnst_offline_icol, forcings_in, atm,
-            photo_table, chlorine_loading, config.setsox, config.amicphys,
-            config.linoz.psc_T, zenith_angle(icol), d_sfc_alb_dir_vis(icol),
+            photo_table,  config.setsox, config.amicphys,
+             zenith_angle(icol), d_sfc_alb_dir_vis(icol),
             o3_col_dens_i, photo_rates_icol, extfrc_icol, invariants_icol,
-            work_photo_table_icol, linoz_o3_clim_icol, linoz_t_clim_icol,
-            linoz_o3col_clim_icol, linoz_PmL_clim_icol, linoz_dPmL_dO3_icol,
-            linoz_dPmL_dT_icol, linoz_dPmL_dO3col_icol,
-            linoz_cariolle_pscs_icol, eccf, adv_mass_kg_per_moles,
+            work_photo_table_icol,
+            config.linoz, linoz_data,
+             eccf, adv_mass_kg_per_moles,
             fraction_landuse_icol, index_season, clsmap_4, permute_4,
-            offset_aerosol, config.linoz.o3_sfc, config.linoz.o3_tau,
-            config.linoz.o3_lbl, dry_diameter_icol, wet_diameter_icol,
+            offset_aerosol,
+            dry_diameter_icol, wet_diameter_icol,
             wetdens_icol, dry_atm.phis(icol), cmfdqr, prain_icol, nevapr_icol,
             work_set_het_icol, drydep_data, aqso4_flx_col,  aqh2so4_flx_col,
             diag_arrays, dvel_col, dflx_col, progs);
@@ -1090,6 +1115,7 @@ void MAMMicrophysics::run_impl(const double dt) {
   // postprocess output
   post_process(wet_aero_, dry_aero_, dry_atm_);
   Kokkos::fence();
+
 }  // MAMMicrophysics::run_impl
 
 }  // namespace scream

components/eamxx/src/physics/mam/eamxx_mam_microphysics_process_interface.hpp

@@ -79,12 +79,7 @@ class MAMMicrophysics final : public MAMGenericInterface {
 
   struct Config {
     // stratospheric chemistry parameters
-    struct {
-      int o3_lbl;   // number of layers with ozone decay from the surface
-      Real o3_sfc;  // set from namelist input linoz_sfc
-      Real o3_tau;  // set from namelist input linoz_tau
-      Real psc_T;   // set from namelist input linoz_psc_T
-    } linoz;
+    mam4::microphysics::LinozConf linoz;
 
     // aqueous chemistry parameters
     mam4::mo_setsox::Config setsox;
@@ -168,7 +163,7 @@ class MAMMicrophysics final : public MAMGenericInterface {
     for (const auto &pair : flds) {
       // Get the field, and add a docstring to its string attributes
       // This is used to document that the field contains heterogeneous
-      // quantities, i.e., species have different units.                 
+      // quantities, i.e., species have different units.
       auto &f = get_field_out(pair.first);
       auto &io_str_atts = f.get_header().get_extra_data<str_atts_t>("io: string attributes");
       io_str_atts["doc"] = pair.second;