CIME Sea Ice Data and Stub XML Files

Sea Ice component XML files for data, stub, and dead components.

CIMEROOT/src/components/data_comps/dice/cime_config

Sea Ice data model, dice, XML files and settings.

XML specification for archiving dice output files.

<components version="2.0">
  <comp_archive_spec compname="dice" compclass="ice">
    <rest_file_extension>r</rest_file_extension>
    <rest_history_varname>unset</rest_history_varname>
    <rpointer>
      <rpointer_file>rpointer.ice$NINST_STRING</rpointer_file>
      <rpointer_content>$CASE.dice$NINST_STRING.r.$DATENAME.nc,$CASE.dice$NINST_STRING.rs1.$DATENAME.bin</rpointer_content>
    </rpointer>
    <test_file_names>
      <tfile disposition="copy">casename.dice.r.1976-01-01-00000.nc</tfile>
      <tfile disposition="copy">rpointer.ice_0001</tfile>
      <tfile disposition="copy">rpointer.ice</tfile>
    </test_file_names>
  </comp_archive_spec>
</components>

XML variables and component descriptions specific to dice.

<?xml version="1.0"?>

<?xml-stylesheet type="text/xsl" ?>

<entry_id version="3.0">

  <!-- modifier_mode allowed values are
       '*' 0 or more modifiers (default)
       '1' exactly 1 modifier
       '?' 0 or 1 modifiers
       '+' 1 or more modifiers

       This file may have ice desc entries.
  -->
  <description modifier_mode='1'>
    <desc ice="DICE[%SSMI][%IAF][%PRES][%NULL]">dice mode </desc>
    <desc option="SSMI">is ssmi</desc>
    <desc option="IAF"> is siaf</desc>
    <desc option="PRES"> is prescribed</desc>
    <desc option="NULL"> is null</desc>
  </description>

  <entry id="COMP_ICE">
    <type>char</type>
    <valid_values>dice</valid_values>
    <default_value>dice</default_value>
    <group>case_comp</group>
    <file>env_case.xml</file>
    <desc>Name of ice component</desc>
  </entry>

  <entry id="DICE_MODE">
    <type>char</type>
    <valid_values>prescribed,ssmi,ssmi_iaf,copyall,null</valid_values>
    <default_value>ssmi</default_value>
    <values match="last">
      <value compset="DICE%SSMI">ssmi</value>
      <value compset="DICE%IAF">ssmi_iaf</value>
      <value compset="DICE%PRES">prescribed</value>
      <value compset="DICE%NULL">null</value>
    </values>
    <group>run_component_dice</group>
    <file>env_run.xml</file>
    <desc>DICE mode. DICE is a combination of a data model and a prognostic model.
      The data functionality reads in ice coverage. The prognostic functionality
      calculates the ice/atmosphere and ice/ocean fluxes. DICE receives the same
      atmospheric input from the coupler as the active CICE model (i.e., atmospheric
      states, shortwave fluxes, and ocean ice melt flux). DICE acts very similarly
      to CICE running in prescribed mode.) Currently, this component is only
      used to drive POP in C compsets.
      If DICE_MODE is set to ssmi or ssmi_iaf, it is a prognostic mode.
      It requires data be sent to the ice model.
      Ice fraction (extent) data is read from an input stream,
      atmosphere state variables are received from the coupler, and then
      an atmosphere-ice surface flux is computed and sent to the
      coupler. Normally the ice fraction data is found in the same data files
      that provide SST data to the data ocean model. They are normally found
      in the same file because the SST and ice fraction data are derived from the
      same observational data sets and are consistent with each other.</desc>
  </entry>

  <help>
    =========================================
    DICE naming conventions
    =========================================
  </help>

</entry_id>

XML variables and component descriptions specific to dice.

<?xml version="1.0"?>

<?xml-stylesheet type="text/xsl" ?>

<entry_id version="3.0">

  <!-- modifier_mode allowed values are
       '*' 0 or more modifiers (default)
       '1' exactly 1 modifier
       '?' 0 or 1 modifiers
       '+' 1 or more modifiers

       This file may have ice desc entries.
  -->
  <description modifier_mode='1'>
    <desc ice="DICE[%SSMI][%IAF][%PRES][%NULL]">dice mode </desc>
    <desc option="SSMI">is ssmi</desc>
    <desc option="IAF"> is siaf</desc>
    <desc option="PRES"> is prescribed</desc>
    <desc option="NULL"> is null</desc>
  </description>

  <entry id="COMP_ICE">
    <type>char</type>
    <valid_values>dice</valid_values>
    <default_value>dice</default_value>
    <group>case_comp</group>
    <file>env_case.xml</file>
    <desc>Name of ice component</desc>
  </entry>

  <entry id="DICE_MODE">
    <type>char</type>
    <valid_values>prescribed,ssmi,ssmi_iaf,copyall,null</valid_values>
    <default_value>ssmi</default_value>
    <values match="last">
      <value compset="DICE%SSMI">ssmi</value>
      <value compset="DICE%IAF">ssmi_iaf</value>
      <value compset="DICE%PRES">prescribed</value>
      <value compset="DICE%NULL">null</value>
    </values>
    <group>run_component_dice</group>
    <file>env_run.xml</file>
    <desc>DICE mode. DICE is a combination of a data model and a prognostic model.
      The data functionality reads in ice coverage. The prognostic functionality
      calculates the ice/atmosphere and ice/ocean fluxes. DICE receives the same
      atmospheric input from the coupler as the active CICE model (i.e., atmospheric
      states, shortwave fluxes, and ocean ice melt flux). DICE acts very similarly
      to CICE running in prescribed mode.) Currently, this component is only
      used to drive POP in C compsets.
      If DICE_MODE is set to ssmi or ssmi_iaf, it is a prognostic mode.
      It requires data be sent to the ice model.
      Ice fraction (extent) data is read from an input stream,
      atmosphere state variables are received from the coupler, and then
      an atmosphere-ice surface flux is computed and sent to the
      coupler. Normally the ice fraction data is found in the same data files
      that provide SST data to the data ocean model. They are normally found
      in the same file because the SST and ice fraction data are derived from the
      same observational data sets and are consistent with each other.</desc>
  </entry>

  <help>
    =========================================
    DICE naming conventions
    =========================================
  </help>

</entry_id>

XML namelist definitions for dice.

<?xml version="1.0"?>

<?xml-stylesheet type="text/xsl" href="namelist_definition.xsl"?>

<entry_id version="2.0">

  <!--
      Values to use by default for creation of DICE model namelists.
      The element names are the same as the corresponding namelist
      variables.

      strm_year_first is the first year of the stream data that will be used
      strm_year_last  is the last  year of the stream data that will be used
      strm_year_align is the model year that will be aligned with stream data for year_first

      Replace any instance of the following substring indicators with the appropriate values:
      %y    = year from the range yearfirst to yearlast
      %ym   = year-month from the range yearfirst to yearlast with all 12 months
      %ymd  = year-month-day from the range yearfirst to yearlast with all 12 months

      In dice_in,  streams namelist input has the form
      streams = 'stream1.txt year_align year_first year_last ',
      'stream2.txt year_align year_first year_last ',
      ...
      'streamN.txt year_align year_first year_last '

      Currently the following datamode values are supported
      NULL
      COPYALL
      SSTDATA

      **********IMPORTANT NOTE: *************
      In the value matches below, regular expressions are used **** 
      If two matches are equivalent, the FIRST one will be used, so need to make sure
      that matches are not equivalent if possible

	 As an example, say dice_mode=SSMI_IAF

         the following order would result in an INCORRECT setting of streams for this dice_mode
              <value dice_mode="ssmi"    >SSMI</value>
              <value dice_mode="ssmi_iaf">SSMI_IAF</value>

         the following order would result in an CORRECT setting of streams for this dice_mode
              <value dice_mode="ssmi$"   >SSMI</value>
              <value dice_mode="ssmi_iaf">SSMI_IAF</value>
  -->

  <!-- ========================================================================================  -->
  <!-- Stream file variables                                                                     -->
  <!-- ========================================================================================  -->

  <entry id="streamslist">
    <type>char(100)</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>List of streams used for the given dice_mode.</desc>
    <values>
      <value dice_mode="null">NULL</value>
      <value dice_mode="ssmi$">SSMI</value>
      <value dice_mode="ssmi_iaf">SSMI_IAF</value>
      <value dice_mode="prescribed">prescribed</value>
    </values>
  </entry>

  <entry id="strm_grid_file" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>derived</group>
    <desc>does not appear in namelist - only used to set domain and data information</desc>
    <values>
      <value stream="prescribed">$SSTICE_GRID_FILENAME</value>
    </values>
  </entry>

  <entry id="strm_data_file" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>derived</group>
    <desc>does not appear in namelist - only used to set domain and data information</desc>
    <values>
      <value stream="prescribed">$SSTICE_GRID_FILENAME</value>
    </values>
  </entry>

  <entry id="strm_domdir" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Stream domain file directory.</desc>
    <values>
      <value>null</value>
      <value stream="SSMI$">$DIN_LOC_ROOT/ice/dice7</value>
      <value stream="SSMI_IAF">$DIN_LOC_ROOT/ice/dice7</value>
    </values>
  </entry>

  <entry id="strm_domfil" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Stream domain file path(s).</desc>
    <values>
      <value>null</value>
      <value stream="SSMI$">domain.ocn.x0.5.090227.nc</value>
      <value stream="SSMI_IAF">domain.ocn.x0.5.090227.nc</value>
    </values>
  </entry>

  <entry id="strm_domvar" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Stream domain variable name(s).</desc>
    <values>
      <value>
        time    time
        xc      lon
        yc      lat
        area    area
        mask    mask
      </value>
    </values>
  </entry>

  <entry id="strm_datdir" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Stream data file directory.</desc>
    <values>
      <value>null</value>
      <value stream="SSMI$">$DIN_LOC_ROOT/ice/dice7/SSMI</value>
      <value stream="SSMI_IAF">$DIN_LOC_ROOT/ocn/iaf</value>
    </values>
  </entry>

  <entry id="strm_datfil" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Stream data file path(s).</desc>
    <values>
      <value>null</value>
      <value stream="SSMI$">ssmi_ifrac.clim.x0.5.090319.nc</value>
      <value stream="SSMI_IAF">
        ssmi.ifrac.0.5x0.5.1948.nc
        ssmi.ifrac.0.5x0.5.1949.nc
        ssmi.ifrac.0.5x0.5.1950.nc
        ssmi.ifrac.0.5x0.5.1951.nc
        ssmi.ifrac.0.5x0.5.1952.nc
        ssmi.ifrac.0.5x0.5.1953.nc
        ssmi.ifrac.0.5x0.5.1954.nc
        ssmi.ifrac.0.5x0.5.1955.nc
        ssmi.ifrac.0.5x0.5.1956.nc
        ssmi.ifrac.0.5x0.5.1957.nc
        ssmi.ifrac.0.5x0.5.1958.nc
        ssmi.ifrac.0.5x0.5.1959.nc
        ssmi.ifrac.0.5x0.5.1960.nc
        ssmi.ifrac.0.5x0.5.1961.nc
        ssmi.ifrac.0.5x0.5.1962.nc
        ssmi.ifrac.0.5x0.5.1963.nc
        ssmi.ifrac.0.5x0.5.1964.nc
        ssmi.ifrac.0.5x0.5.1965.nc
        ssmi.ifrac.0.5x0.5.1966.nc
        ssmi.ifrac.0.5x0.5.1967.nc
        ssmi.ifrac.0.5x0.5.1968.nc
        ssmi.ifrac.0.5x0.5.1969.nc
        ssmi.ifrac.0.5x0.5.1970.nc
        ssmi.ifrac.0.5x0.5.1971.nc
        ssmi.ifrac.0.5x0.5.1972.nc
        ssmi.ifrac.0.5x0.5.1973.nc
        ssmi.ifrac.0.5x0.5.1974.nc
        ssmi.ifrac.0.5x0.5.1975.nc
        ssmi.ifrac.0.5x0.5.1976.nc
        ssmi.ifrac.0.5x0.5.1977.nc
        ssmi.ifrac.0.5x0.5.1978.nc
        ssmi.ifrac.0.5x0.5.1979.nc
        ssmi.ifrac.0.5x0.5.1980.nc
        ssmi.ifrac.0.5x0.5.1981.nc
        ssmi.ifrac.0.5x0.5.1982.nc
        ssmi.ifrac.0.5x0.5.1983.nc
        ssmi.ifrac.0.5x0.5.1984.nc
        ssmi.ifrac.0.5x0.5.1985.nc
        ssmi.ifrac.0.5x0.5.1986.nc
        ssmi.ifrac.0.5x0.5.1987.nc
        ssmi.ifrac.0.5x0.5.1988.nc
        ssmi.ifrac.0.5x0.5.1989.nc
        ssmi.ifrac.0.5x0.5.1990.nc
        ssmi.ifrac.0.5x0.5.1991.nc
        ssmi.ifrac.0.5x0.5.1992.nc
        ssmi.ifrac.0.5x0.5.1993.nc
        ssmi.ifrac.0.5x0.5.1994.nc
        ssmi.ifrac.0.5x0.5.1995.nc
        ssmi.ifrac.0.5x0.5.1996.nc
        ssmi.ifrac.0.5x0.5.1997.nc
        ssmi.ifrac.0.5x0.5.1998.nc
        ssmi.ifrac.0.5x0.5.1999.nc
        ssmi.ifrac.0.5x0.5.2000.nc
        ssmi.ifrac.0.5x0.5.2001.nc
        ssmi.ifrac.0.5x0.5.2002.nc
        ssmi.ifrac.0.5x0.5.2003.nc
        ssmi.ifrac.0.5x0.5.2004.nc
        ssmi.ifrac.0.5x0.5.2005.nc
        ssmi.ifrac.0.5x0.5.2006.nc
        ssmi.ifrac.0.5x0.5.2007.nc
        ssmi.ifrac.0.5x0.5.2008.20120420.nc
        ssmi.ifrac.0.5x0.5.2009.20120420.nc
      </value>
    </values>
  </entry>

  <entry id="strm_datvar" skip_default_entry="true">
    <type>char</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Stream data variable name(s).</desc>
    <values>
      <value>
        ifrac  ifrac
      </value>
    </values>
  </entry>

  <entry id="strm_offset" skip_default_entry="true">
    <type>integer</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Stream offset.</desc>
    <values>
      <value>0</value>
    </values>
  </entry>

  <entry id="strm_year_align" skip_default_entry="true">
  <type>integer</type>
  <category>streams</category>
  <group>streams_file</group>
  <desc>Simulation year to align stream to.</desc>
  <values>
    <value>-999</value>
    <value stream="SSMI$">1 </value>
    <value stream="SSMI_IAF">1</value>
    <value stream="prescribed">$SSTICE_YEAR_ALIGN</value>
  </values>
  </entry>

  <entry id="strm_year_start" skip_default_entry="true">
    <type>integer</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>First year of stream.</desc>
    <values>
      <value>-999</value>
      <value stream="SSMI$">1 </value>
      <value stream="SSMI_IAF">1948</value>
      <value stream="prescribed">$SSTICE_YEAR_START</value>
    </values>
  </entry>

  <entry id="strm_year_end" skip_default_entry="true">
    <type>integer</type>
    <category>streams</category>
    <group>streams_file</group>
    <desc>Last year of stream.</desc>
    <values>
      <value>-999</value>
      <value stream="SSMI$">1 </value>
      <value stream="SSMI_IAF">2009</value>
      <value stream="prescribed">$SSTICE_YEAR_END</value>
    </values>
  </entry>

  <!-- ========================================================================================  -->
  <!-- DICE Namelists                                                                            -->
  <!-- ========================================================================================  -->

  <!-- =========================================  -->
  <!--- shr_strmdata_nml (file dice_ice_in)       -->
  <!-- =========================================  -->

  <entry id="datamode">
    <type>char</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>NULL,SSTDATA,COPYALL</valid_values>
    <desc>
      general method that operates on the data.  this is generally
      implemented in the data models but is set in the strdata method for
      convenience.  valid options are dependent on the data model and will
      be described elsewhere.  NULL is always a valid option and means no
      data will be generated.  default='NULL'
      datamode = "NULL"
      Turns off the data model as a provider of data to the coupler.  The
      ice_present flag will be set to false and the coupler will assume no
      exchange of data to or from the data model.
      dataMode = "COPYALL"
      Copies all fields directly from the input data streams Any required
      fields not found on an input stream will be set to zero.
      dataMode = "SSTDATA"
      Is a prognostic mode. It requires data be sent to the ice
      model. Ice fraction (extent) data is read from an input stream,
      atmosphere state variables are received from the coupler, and then
      an atmosphere-ice surface flux is computed and sent to the
      coupler. It is called "SSTDATA" mode because normally the ice
      fraction data is found in the same data files that provide SST
      data to the data ocean model. They are normally found in the same
      file because the SST and ice fraction data are derived from the
      same observational data sets and are consistent with each other.
      Set by the xml variable DICE_MODE in env_run.xml
      Currently, DICE_MODE can be [ssmi, ssmi_iaf, null]
      If DICE_MODE is set to ssmi or ssmi_iaf, datamode will be set to SSTDATA
      If DICE_MODE is set to null, datamodel will be set to NULL
    </desc>
    <values>
      <value dice_mode="null">NULL</value>
      <value dice_mode="ssmi_iaf">SSTDATA</value>
      <value dice_mode="ssmi">SSTDATA</value>
      <value dice_mode="prescribed">SSTDATA</value>
    </values>
  </entry>

  <entry id="domainfile">
    <type>char</type>
    <category>streams</category>
    <input_pathname>abs</input_pathname>
    <group>shr_strdata_nml</group>
    <desc>
      spatial gridfile associated with the strdata.  grid information will
      be read from this file and that grid will serve as the target grid
      for all input data for this strdata input.
    </desc>
    <values>
      <value>$ICE_DOMAIN_PATH/$ICE_DOMAIN_FILE</value>
      <value stream="prescribed">$SSTICE_GRID_FILENAME</value>
      <value stream="ww3">$SSTICE_GRID_FILENAME</value>
    </values>
  </entry>

  <entry id="fillalgo" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>copy,bilinear,nn,nnoni,nnonj,spval</valid_values>
    <desc>
      array (up to 30 elements) of fill algorithms associated with the array
      of streams.  valid options are just copy (ie. no fill), special value,
      nearest neighbor, nearest neighbor in "i" direction, or nearest
      neighbor in "j" direction.
      valid values:  'copy','spval','nn','nnoni','nnonj'
    </desc>
    <values>
      <value>nn</value>
    </values>
  </entry>

  <entry id="fillmask" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>nomask,srcmask,dstmask,bothmask</valid_values>
    <desc>
      plays no role is fill algorithm at the present time.
      valid values: "nomask,srcmask,dstmask,bothmask"
    </desc>
    <values>
      <value>nomask</value>
    </values>
  </entry>

  <entry id="fillread" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <desc>
      array (up to 30 elements) of filenames associated with the array of
      streams.  specifies the weights file to read in instead of computing the
      weights on the fly for the fill operation.  if this is set, fillalgo
      and fillmask are ignored.
    </desc>
    <values>
      <value>NOT_SET</value>
    </values>
  </entry>

  <entry id="fillwrite" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <desc>
      array (up to 30 elements)  of filenames associated with the array of
      streams.  specifies the weights file to generate after weights are
      computed on the fly for the fill operation.  this allows a user to
      save and reuse a set of weights later.
    </desc>
    <values>
      <value>NOT_SET</value>
    </values>
  </entry>

  <entry id="mapmask" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>nomask,srcmask,dstmask,bothmask</valid_values>
    <desc>
      array (up to 30 elements) of masking algorithms for mapping input data
      associated with the array of streams.  valid options are map only from
      valid src points, map only to valid destination points, ignore all
      masks, map only from valid src points to valid destination points.
      valid values: srcmask, dstmask, nomask, bothmask
    </desc>
    <values>
      <value>dstmask</value>
    </values>
  </entry>

  <entry id="mapalgo" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>copy,bilinear,nn,nnoni,nnonj,spval</valid_values>
    <desc>
      array (up to 30 elements) of fill algorithms associated with the array
      of streams.  valid options are copy by index, set to special value,
      nearest neighbor, nearest neighbor in "i" direction, nearest neighbor
      in "j" direction, or bilinear.
      valid values: copy,spval,nn,nnoni,nnonj,bilinear
    </desc>
    <values>
      <value>bilinear</value>
    </values>
  </entry>

  <entry id="mapread" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <desc>
      array (up to 30 elements) of filenames associated with the array of
      streams.  specifies the weights file to read instead of computing
      weights on the fly for the mapping (interpolation) operation.  if this
      is set, mapalgo and mapmask are ignored.
    </desc>
    <values>
      <value>NOT_SET</value>
    </values>
  </entry>

  <entry id="mapwrite" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <desc>
      array (up to 30 elements) of filenames associated with the array of
      streams.  specifies the weights file to generate after weights are
      computed on the fly for the mapping (interpolation) operation.  this
      allows a user to save and reuse a set of weights later.
    </desc>
    <values>
      <value>NOT_SET</value>
    </values>
  </entry>

  <entry id="tintalgo" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>coszen,nearest,linear,lower,upper</valid_values>
    <desc>
      array (up to 30 elements) of time interpolation options associated with the array of
      streams.
      valid values: lower,upper,nearest,linear,coszen
      lower   = Use lower time-value
      upper   = Use upper time-value
      nearest = Use the nearest time-value
      linear  = Linearly interpolate between the two time-values
      coszen  = Scale according to the cosine of the solar zenith angle (for solar)
    </desc>
    <values>
      <value>linear</value>
    </values>
  </entry>

  <entry id="taxmode" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>extend,cycle,limit</valid_values>
    <desc>
      array of time axis modes associated with the array of streams for
      handling data outside the specified stream time axis.
      valid options are to cycle the data based on the first, last, and
      align settings associated with the stream dataset, to extend the first
      and last valid value indefinitely, or to limit the interpolated data
      to fall only between the least and greatest valid value of the time array.
      valid values: cycle,extend,limit
      extend = extrapolate before and after the period by using the first or last value.
      cycle  = cycle between the range of data
      limit  = restrict to the period for which the data is valid
    </desc>
    <values>
      <value>cycle</value>
    </values>
  </entry>

  <entry id="readmode" per_stream_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <valid_values>single,full_file</valid_values>
    <desc>
      array (up to 30 elements) of reading mode associated with the array of
      streams.  specifies the mode of reading temporal stream dataset.
      valid options are "single" (read temporal dataset one at a time) or
      "full_file" (read all entires of temporal dataset in a given netcdf file)
      valid values: single,full_file
    </desc>
    <values>
      <value>single</value>
    </values>
  </entry>

  <entry id="dtlimit" per_stream_entry="true">
    <type>real(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <desc>
      array (up to 30 elements) of delta time ratio limits placed on the
      time interpolation associated with the array of streams.  this real
      value causes the model to stop if the ratio of the running maximum
      delta time divided by the minimum delta time is greater than the
      dtlimit for that stream.  for instance, with daily data, the delta
      time should be exactly one day throughout the dataset and the computed
      maximum divided by minimum delta time should always be 1.0.  for
      monthly data, the delta time should be between 28 and 31 days and the
      maximum ratio should be about 1.1.  the running value of the delta
      time is computed as data is read and any wraparound or cycling is also
      included.  this input helps trap missing data or errors in cycling.
      to turn off trapping, set the value to 1.0e30 or something similar.
    </desc>
    <values>
      <value>1.5e0</value>
    </values>
  </entry>

  <entry id="vectors">
    <type>char</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <desc>
      list of paired colon delimited field names that should be treated as
      vectors when carrying out spatial interpolation.  unlike other
      character arrays in this namelist, this array is completely decoupled
      from the list of streams.  this is a list of vector pairs that span
      all input streams where different fields of the vector pair could
      appear in different streams.
      for example, vectors = 'u:v','taux:tauy'.
    </desc>
    <values>
      <value>null</value>
    </values>
  </entry>

  <entry id="streams" skip_default_entry="true">
    <type>char(30)</type>
    <category>streams</category>
    <group>shr_strdata_nml</group>
    <desc>
      character array (up to 30 elements) of stream input files.  this
      string is actually parsed by a stream method and so the format is
      specified by the stream module.  this string consists of a
      "stream_input_filename year_align year_first year_last".  the
      stream_input_filename is a stream text input file and the format and
      options are described elsewhere.  year_align, year_first, and
      year_last provide information about the time axis of the file and how
      to relate the input time axis to the model time axis.
      default="null".
    </desc>
    <values>
      <value></value>
    </values>
  </entry>

  <!-- =========================================  -->
  <!--- dice_nml -->
  <!-- =========================================  -->

  <entry id="decomp">
    <type>char</type>
    <category>dice</category>
    <group>dice_nml</group>
    <valid_values>1d,root</valid_values>
    <desc>
      set the decomposition option for the data model.  valid options are
      placing the global array on the root task or a simple stride-one
      load balanced one-dimensional decomposition.  other decompositions
      may be added in the future.
      valid values are ['root','1d'].
      1d   = Vector decomposition
      root = run only on the master task
    </desc>
    <values>
      <value>1d</value>
    </values>
  </entry>

  <entry id="flux_qacc">
    <type>logical</type>
    <category>dice</category>
    <group>dice_nml</group>
    <desc>
      activates water accumulation/melt wrt Q
    </desc>
    <values>
      <value>.true.</value>
    </values>
  </entry>

  <entry id="flux_qacc0">
    <type>real</type>
    <category>dice</category>
    <group>dice_nml</group>
    <desc>
      initial water accumulation value
    </desc>
    <values>
      <value>0.</value>
    </values>
  </entry>

  <entry id="flux_qmin">
    <type>real</type>
    <category>dice</category>
    <group>dice_nml</group>
    <desc>
      bound on melt rate
    </desc>
    <values>
      <value>-300.e0</value>
    </values>
  </entry>

  <entry id="flux_swpf">
    <type>real</type>
    <category>dice</category>
    <group>dice_nml</group>
    <desc>
      short-wave penatration factor
    </desc>
    <values>
      <value>0.</value>
    </values>
  </entry>

  <entry id="restfilm">
    <type>char</type>
    <category>dice</category>
    <group>dice_nml</group>
    <desc>
      Model restart filename for the data ice model data.  This is optional.
      If both restfils and restfilm are undefined, the restart filename will
      be read from the ICE restart pointer file (or files for multiple instances).
    </desc>
    <values>
      <value>undefined</value>
    </values>
  </entry>

  <entry id="restfils">
    <type>char</type>
    <category>dice</category>
    <group>dice_nml</group>
    <desc>
      Stream restart filename for the data ice stream data.  This is
      optional.  If both restfils and restfilm are undefined, the restart
      filename will be read from the DICE restart pointer file (or files for
      multiple instances).
    </desc>
    <values>
      <value>undefined</value>
    </values>
  </entry>

</entry_id>

CIMEROOT/src/components/stub_comps/sice/cime_config

The sea ice stub model, sice, does not output any files in the RUNDIR nor does it have any namelist settings.

XML variables and component descriptions specific to sice.

<?xml version="1.0"?>

<?xml-stylesheet type="text/xsl" href="entry_id.xsl" ?>

<entry_id version="3.0">
  <description>
    <desc ice="SICE">Stub ice component</desc>
  </description>


  <entry id="COMP_ICE">
    <type>char</type>
    <valid_values>sice</valid_values>
    <default_value>sice</default_value>
    <group>case_comp</group>
    <file>env_case.xml</file>
    <desc>Name of sea-ice component</desc>
  </entry>

  <help>
    =========================================
    SICE naming conventions in compset name
    =========================================
  </help>

</entry_id>

CIMEROOT/src/components/xcpl_comps/xice/cime_config

The sea ice dead model, xice, does not output any files in the RUNDIR nor does it have any namelist settings.

XML variables and component descriptions specific to satm.

<?xml version="1.0"?>

<?xml-stylesheet type="text/xsl" href="entry_id.xsl" ?>

<entry_id version="3.0">
  <description>
    <desc ice="XICE">Dead ice component</desc>
  </description>

  <entry id="COMP_ICE">
    <type>char</type>
    <valid_values>xice</valid_values>
    <default_value>xice</default_value>
    <group>case_comp</group>
    <file>env_case.xml</file>
    <desc>Name of sea-ice component</desc>
  </entry>


  <help>
    =========================================
    XICE naming conventions in compset name
    =========================================
  </help>

</entry_id>