Update rules for logical/control variables

Metadata-standard-names.md

@@ -375,6 +375,8 @@ Variables defining or relating to timing, dates, calendar, and related concepts
     * `integer`: units = 1
 * `equation_of_time`: Apparent solar time minus mean solar time
     * `real`: units = radian
+* `flag_for_first_timestep`: Indicates whether the current timestep is the first timestep
+    * `logical`: units = flag
 * `forecast_julian_day`: Forecast julian day
     * `real`: units = days
 * `forecast_time_in_seconds`: Forecast time in seconds
@@ -385,8 +387,6 @@ Variables defining or relating to timing, dates, calendar, and related concepts
     * `real`: units = h
 * `index_of_timestep`: Index of timestep
     * `integer`: units = index
-* `is_first_timestep`: Is first timestep
-    * `logical`: units = flag
 * `number_of_days_in_current_year`: Number of days in current year
     * `integer`: units = days
 * `time_elapsed_since_diagnostics_reset`: Time elapsed since diagnostics reset
@@ -472,6 +472,8 @@ Variables defining or relating to timing, dates, calendar, and related concepts
     * `real`: units = m s-1
 * `eastward_wind_at_surface`: Wind vector component closest to surface, positive when directed eastward
     * `real`: units = m s-1
+* `flag_for_initialized_physics_grid`: Flag to indicate if physics grid is initialized
+    * `logical`: units = flag
 * `geopotential_at_interfaces`: Geopotential at interfaces
     * `real`: units = m2 s-2
 * `geopotential_at_surface`: Geopotential at surface
@@ -492,8 +494,6 @@ Variables defining or relating to timing, dates, calendar, and related concepts
 * `horizontal_velocity_potential_of_air`: Scalar potential of the horizontal wind
     * Equivalent CF name: `atmosphere_horizontal_velocity_potential`
     * `real`: units = m2 s-1
-* `is_initialized_physics_grid`: Flag to indicate if physics grid is initialized
-    * `logical`: units = flag
 * `largest_model_top_pressure_that_allows_molecular_diffusion`: Largest model top pressure that allows molecular diffusion
     * `real`: units = Pa
 * `ln_air_pressure`: Ln air pressure
@@ -1303,8 +1303,6 @@ Variables that indicate or control some action.
     * `integer`: units = 1
 * `control_for_vertical_index_direction`: control flag for direction of vertical index; 0 indicates index from toa to surface, 1 indicates index from surface to toa
     * `integer`: units = 1
-* `disable_precipitation_radiative_effect`: Disable precipitation radiative effect
-    * `logical`: units = flag
 * `do_aerosol_physics`: Do aerosol physics
     * `logical`: units = flag
 * `do_allow_supersaturation_after_sedimentation`: Do allow supersaturation after sedimentation
@@ -1347,6 +1345,8 @@ Variables that indicate or control some action.
     * `logical`: units = flag
 * `do_diagnostics`: Do diagnostics
     * `logical`: units = flag
+* `do_disable_precipitation_radiative_effect`: Do disable precipitation radiative effect
+    * `logical`: units = flag
 * `do_dominant_precipitation_type_partition`: Do dominant precipitation type partition
     * `logical`: units = flag
 * `do_flip`: Flag indicating whether to flip vertical coordinate
@@ -1551,6 +1551,8 @@ Variables that indicate or control some action.
     * `logical`: units = flag
 * `do_ysu_pbl_scheme`: Do Yonsei University (YSU) planetary boundary layer scheme
     * `logical`: units = flag
+* `flag_for_restart`: Flag indicating whether or not this is a restart run
+    * `logical`: units = flag
 * `identifier_for_2018_scale_aware_tke_moist_edmf_pbl`: Identifier for 2018 scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme
     * `integer`: units = 1
 * `identifier_for_2019_scale_aware_tke_moist_edmf_pbl`: Identifier for 2019 scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme
@@ -1609,8 +1611,6 @@ Variables that indicate or control some action.
     * `integer`: units = 1
 * `identifier_for_zhao_carr_pdf_microphysics_scheme`: Identifier for Zhao-Carr probability density function microphysics scheme
     * `integer`: units = 1
-* `is_restart`: Is restart
-    * `logical`: units = flag
 ## Indices
 Values indicating the index of some array or other data structure
 * `cumulative_max_vertical_index_at_cloud_base_between_sw_radiation_calls`: Cumulative maximum vertical index at cloud base between shortwave radiation calls

Metadata-standard-names.yaml

@@ -711,6 +711,10 @@ section:
     description: Apparent solar time minus mean solar time
     type: real
     units: radian
+  - name: flag_for_first_timestep
+    description: Indicates whether the current timestep is the first timestep
+    type: logical
+    units: flag
   - name: forecast_julian_day
     description: Forecast julian day
     type: real
@@ -731,10 +735,6 @@ section:
     description: Index of timestep
     type: integer
     units: index
-  - name: is_first_timestep
-    description: Is first timestep
-    type: logical
-    units: flag
   - name: number_of_days_in_current_year
     description: Number of days in current year
     type: integer
@@ -906,6 +906,10 @@ section:
       eastward
     type: real
     units: m s-1
+  - name: flag_for_initialized_physics_grid
+    description: Flag to indicate if physics grid is initialized
+    type: logical
+    units: flag
   - name: geopotential_at_interfaces
     description: Geopotential at interfaces
     type: real
@@ -944,10 +948,6 @@ section:
     description: Scalar potential of the horizontal wind
     type: real
     units: m2 s-1
-  - name: is_initialized_physics_grid
-    description: Flag to indicate if physics grid is initialized
-    type: logical
-    units: flag
   - name: largest_model_top_pressure_that_allows_molecular_diffusion
     description: Largest model top pressure that allows molecular diffusion
     type: real
@@ -2642,10 +2642,6 @@ section:
       toa to surface, 1 indicates index from surface to toa
     type: integer
     units: 1
-  - name: disable_precipitation_radiative_effect
-    description: Disable precipitation radiative effect
-    type: logical
-    units: flag
   - name: do_aerosol_physics
     description: Do aerosol physics
     type: logical
@@ -2730,6 +2726,10 @@ section:
     description: Do diagnostics
     type: logical
     units: flag
+  - name: do_disable_precipitation_radiative_effect
+    description: Do disable precipitation radiative effect
+    type: logical
+    units: flag
   - name: do_dominant_precipitation_type_partition
     description: Do dominant precipitation type partition
     type: logical
@@ -3158,6 +3158,10 @@ section:
     description: Do Yonsei University (YSU) planetary boundary layer scheme
     type: logical
     units: flag
+  - name: flag_for_restart
+    description: Flag indicating whether or not this is a restart run
+    type: logical
+    units: flag
   - name: identifier_for_2018_scale_aware_tke_moist_edmf_pbl
     description: Identifier for 2018 scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux
       planetary boundary layer scheme
@@ -3279,10 +3283,6 @@ section:
       scheme
     type: integer
     units: 1
-  - name: is_restart
-    description: Is restart
-    type: logical
-    units: flag
 - name: Indices
   comment: Values indicating the index of some array or other data structure
   standard_names:

StandardNamesRules.rst

@@ -195,9 +195,29 @@ Terminology
    relevant, the net ionization charge should be included as a prefix (in words, because +/- are
    not valid standard name characters); e.g. ``number_density_of_plus_1_ionized_he``
 
-#. For control-oriented variables, if the variable is a Fortran logical,
-   use flag_for ``_X``. If it is any other data type, use control_for ``_X``. All flags
-   should be Fortran logicals.
+#. For control-oriented variables, there are a few different prefixes that should be used depending on
+   the use case for that specific variable:
+
+   +-------------------+-----------+-----------------------------------------------------------------------------------------------+
+   | **Prefix**        |  **Type** | **Use case**                    | **Example**                                                 |
+   +===================+===========+=================================+=============================================================+
+   | `flag_for_`       | `logical` | A flag indicating some state or | `flag_for_mpi_root` indicates whether or not the code is    |
+   |                   |           | condition is true or false      | running on the MPI root process                             |
+   +-------------------+-----------+-------------------------------- +-------------------------------------------------------------+
+   | `do_`             | `logical` | A flag whose value directs some | `do_chemical_tracer_diagnostics` indicates to a physics     |
+   |                   |           | behavior                        | scheme that it should compute chemical tracer diagnostics   |
+   +-------------------+-----------+---------------------------------+-------------------------------------------------------------+
+   | `identifier_for_` | `integer` | A parameter indicating some     | `identifier_for_noah_land_surface_scheme` is an integer     |
+   |                   |           | state or condition              | identifying the Noah land surface model                     |
+   +-------------------+-----------+---------------------------------+-------------------------------------------------------------+
+   | `control_for_`    | `integer` | A control whose value directs   | `control_for_land_surface_scheme` is an integer identifying |
+   |                   |           | some behavior                   | the land surface scheme type                                |
+   +-------------------+-----------+---------------------------------+-------------------------------------------------------------+
+   | `index_of_`       | `integer` | An index entry for an array     | `index_of_ice_vegetation_category` is an index describing   |
+   |                   |           |                                 | the location of the ice vegetation category in the array of |
+   |                   |           |                                 | vegetation categories                                       |
+   +-------------------+-----------+---------------------------------+-------------------------------------------------------------+
+
 
 #. **Disallowed terms:** A few terms are disallowed as standard name components for various reasons; mostly due to
    ambiguity.

standard_names.xml

@@ -529,6 +529,9 @@
     <standard_name name="equation_of_time" description="Apparent solar time minus mean solar time">
       <type units="radian">real</type>
     </standard_name>
+    <standard_name name="flag_for_first_timestep" description="Indicates whether the current timestep is the first timestep">
+      <type units="flag">logical</type>
+    </standard_name>
     <standard_name name="forecast_julian_day">
       <type units="days">real</type>
     </standard_name>
@@ -544,9 +547,6 @@
     <standard_name name="index_of_timestep">
       <type units="index">integer</type>
     </standard_name>
-    <standard_name name="is_first_timestep">
-      <type units="flag">logical</type>
-    </standard_name>
     <standard_name name="number_of_days_in_current_year">
       <type units="days">integer</type>
     </standard_name>
@@ -672,6 +672,9 @@
     <standard_name name="eastward_wind_at_surface" description="Wind vector component closest to surface, positive when directed eastward">
       <type units="m s-1">real</type>
     </standard_name>
+    <standard_name name="flag_for_initialized_physics_grid" description="Flag to indicate if physics grid is initialized">
+      <type units="flag">logical</type>
+    </standard_name>
     <standard_name name="geopotential_at_interfaces">
       <type units="m2 s-2">real</type>
     </standard_name>
@@ -701,9 +704,6 @@
       <cfname>atmosphere_horizontal_velocity_potential</cfname>
       <type units="m2 s-1">real</type>
     </standard_name>
-    <standard_name name="is_initialized_physics_grid" description="Flag to indicate if physics grid is initialized">
-      <type units="flag">logical</type>
-    </standard_name>
     <standard_name name="largest_model_top_pressure_that_allows_molecular_diffusion">
       <type units="Pa">real</type>
     </standard_name>
@@ -1901,9 +1901,6 @@
     <standard_name name="control_for_vertical_index_direction" description="control flag for direction of vertical index; 0 indicates index from toa to surface, 1 indicates index from surface to toa">
       <type units="1">integer</type>
     </standard_name>
-    <standard_name name="disable_precipitation_radiative_effect">
-      <type units="flag">logical</type>
-    </standard_name>
     <standard_name name="do_aerosol_physics">
       <type units="flag">logical</type>
     </standard_name>
@@ -1967,6 +1964,9 @@
     <standard_name name="do_diagnostics">
       <type units="flag">logical</type>
     </standard_name>
+    <standard_name name="do_disable_precipitation_radiative_effect">
+      <type units="flag">logical</type>
+    </standard_name>
     <standard_name name="do_dominant_precipitation_type_partition">
       <type units="flag">logical</type>
     </standard_name>
@@ -2273,6 +2273,9 @@
     <standard_name name="do_ysu_pbl_scheme" description="Do Yonsei University (YSU) planetary boundary layer scheme">
       <type units="flag">logical</type>
     </standard_name>
+    <standard_name name="flag_for_restart" description="Flag indicating whether or not this is a restart run">
+      <type units="flag">logical</type>
+    </standard_name>
     <standard_name name="identifier_for_2018_scale_aware_tke_moist_edmf_pbl" description="Identifier for 2018 scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme">
       <type units="1">integer</type>
     </standard_name>
@@ -2360,9 +2363,6 @@
     <standard_name name="identifier_for_zhao_carr_pdf_microphysics_scheme" description="Identifier for Zhao-Carr probability density function microphysics scheme">
       <type units="1">integer</type>
     </standard_name>
-    <standard_name name="is_restart">
-      <type units="flag">logical</type>
-    </standard_name>
   </section>
   <section name="Indices" comment="Values indicating the index of some array or other data structure">
     <standard_name name="cumulative_max_vertical_index_at_cloud_base_between_sw_radiation_calls" description="Cumulative maximum vertical index at cloud base between shortwave radiation calls">