Complete CCPPization of BAM/MAM aerosol optics; BAM microp_aero (nucleate_ice; ndrop_bam; inline logic in microp_aero) (ESCOMP#398)

Tag name: atmos_phys0_28_000
Originator(s): @jimmielin

Description:
- Adds aerosol optics schemes for all aerosol models for CAM-SIMA.
- Closes ESCOMP#381 - Adds `microp_aero` schemes for BAM in CAM-SIMA; shared
code with CAM.
- Closes ESCOMP#373 - rebin seasalt
- Partially ESCOMP#360 

Companion CAM-SIMA PR: ESCOMP/CAM-SIMA#504

List all namelist files that were added or changed:
```
A  schemes/chemistry/aerosol_optics_namelist.xml
A  schemes/microp_aero/ccpp/nucleate_ice_ccpp_namelist.xml
A  schemes/microp_aero/scale_subgrid_vertical_velocity_namelist.xml
   - new scheme namelists

A  schemes/microp_aero/ccpp/hetfrz_classnuc_stub_namelist.xml
   - stub for use_hetfrz_classnuc flag (stub disables classnuc het freezing).
```

List all files eliminated and why: N/A

List all files added and what they do:
```
A  schemes/chemistry/aerosol_optics.F90
A  schemes/chemistry/aerosol_optics.meta
A  schemes/chemistry/aerosol_optics_namelist.xml
   - Aerosol optics scheme. Computes per-band SW/LW aerosol optical properties
     (extinction, SSA, asymmetry) from aerosol model instances via the abstract
     aerosol interface. Reads water refractive index data in init.

A  schemes/sima_diagnostics/aerosol_optics_diagnostics.F90
A  schemes/sima_diagnostics/aerosol_optics_diagnostics.meta
   - Aerosol optics diagnostics: per-species AOD, burden, SSA, visible AOD, etc.

A  schemes/chemistry/aerosol_optics_zero_stub.F90
A  schemes/chemistry/aerosol_optics_zero_stub.meta
   - Zero stub providing zeroed-out aerosol optical properties for RRTMGP
     snapshot testing without the full aerosol optics scheme.

A  schemes/chemistry/rebin_seasalt.F90
A  schemes/chemistry/rebin_seasalt.meta
   - Rebins 4-bin BAM prescribed seasalt (sslt01/02/03/04) to 2-bin
     (sslta/ssltc) using constituent mass fractions.

A  schemes/microp_aero/ndrop_bam.F90
   - Portable layer for bulk aerosol droplet activation (Abdul-Razzak and
     Ghan 2000). Computes droplet number tendency and CCN concentrations.
   - This is copied from CAM then slightly cleaned up

A  schemes/microp_aero/nucleate_ice.F90
   - Portable layer for ice nucleation (Liu and Penner 2005, Liu et al. 2007).
     Computes ice crystal number from homogeneous and heterogeneous nucleation.
   - This is copied from CAM

A  schemes/microp_aero/compute_subgrid_vertical_velocity.F90
A  schemes/microp_aero/compute_subgrid_vertical_velocity.meta
   - Computes subgrid vertical velocity (wsub, wsubi) from TKE or CLUBB WP2.
   - Original logic from CAM inlined in microp_aero

A  schemes/microp_aero/scale_subgrid_vertical_velocity.F90
A  schemes/microp_aero/scale_subgrid_vertical_velocity.meta
A  schemes/microp_aero/scale_subgrid_vertical_velocity_namelist.xml
   - Applies wsub_scale scaling factor to subgrid vertical velocity.
   - Original logic from CAM inlined in microp_aero

A  schemes/microp_aero/dust_default_radii.F90
A  schemes/microp_aero/dust_default_radii.meta
   - Sets default dust effective radii for radiation (dust1-4).
   - Original logic from CAM inlined in microp_aero

A  schemes/microp_aero/ccpp/ndrop_bam_ccpp.F90
A  schemes/microp_aero/ccpp/ndrop_bam_ccpp.meta
   - CCPP wrapper for ndrop_bam

A  schemes/microp_aero/ccpp/nucleate_ice_ccpp.F90
A  schemes/microp_aero/ccpp/nucleate_ice_ccpp.meta
A  schemes/microp_aero/ccpp/nucleate_ice_ccpp_namelist.xml
   - CCPP wrapper for nucleate_ice, equivalent to nucleate_ice_cam in CAM.

A  schemes/microp_aero/ccpp/hetfrz_classnuc_stub.F90
A  schemes/microp_aero/ccpp/hetfrz_classnuc_stub.meta
A  schemes/microp_aero/ccpp/hetfrz_classnuc_stub_namelist.xml
   - Stub for heterogeneous freezing (classnuc). Provides zero tendencies
     when use_hetfrz_classnuc is false. For BAM.

A  test/test_schemes/initialize_pbuf_aerosols.F90
A  test/test_schemes/initialize_pbuf_aerosols.meta
   - Test scheme for discovering aerosol number concentration species from
     pbuf-style "N:" fields via the abstract aerosol interface.

A  test/test_suites/suite_microp_aero_bam.xml
   - Test SDF for the microp_aero BAM suite.

A       schemes/sima_diagnostics/aerosol_optics_diagnostics.F90
A       schemes/sima_diagnostics/aerosol_optics_diagnostics.meta
A       schemes/sima_diagnostics/ndrop_bam_diagnostics.F90
A       schemes/sima_diagnostics/ndrop_bam_diagnostics.meta
A       schemes/sima_diagnostics/nucleate_ice_diagnostics.F90
A       schemes/sima_diagnostics/nucleate_ice_diagnostics.meta
A       schemes/sima_diagnostics/scale_subgrid_vertical_velocity_diagnostics.F90
A       schemes/sima_diagnostics/scale_subgrid_vertical_velocity_diagnostics.meta
   - diagnostic schemes
```

List all existing files that have been modified, and describe the
changes:
```
M  schemes/rrtmgp/rrtmgp_sw_aerosols.F90
M  schemes/rrtmgp/rrtmgp_sw_aerosols.meta
   - Replace stub with implementation. Accepts aerosol tau/tau_w/tau_w_g from
     aerosol_optics, reorders from RRTMG to RRTMGP SW band ordering, maps CAM
     vertical levels to RRTMGP levels, subsets to daytime columns. Computes SSA
     and asymmetry parameter from the product fields.

M  schemes/rrtmgp/rrtmgp_lw_aerosols.F90
M  schemes/rrtmgp/rrtmgp_lw_aerosols.meta
   - Replace stub with implementation. Accepts aer_lw_abs from aerosol_optics,
     maps CAM vertical levels to RRTMGP levels. No band reorder needed for LW.

M  suites/suite_cam4.xml
   - Add prescribed aerosol/ozone schemes, rebin_seasalt, aerosol_optics, and
     aerosol_optics_diagnostics to CAM4 SDF
   - Reorder rrtmgp_pre before aerosol_optics so night column info is available for diagnostics.

M  test/test_suites/suite_rrtmgp.xml
   - Add aerosol_optics_zero_stub to RRTMGP test suite for snapshot testing to remain bit-for-bit.
```

List all automated tests that failed, as well as an explanation for why
they weren't fixed:

Is this an answer-changing PR? If so, is it a new physics package,
algorithm change, tuning change, etc?
New physics package
CAM regression tests for shared code
SIMA snapshot tests for microp_aero
Eyeballed the results from aerosol optics and looked reasonable.

If yes to the above question, describe how this code was validated with
the new/modified features:

---------

Co-authored-by: Haipeng Lin <hplin@ucar.edu>
Co-authored-by: Haipeng Lin <hplin+github@ucar.edu>

Author: 3 people

schemes/chemistry/aerosol_optics.F90

@@ -0,0 +1,269 @@
+[ccpp-table-properties]
+  name = aerosol_optics
+  type = scheme
+
+[ccpp-arg-table]
+  name  = aerosol_optics_init
+  type  = scheme
+[ water_refindex_file ]
+  standard_name = filename_of_water_refractive_index_data
+  units = none
+  type = character | kind = len=*
+  dimensions = ()
+  intent = in
+[ nswbands ]
+  standard_name = number_of_bands_for_shortwave_radiation
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ nlwbands ]
+  standard_name = number_of_bands_for_longwave_radiation
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ num_bulk_aer ]
+  standard_name = number_of_bulk_aerosol_constituents_in_climate_radiative_aerosol_list
+  units = count
+  type = integer
+  dimensions = ()
+  intent = out
+[ errmsg ]
+  standard_name = ccpp_error_message
+  units = none
+  type = character | kind = len=*
+  dimensions = ()
+  intent = out
+[ errflg ]
+  standard_name = ccpp_error_code
+  units = 1
+  type = integer
+  dimensions = ()
+  intent = out
+
+[ccpp-arg-table]
+  name  = aerosol_optics_run
+  type  = scheme
+[ ncol ]
+  standard_name = horizontal_loop_extent
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ pver ]
+  standard_name = vertical_layer_dimension
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ nswbands ]
+  standard_name = number_of_bands_for_shortwave_radiation
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ nlwbands ]
+  standard_name = number_of_bands_for_longwave_radiation
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ top_lev ]
+  standard_name = vertical_layer_index_of_aerosol_model_top
+  units = index
+  type = integer
+  dimensions = ()
+  intent = in
+[ rga ]
+  standard_name = reciprocal_of_gravitational_acceleration
+  units = s2 m-1
+  type = real | kind = kind_phys
+  dimensions = ()
+  intent = in
+[ idx_sw_diag ]
+  standard_name = index_of_shortwave_band
+  units = index
+  type = integer
+  dimensions = ()
+  intent = in
+[ num_bulk_aer ]
+  standard_name = number_of_bulk_aerosol_constituents_in_climate_radiative_aerosol_list
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ relh ]
+  standard_name = relative_humidity
+  units = fraction
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
+  intent = in
+[ pdeldry ]
+  standard_name = air_pressure_thickness_of_dry_air
+  units = Pa
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
+  intent = in
+[ t ]
+  standard_name = air_temperature
+  units = K
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
+  intent = in
+[ pmid ]
+  standard_name = air_pressure
+  units = Pa
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
+  intent = in
+[ h2ommr ]
+  standard_name = water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water
+  units = kg kg-1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
+  intent = in
+[ cldn ]
+  standard_name = cloud_area_fraction
+  units = fraction
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
+  intent = in
+[ constituents ]
+  standard_name = ccpp_constituents
+  units = none
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension, number_of_ccpp_constituents)
+  intent = in
+[ aer_tau ]
+  standard_name = shortwave_aerosol_extinction_optical_depth
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension, number_of_bands_for_shortwave_radiation)
+  intent = out
+[ aer_tau_w ]
+  standard_name = shortwave_aerosol_single_scattering_albedo_times_optical_depth
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension, number_of_bands_for_shortwave_radiation)
+  intent = out
+[ aer_tau_w_g ]
+  standard_name = shortwave_aerosol_asymmetry_parameter_times_single_scattering_albedo_times_optical_depth
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension, number_of_bands_for_shortwave_radiation)
+  intent = out
+[ aer_lw_abs ]
+  standard_name = longwave_aerosol_absorption_optical_depth
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension, number_of_bands_for_longwave_radiation)
+  intent = out
+[ dustaod ]
+  standard_name = aerosol_optical_depth_from_dust
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ sulfaod ]
+  standard_name = aerosol_optical_depth_from_sulfate
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ bcaod ]
+  standard_name = aerosol_optical_depth_from_black_carbon
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ pomaod ]
+  standard_name = aerosol_optical_depth_from_primary_organic_matter
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ soaaod ]
+  standard_name = aerosol_optical_depth_from_secondary_organic_aerosol
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ ssltaod ]
+  standard_name = aerosol_optical_depth_from_seasalt
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ aodabsbc ]
+  standard_name = absorption_aerosol_optical_depth_from_black_carbon
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ burdendust ]
+  standard_name = column_burden_from_dust
+  units = kg m-2
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ burdenso4 ]
+  standard_name = column_burden_from_sulfate
+  units = kg m-2
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ burdenbc ]
+  standard_name = column_burden_from_black_carbon
+  units = kg m-2
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ burdenpom ]
+  standard_name = column_burden_from_primary_organic_matter
+  units = kg m-2
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ burdensoa ]
+  standard_name = column_burden_from_secondary_organic_aerosol
+  units = kg m-2
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ burdenseasalt ]
+  standard_name = column_burden_from_seasalt
+  units = kg m-2
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ ssavis ]
+  standard_name = aerosol_single_scatter_albedo_at_vis
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ aodvis ]
+  standard_name = aerosol_optical_depth_at_vis
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent)
+  intent = out
+[ odv_col_aod ]
+  standard_name = column_visible_optical_depth_per_bulk_aerosol
+  units = 1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent, number_of_bulk_aerosol_constituents_in_climate_radiative_aerosol_list)
+  intent = out
+[ errmsg ]
+  standard_name = ccpp_error_message
+  units = none
+  type = character | kind = len=*
+  dimensions = ()
+  intent = out
+[ errflg ]
+  standard_name = ccpp_error_code
+  units = 1
+  type = integer
+  dimensions = ()
+  intent = out

schemes/chemistry/aerosol_optics.meta

@@ -0,0 +1,93 @@
+<?xml version="1.0"?>
+
+<?xml-stylesheet type="text/xsl"?>
+
+<entry_id_pg version="2.0">
+
+<!-- Each namelist variable is defined in an <entry> element.  The
+     content of the element is the documentation of how the variable is
+     used.  Other aspects of the variable's definition are expressed as
+     attributes of the <entry> element.  Note that it is an XML requirement
+     that the attribute values are enclosed in quotes.  The attributes are:
+
+     id
+          The variable's name.  *** N.B. *** The name must be lower case.
+          The module convert all namelist variable names to lower case
+          since Fortran is case insensitive.
+
+     type
+          An abbreviation of the fortran declaration for the variable.
+    Valid declarations are:
+
+          char*n
+    integer
+    logical
+    real
+
+    Any of these types may be followed by a comma separated list of
+    integers enclosed in parenthesis to indicate an array.
+
+    The current namelist validation code only distinquishes between
+    string and non-string types.
+
+     input_pathname
+          Only include this attribute to indicate that the variable
+          contains the pathname of an input dataset that resides in the
+          CESM inputdata directory tree.  Note that the variables
+          containing the names of restart files that are used in branch
+          runs don't reside in the inputdata tree and should not be given
+          this attribute.
+
+    The recognized values are "abs" to indicate that an absolute
+          pathname is required, or "rel:var_name" to indicate that the
+          pathname is relative and that the namelist variable "var_name"
+          contains the absolute root directory.
+
+     category
+          A category assigned for organizing the documentation.
+
+     group
+          The namelist group that the variable is declared in.
+
+     valid_values
+          This is an optional attribute that is mainly useful for variables
+          that have only a small number of allowed values. It is a
+          comma-separated list of valid values for the variable.
+
+     desc
+          This is a text description of the variable including its
+          purpose and use.
+
+     values
+          This is a grouping of all the cases where a value can be
+          assigned with the namelist generator has been run.
+
+     value
+          Each <value> tag specifies a case where a value is assigned
+          to this variable when the namelist generator is run. If the
+          tag has no attributes, it is a default value. In general,
+          the namelist generator attempts to find a value with the
+          maximium number of attribute matches (and no non-matches).
+
+     standard_name
+          This is the CCPP Standard Name of the variable
+
+     units
+          This is the CCPP unit specification of the variable (e.g., m s-1).
+                                                                        -->
+
+  <entry id="water_refindex_file">
+    <type>char*512</type>
+    <category>radiation</category>
+    <group>aerosol_optics_nl</group>
+    <standard_name>filename_of_water_refractive_index_data</standard_name>
+    <units>none</units>
+    <desc>
+      Full pathname of dataset for water refractive indices used in aerosol optics.
+    </desc>
+    <values>
+      <value>${DIN_LOC_ROOT}/atm/cam/physprops/water_refindex_rrtmg_c080910.nc</value>
+    </values>
+  </entry>
+
+</entry_id_pg>