Merge pull request #37 from nusbaume/cloud_rules

Add new cloud standard name rule, and update cloud_area_fraction

Metadata-standard-names.md

@@ -223,7 +223,7 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi
     * `real(kind=kind_phys)`: units = kg m-2
 * `mass_content_of_cloud_liquid_water_in_atmosphere_layer`: Mass content of cloud liquid water in atmosphere layer
     * `real(kind=kind_phys)`: units = kg m-2
-* `cloud_area_fraction_in_atmosphere_layer`: Cloud area fraction in atmosphere layer
+* `nonconvective_cloud_area_fraction_in_atmosphere_layer`: cloud area fraction in atmosphere layer excluding clouds produced by the convective schemes
     * `real(kind=kind_phys)`: units = 1
 * `relative_humidity`: Relative humidity
     * `real(kind=kind_phys)`: units = 1
@@ -804,9 +804,9 @@ Standard / required CCPP variables
     * `integer(kind=)`: units = index
 * `index_of_air_temperature_two_timesteps_back_in_xyz_dimensioned_restart_array`: Index of air temperature two timesteps back in xyz dimensioned restart array
     * `integer(kind=)`: units = index
-* `index_of_cloud_area_fraction_in_atmosphere_layer_in_tracer_concentration_array`: Index of cloud area fraction in atmosphere layer in tracer concentration array
+* `index_of_nonconvective_cloud_area_fraction_in_atmosphere_layer_in_tracer_concentration_array`: Index of nonconvective cloud area fraction in atmosphere layer in tracer concentration array
     * `integer(kind=)`: units = index
-* `index_of_cloud_area_fraction_in_atmosphere_layer_in_xyz_dimensioned_restart_array`: Index of cloud area fraction in atmosphere layer in xyz dimensioned restart array
+* `index_of_nonconvective_cloud_area_fraction_in_atmosphere_layer_in_xyz_dimensioned_restart_array`: Index of nonconvective cloud area fraction in atmosphere layer in xyz dimensioned restart array
     * `integer(kind=)`: units = index
 * `index_of_cloud_liquid_water_effective_radius_in_xyz_dimensioned_restart_array`: Index of cloud liquid water effective radius in xyz dimensioned restart array
     * `integer(kind=)`: units = index
@@ -1971,7 +1971,7 @@ Standard / required CCPP variables
     * `real(kind=kind_phys)`: units = kg kg-1
 * `mass_number_concentration_of_cloud_liquid_water_particles_in_air_of_new_state`: Mass number concentration of cloud liquid water particles in air of new state
     * `real(kind=kind_phys)`: units = kg-1
-* `cloud_area_fraction_in_atmosphere_layer_of_new_state`: Cloud area fraction in atmosphere layer of new state
+* `nonconvective_cloud_area_fraction_in_atmosphere_layer_of_new_state`: Nonconvective cloud area fraction in atmosphere layer of new state
     * `real(kind=kind_phys)`: units = frac
 * `graupel_mixing_ratio_wrt_moist_air_of_new_state`: Graupel mixing ratio wrt moist air of new state
     * `real(kind=kind_phys)`: units = kg kg-1

StandardNamesRules.rst

@@ -88,6 +88,11 @@ CCPP Standard Name Rules
    Otherwise the standard name should explicitly state the type of hydrometeor(s) the
    named quantity represents (e.g. *graupel*).
 
+#. By default, the term *cloud* refers to all cloud phases and cloud types. Otherwise
+   an additional prefix or suffix should be added to the standard name specifying what kind(s)
+   of clouds the variable repesents (e.g. *ice_cloud* if only including glaciated clouds, or
+   *cloud_at_500hPa* if only including clouds that exist at 500 hPa).
+
 #. If possible, qualifiers should be limited in order to allow for a wide
    applicability of the variable. In other words, don't qualify with _for ``_xyz``
    unless a variable could not conceivably be used outside of the more

standard_names.xml

@@ -354,7 +354,9 @@
     <standard_name name="mass_content_of_cloud_liquid_water_in_atmosphere_layer">
       <type kind="kind_phys" units="kg m-2">real</type>
     </standard_name>
-    <standard_name name="cloud_area_fraction_in_atmosphere_layer">
+    <standard_name
+        name="nonconvective_cloud_area_fraction_in_atmosphere_layer"
+        long_name="cloud area fraction in atmosphere layer excluding clouds produced by the convective schemes">
       <type kind="kind_phys" units="1">real</type>
     </standard_name>
     <standard_name name="relative_humidity">
@@ -1246,10 +1248,10 @@
       <standard_name name="index_of_air_temperature_two_timesteps_back_in_xyz_dimensioned_restart_array">
          <type kind="" units="index">integer</type>
       </standard_name>
-      <standard_name name="index_of_cloud_area_fraction_in_atmosphere_layer_in_tracer_concentration_array">
+      <standard_name name="index_of_nonconvective_cloud_area_fraction_in_atmosphere_layer_in_tracer_concentration_array">
          <type kind="" units="index">integer</type>
       </standard_name>
-      <standard_name name="index_of_cloud_area_fraction_in_atmosphere_layer_in_xyz_dimensioned_restart_array">
+      <standard_name name="index_of_nonconvective_cloud_area_fraction_in_atmosphere_layer_in_xyz_dimensioned_restart_array">
          <type kind="" units="index">integer</type>
       </standard_name>
       <standard_name name="index_of_cloud_liquid_water_effective_radius_in_xyz_dimensioned_restart_array">
@@ -3003,7 +3005,7 @@
       <standard_name name="mass_number_concentration_of_cloud_liquid_water_particles_in_air_of_new_state">
          <type kind="kind_phys" units="kg-1">real</type>
       </standard_name>
-      <standard_name name="cloud_area_fraction_in_atmosphere_layer_of_new_state">
+      <standard_name name="nonconvective_cloud_area_fraction_in_atmosphere_layer_of_new_state">
          <type kind="kind_phys" units="frac">real</type>
       </standard_name>
       <standard_name name="graupel_mixing_ratio_wrt_moist_air_of_new_state">