DOCN2.1 Fortran Namelist Definitions

Component tag: cime5.6.19

HTML created on: 2019-06-09

Variable Namelist Group Category Entry Type Valid Values Possible Default Values Description and out-of-the-box Default
decomp docn_nml docn char ['1d', 'root']
      DOCN Decomposition strategy
      1d   = Vector decomposition
      root = run only on the master task
    
force_prognostic_true docn_nml docn logical ['.true.', '.false.']
If TRUE, prognostic is forced to true. (default=false)
restfilm docn_nml docn char ['any char']
      Master restart file name for docn model
    
restfils docn_nml docn char ['any char']
      Stream restart file name for docn model, needed for branch simulations
    
datamode shr_strdata_nml streams char ['SSTDATA', 'SST_AQUAP1', 'SST_AQUAP2', 'SST_AQUAP3', 'SST_AQUAP4', 'SST_AQUAP5', 'SST_AQUAP6', 'SST_AQUAP7', 'SST_AQUAP8', 'SST_AQUAP9', 'SST_AQUAP10', 'SST_AQUAPFILE', 'SOM', 'SOM_AQUAP', 'IAF', 'NULL', 'COPYALL']
      General method that operates on the data. This is generally
      implemented in the data models but is set in the strdata method for
      convenience.

      datamode = "NULL"
      NULL is always a valid option and means no data will be generated.
      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"
      SSTDATA mode assumes the only field in the input stream is SST.
      It also assumes the SST is in Celsius and must be converted to Kelvin.
      All other fields are set to zero except for ocean salinity, which
      is set to a constant reference salinity value.
      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.
      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.
      dataMode = "IAF"
      IAF is the interannually varying version of SSTDATA
      dataMode = "SOM"
      SOM ("slab ocean model") mode is a prognostic mode.  This mode
      computes a prognostic sea surface temperature and a freeze/melt
      potential (surface Q-flux) used by the sea ice model.  This
      calculation requires an external SOM forcing data file that includes
      ocean mixed layer depths and bottom-of-the-slab Q-fluxes.
      Scientifically appropriate bottom-of-the-slab Q-fluxes are normally
      ocean resolution dependent and are derived from the ocean model output
      of a fully coupled CCSM run.  Note that while this mode runs out of
      the box, the default SOM forcing file is not scientifically
      appropriate and is provided for testing and development purposes only.
      Users must create scientifically appropriate data for their particular
      application.  A tool is available to derive valid SOM forcing.

      Set by the xml variable DOCN_MODE in env_run.xml
      Currently, DOCN_MODE can be [prescribed,som,interannual,null]
      If DOCN_MODE is prescribed, datamode will be set to SSTDATA
      If DOCN_MODE is interannual, datamode will be set to IAF
      If DOCN_MODE is som , datamode will be set to SOM
      If DOCN_MODE is sst_aqup[n], datamode will be set to SST_AQUAP
      If DOCN_MODE is som_aqup[n], datamode will be set to SOM_AQUAP
      If DOCN_MODE is null, datamode will be set to NULL

      default: SSTDATA (prescribed setting for DOCN_MODE)'
    
domainfile shr_strdata_nml streams char ['any char']
      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.
    
dtlimit shr_strdata_nml streams real(30) ['any real(30)']
      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.
    
fillalgo shr_strdata_nml streams char(30) ['copy', 'none', 'bilinear', 'nn', 'nnoni', 'nnonj', 'spval']
      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','none','spval','nn','nnoni','nnonj'
    
fillmask shr_strdata_nml streams char(30) ['nomask', 'srcmask', 'dstmask', 'bothmask']
      plays no role is fill algorithm at the present time.
      valid values: "nomask,srcmask,dstmask,bothmask"
    
fillread shr_strdata_nml streams char(30) ['any char']
      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.
    
fillwrite shr_strdata_nml streams char(30) ['any char']
      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.
    
mapalgo shr_strdata_nml streams char(30) ['copy', 'bilinear', 'nn', 'nnoni', 'nnonj', 'spval']
      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
    
mapmask shr_strdata_nml streams char(30) ['nomask', 'srcmask', 'dstmask', 'bothmask']
      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
    
mapread shr_strdata_nml streams char(30) ['any char']
      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.
    
mapwrite shr_strdata_nml streams char(30) ['any char']
      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.
    
readmode shr_strdata_nml streams char(30) ['single', 'full_file']
      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
    
streams shr_strdata_nml streams char(30) ['any char']
      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.
    
streamslist streams_file streams char(100) ['any char']
List of streams used for the given docn_mode.
strm_data_file derived streams char ['any char']
does not appear in namelist - only used to set domain and data information
strm_datdir streams_file streams char ['any char']
Stream data file directory.
strm_datfil streams_file streams char ['any char']
Stream data file path(s).
strm_datvar streams_file streams char ['any char']
Stream data variable name(s).
strm_domdir streams_file streams char ['any char']
Stream domain file directory.
strm_domfil streams_file streams char ['any char']
Stream domain file path(s).
strm_domvar streams_file streams char ['any char']
Stream domain variable name(s).
strm_grid_file derived streams char ['any char']
does not appear in namelist - only used to set domain and data information
strm_offset streams_file streams integer ['any integer']
Stream offset.
strm_year_align streams_file streams integer ['any integer']
Simulation year to align stream to.
strm_year_end streams_file streams integer ['any integer']
Last year of stream.
strm_year_start streams_file streams integer ['any integer']
First year of stream.
taxmode shr_strdata_nml streams char(30) ['extend', 'cycle', 'limit']
      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
    
tintalgo shr_strdata_nml streams char(30) ['coszen', 'nearest', 'linear', 'lower', 'upper']
      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)
    
vectors shr_strdata_nml streams char ['any char']
      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'.
    
Variable Namelist Group Category Entry Type Valid Values Possible Default Values Description and out-of-the-box Default