Merge pull request #81 from peverwhee/framework-update

Unit updates for consistency w/ SIMA

doc/ChangeLog

@@ -1,5 +1,61 @@
 ===============================================================
 
+Tag name:atmos_phys0_02_002
+Originator(s): peverwhee, nusbaume
+Date: 05 Mar 2024
+One-line Summary: Unit updates for consistency with SIMA
+Github PR URL: https://github.com/ESCOMP/atmospheric_physics/pull/81
+
+Purpose of changes (include the issue number and title text for each relevant GitHub issue):
+ - Update the following units which were incorrect and/or couldn't be
+   auto-converted (standard_name: old -> new)
+   - mpi_communicator: 1 -> index
+   - mpi_root: 1 -> index
+   - ccpp_constituents: kg kg-1 -> none
+   - vertical_index_at_top_interface: count -> index
+   - vertical_index_at_surface_interface: count -> index
+   - vertical_index_at_top_adjacent_layer: count -> index
+   - vertical_index_at_surface_adjacent_layer: count -> index
+   - dry_static_energy: J m-2 -> J kg-1
+   - surface_reference_pressure: mb -> Pa
+ - Bring in the following approved standard names changes (old -> new):
+   - reference_pressure -> surface_reference_pressure
+   - reference_pressure_in_atmosphere_layer_normalized_by_reference_pressure ->
+    reference_pressure_in_atmosphere_layer_normalized_by_surface_reference_pressure
+   - heating_rate -> tendency_of_dry_air_enthalpy_at_constant_pressure
+   - density_of_dry_air -> dry_air_density
+   - print_qneg_warn -> control_for_negative_constituent_warning
+ - update group names for existing schemes (physics_before_coupler and
+ physics_after_coupler)
+
+This PR fixes the following NCAR/atmospheric_physics Github issues:
+
+Code reviewed by: nusbaume, cacraigucar
+
+List all existing files that have been added (A), modified (M), or deleted (D),
+and describe the changes:
+
+M       held_suarez/held_suarez_1994.meta
+M       kessler/kessler.meta
+M       kessler/kessler_update.meta
+M       utilities/geopotential_temp.meta
+M       utilities/physics_tendency_updaters.meta
+M       utilities/qneg.meta
+M       utiltiies/state_converters.meta
+        - update standard names, fix units
+
+M       suite_held_suarez_1994.meta
+M       suite_kessler.xml
+M       suite_musica.xml
+        - update group names
+
+List and Describe any test failures: None; will have accompanying CAM-SIMA PR
+to address standard name and unit updates on that side
+
+Summarize any changes to answers: None
+
+===============================================================
+
 Tag name:atmos_phys0_02_001
 Originator(s): boulderdaze
 Date: 29 Jan 2024

doc/NamesNotInDictionary.txt

@@ -1,94 +1 @@
-
-#######################
-Date/time of when script was run:
-2024-02-07 10:29:13.957426
-#######################
-
-Non-dictionary standard names found in the following metadata files:
-
---------------------------
-
-./atmospheric_physics/kessler/kessler_update.meta
-
-    - composition_dependent_specific_heat_of_dry_air_at_constant_pressure
-
---------------------------
-
-./atmospheric_physics/kessler/kessler.meta
-
-    - density_of_dry_air
-    - rain_mixing_ratio_wrt_dry_air
-    - scheme_name
-    - composition_dependent_specific_heat_of_dry_air_at_constant_pressure
-
---------------------------
-
-./atmospheric_physics/utilities/geopotential_temp.meta
-
-    - geopotential_height_wrt_surface_at_interface
-    - ccpp_constituents
-    - number_of_ccpp_constituents
-    - ccpp_constituent_properties
-
---------------------------
-
-./atmospheric_physics/utilities/state_converters.meta
-
-    - dry_air_density
-    - composition_dependent_specific_heat_of_dry_air_at_constant_pressure
-    - cloud_liquid_water_mixing_ratio_wrt_moist_air_and_condensed_water
-    - rain_mixing_ratio_wrt_dry_air
-    - rain_mixing_ratio_wrt_moist_air_and_condensed_water
-
---------------------------
-
-./atmospheric_physics/utilities/qneg.meta
-
-    - ccpp_constituent_minimum_values
-    - ccpp_constituents
-    - log_output_unit
-    - number_of_ccpp_constituents
-    - ccpp_constituent_properties
-    - print_qneg_warn
-    - flag_for_mpi_root
-    - scheme_name
-
---------------------------
-
-./atmospheric_physics/utilities/physics_tendency_updaters.meta
-
-    - tendency_of_eastward_wind
-    - tendency_of_northward_wind
-    - tendency_of_eastward_wind_due_to_model_physics
-    - tendency_of_northward_wind_due_to_model_physics
-    - heating_rate
-    - composition_dependent_specific_heat_of_dry_air_at_constant_pressure
-
---------------------------
-
-./atmospheric_physics/utilities/static_energy.meta
-
-    - composition_dependent_specific_heat_of_dry_air_at_constant_pressure
-
---------------------------
-
-./atmospheric_physics/held_suarez/held_suarez_1994.meta
-
-    - tendency_of_eastward_wind
-    - composition_dependent_specific_heat_of_dry_air_at_constant_pressure
-    - reference_pressure_in_atmosphere_layer_normalized_by_reference_pressure
-    - scheme_name
-    - heating_rate
-    - composition_dependent_ratio_of_dry_air_gas_constant_to_specific_heat_of_dry_air_at_constant_pressure
-    - tendency_of_northward_wind
-
---------------------------
-
-./atmospheric_physics/musica/micm/micm.meta
-
-    - ccpp_constituent_properties
-    - log_output_unit
-    - dry_air_density
-    - ccpp_constituents
-
-#######################
+All standard names are in the dictionary!

held_suarez/held_suarez_1994.meta

@@ -6,7 +6,8 @@
   name  = held_suarez_1994_init
   type  = scheme
 [ pref_in ]
-  standard_name = reference_pressure
+  standard_name = surface_reference_pressure
+  long_name = reference pressure used in definition of potential temperature, Exner function, etc.
   units = Pa
   type = real | kind = kind_phys
   dimensions = ()
@@ -42,7 +43,7 @@
   dimensions = ()
   intent = in
 [ pref_mid_norm ]
-  standard_name = reference_pressure_in_atmosphere_layer_normalized_by_reference_pressure
+  standard_name = reference_pressure_in_atmosphere_layer_normalized_by_surface_reference_pressure
   units = 1
   type = real | kind = kind_phys
   dimensions = (vertical_layer_dimension)
@@ -102,7 +103,7 @@
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   intent = out
 [ ds ]
-  standard_name = heating_rate
+  standard_name = tendency_of_dry_air_enthalpy_at_constant_pressure
   units = J kg-1 s-1
   type = real | kind = kind_phys
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)

kessler/kessler.meta

@@ -12,9 +12,9 @@
   type = real | kind = kind_phys
   intent = in
 [ pref_in ]
-  standard_name = reference_pressure
+  standard_name = surface_reference_pressure
   long_name = reference pressure used in definition of Exner function
-  units = mb
+  units = Pa
   dimensions = ()
   type = real | kind = kind_phys
   intent = in
@@ -67,13 +67,13 @@
   intent = in
 [ lyr_surf ]
   standard_name = vertical_index_at_surface_adjacent_layer
-  units = count
+  units = index
   dimensions = ()
   type = integer
   intent = in
 [ lyr_toa ]
   standard_name = vertical_index_at_top_adjacent_layer
-  units = count
+  units = index
   dimensions = ()
   type = integer
   intent = in
@@ -90,7 +90,7 @@
   dimensions = (horizontal_loop_extent, vertical_layer_dimension)
   intent = in
 [ rho ]
-  standard_name = density_of_dry_air
+  standard_name = dry_air_density
   long_name = density of dry air
   units = kg m-3
   dimensions = (horizontal_loop_extent, vertical_layer_dimension)

kessler/kessler_update.meta

@@ -165,7 +165,7 @@
   standard_name = dry_static_energy
   long_name = Dry static energy
   type = real | kind = kind_phys
-  units = J m-2
+  units = J kg-1
   dimensions = (horizontal_dimension, vertical_layer_dimension)
   intent = out
 [ errflg ]

suite_held_suarez_1994.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <suite name="held_suarez_1994" version="1.0">
-  <group name="physics">
+  <group name="physics_before_coupler">
     <scheme>held_suarez_1994</scheme>
     <scheme>apply_tendency_of_eastward_wind</scheme>
     <scheme>apply_tendency_of_northward_wind</scheme>

suite_kessler.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <suite name="kessler" version="1.0">
-  <group name="physics">
+  <group name="physics_before_coupler">
     <scheme>calc_exner</scheme>
     <scheme>temp_to_potential_temp</scheme>
     <scheme>calc_dry_air_ideal_gas_density</scheme>

suite_musica.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <suite name="musica" version="1.0">
-  <group name="physics">
+  <group name="physics_after_coupler">
     <scheme>calc_dry_air_ideal_gas_density</scheme>
     <scheme>micm</scheme>
   </group>

utilities/geopotential_temp.meta

@@ -20,25 +20,25 @@
   intent = in
 [ layer_surf ]
   standard_name = vertical_index_at_surface_adjacent_layer
-  units = count
+  units = index
   dimensions = ()
   type = integer
   intent = in
 [ layer_toa ]
   standard_name = vertical_index_at_top_adjacent_layer
-  units = count
+  units = index
   dimensions = ()
   type = integer
   intent = in
 [ interface_surf ]
   standard_name = vertical_index_at_surface_interface
-  units = count
+  units = index
   dimensions = ()
   type = integer
   intent = in
 [ interface_toa ]
   standard_name = vertical_index_at_top_interface
-  units = count
+  units = index
   dimensions = ()
   type = integer
   intent = in
@@ -96,7 +96,7 @@
   intent = in
 [ carr ]
   standard_name = ccpp_constituents
-  units = kg kg-1
+  units = none
   type = real | kind = kind_phys
   dimensions = (horizontal_loop_extent,vertical_layer_dimension,number_of_ccpp_constituents)
   intent = in

utilities/physics_tendency_updaters.meta

@@ -118,7 +118,7 @@
   dimensions = ()
   intent = in
 [ heating_rate ]
-  standard_name = heating_rate
+  standard_name = tendency_of_dry_air_enthalpy_at_constant_pressure
   units = J kg-1 s-1
   type = real | kind = kind_phys
   dimensions = (horizontal_loop_extent, vertical_layer_dimension)

utilities/qneg.meta

@@ -6,7 +6,7 @@
   name  = qneg_init
   type  = scheme
 [ print_qneg_warn ]
-  standard_name = print_qneg_warn
+  standard_name = control_for_negative_constituent_warning
   units = 1
   type = character | kind = len=*
   dimensions = ()
@@ -61,7 +61,7 @@
   intent = in
 [ q ]
   standard_name = ccpp_constituents
-  units = kg kg-1
+  units = none
   type = real | kind = kind_phys
   dimensions = (horizontal_loop_extent,vertical_layer_dimension,number_of_ccpp_constituents)
   intent = inout
@@ -85,13 +85,13 @@
   type  = scheme
 [ mpi_communicator ]
   standard_name = mpi_communicator
-  units = 1
+  units = index
   type = integer
   dimensions = ()
   intent = in
 [ rootprocid ]
   standard_name = mpi_root
-  units = 1
+  units = index
   type = integer
   dimensions = ()
   intent = in
@@ -133,13 +133,13 @@
   type  = scheme
 [ mpi_communicator ]
   standard_name = mpi_communicator
-  units = 1
+  units = index
   type = integer
   dimensions = ()
   intent = in
 [ rootprocid ]
   standard_name = mpi_root
-  units = 1
+  units = index
   type = integer
   dimensions = ()
   intent = in

utilities/state_converters.meta

@@ -208,7 +208,7 @@
   type = real | kind = kind_phys
   intent = in
 [ ref_pres ]
-  standard_name = reference_pressure
+  standard_name = surface_reference_pressure
   long_name = reference pressure used in definition of potential temperature, Exner function, etc.
   units = Pa
   dimensions = ()