Complete CCPPization of CAM5 UW PBL scheme (diag_TKE)

schemes/bretherton_park/bretherton_park_diff_namelist.xml

@@ -0,0 +1,160 @@
+<?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="eddy_lbulk_max">
+    <type>real</type>
+    <kind>kind_phys</kind>
+    <category>pbl</category>
+    <group>eddy_diff_nl</group>
+    <standard_name>maximum_master_length_scale_for_eddy_diffusion</standard_name>
+    <units>m</units>
+    <desc>
+      Maximum master length scale designed to address issues in diag_TKE (the Bretherton-Park scheme) outside the boundary layer. In order not to disturb turbulence characteristics in the lower troposphere, this should be set at least larger than a few km. However, this does not significantly improve the values outside of the boundary layer. Smaller values make some improvement, but it is also noisy. Better results are seen using eddy_leng_max or kv_freetrop_scale.
+      Default: 40000 m
+    </desc>
+    <values>
+      <value>40.D3</value>
+    </values>
+  </entry>
+
+  <entry id="eddy_leng_max">
+    <type>real</type>
+    <kind>kind_phys</kind>
+    <category>pbl</category>
+    <group>eddy_diff_nl</group>
+    <standard_name>maximum_dissipation_length_scale_for_eddy_diffusion</standard_name>
+    <units>m</units>
+    <desc>
+      Maximum dissipation length scale designed to address issues with diag_TKE (the Bretherton-Park scheme) outside the boundary layer, where the default value generates large diffusivities. A value of 30 m is consistent with the length scales used in the HB scheme; however, this will also reduce value in the boundary layer.
+      Default: 40000 m
+    </desc>
+    <values>
+      <value>40.D3</value>
+      <!-- waccm: 100.D0 -->
+    </values>
+  </entry>
+
+  <entry id="eddy_max_bot_pressure">
+    <type>real</type>
+    <kind>kind_phys</kind>
+    <category>pbl</category>
+    <group>eddy_diff_nl</group>
+    <standard_name>air_pressure_threshold_for_maximum_turbulent_length_scale_application</standard_name>
+    <units>hPa</units>
+    <desc>
+      Bottom pressure level at which namelist values for eddy_leng_max and eddy_lbulk_max are applied. Default values are used at lower levels (i.e. the boundary layer).
+      Default: 100.D3 hPa
+    </desc>
+    <values>
+      <value>100.D3</value>
+      <!-- waccm: 100.D0 -->
+    </values>
+  </entry>
+
+  <entry id="eddy_moist_entrain_a2l">
+    <type>real</type>
+    <kind>kind_phys</kind>
+    <category>pbl</category>
+    <group>eddy_diff_nl</group>
+    <standard_name>tunable_parameter_for_moist_entrainment_enhancement_in_pbl</standard_name>
+    <units>1</units>
+    <desc>
+      Moist entrainment enhancement parameter. Default: 30.D0
+    </desc>
+    <values>
+      <value>30.D0</value>
+    </values>
+  </entry>
+
+  <entry id="eddy_wstarent">
+    <type>logical</type>
+    <category>pbl</category>
+    <group>eddy_diff_nl</group>
+    <standard_name>use_wstar_entrainment_closure_formulation_for_eddy_diffusion_scheme</standard_name>
+    <units>flag</units>
+    <desc>
+      Use wstar (.true.) or TKE (.false.) entrainment closure in UW eddy diffusion scheme.
+      Default: TRUE
+    </desc>
+    <values>
+      <value>.true.</value>
+    </values>
+  </entry>
+
+
+
+</entry_id_pg>