Model Version: 3.0a
Component Tag:
cdeps1.0.96
HTML Created:
2026-07-02
Variable Namelist Group Category Entry Type Valid Values Possible Default Values Description and out-of-the-box Default
datamode docn_nml docn char ['sstdata', 'sst_aquap1', 'sst_aquap2', 'sst_aquap3', 'sst_aquap4', 'sst_aquap5', 'sst_aquap6', 'sst_aquap7', 'sst_aquap8', 'sst_aquap9', 'sst_aquap10', 'sst_aquapfile', 'sst_aquap_constant', 'som', 'som_aquap', 'iaf', 'cplhist', 'multilev', 'multilev_sstdata', 'multilev_cplhist'] is sstdata for: {'docn_mode': 'prescribed'}
is som for: {'docn_mode': 'som$'}
is som_aquap for: {'docn_mode': 'som_aquap'}
is sst_aquap1 for: {'docn_mode': 'sst_aquap1$'}
is sst_aquap2 for: {'docn_mode': 'sst_aquap2$'}
is sst_aquap3 for: {'docn_mode': 'sst_aquap3$'}
is sst_aquap4 for: {'docn_mode': 'sst_aquap4$'}
is sst_aquap5 for: {'docn_mode': 'sst_aquap5$'}
is sst_aquap6 for: {'docn_mode': 'sst_aquap6$'}
is sst_aquap7 for: {'docn_mode': 'sst_aquap7$'}
is sst_aquap8 for: {'docn_mode': 'sst_aquap8$'}
is sst_aquap9 for: {'docn_mode': 'sst_aquap9$'}
is sst_aquap10 for: {'docn_mode': 'sst_aquap10$'}
is sst_aquap_file for: {'docn_mode': 'sst_aquapfile$'}
is sst_aquap_constant for: {'docn_mode': 'sst_aquap_constant$'}
is multilev_cplhist for: {'docn_mode': 'multilev_cplhist'}
is multilev_sstdata for: {'docn_mode': 'multilev_dom'}
is multilev for: {'docn_mode': 'multilev'}
is cplhist for: {'docn_mode': 'cplhist'} 
      General method that operates on the data for a given docn_mode.
      ==> 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.
      NOTE: 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.
      The ocean salinity is set to a constant reference salinity value.
      All other fields other than SST and ocean salinity are set to zero.
      ==> 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 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.

      (1) map the xml variable DOCN_MODE => config variable docn_mode => namelist variable datamode
        compset="_DOCN%DOM_"      : docn_mode=prescribed          , datamode=sstdata
        compset="_DOCN%IAF_"      : docn_mode=interannual         , datamode=sstdata
        compset="_DOCN%SOM_"      : docn_mode=som                 , datamode=som
        compset="_DOCN%SOMAQP_"   : docn_mode=som_aquap           , datamode=som_aquap
        compset="_DOCN%AQP1_"     : docn_mode=sst_aquap1          , datamode=sst_aquap1
        compset="_DOCN%AQP2_"     : docn_mode=sst_aquap2          , datamode=sst_aquap2
        compset="_DOCN%AQP3_"     : docn_mode=sst_aquap3          , datamode=sst_aquap3
        compset="_DOCN%AQP4_"     : docn_mode=sst_aquap4          , datamode=sst_aquap4
        compset="_DOCN%AQP5_"     : docn_mode=sst_aquap5          , datamode=sst_aquap5
        compset="_DOCN%AQP6_"     : docn_mode=sst_aquap6          , datamode=sst_aquap6
        compset="_DOCN%AQP7_"     : docn_mode=sst_aquap7          , datamode=sst_aquap7
        compset="_DOCN%AQP8_"     : docn_mode=sst_aquap8          , datamode=sst_aquap8
        compset="_DOCN%AQP9_"     : docn_mode=sst_aquap9          , datamode=sst_aquap9
        compset="_DOCN%AQP10_"    : docn_mode=sst_aquap10         , datamode=sst_aquap10
        compset="_DOCN%AQPFILE_"  : docn_mode=sst_aquapfile       , datamode=sst_aquap_file
        compset="_DOCN%AQPCONST_" : docn_mode=sst_aquap_constant  , datamode=sst_aquap_constant
import_data_fields docn_nml docn char ['any char'] $DOCN_IMPORT_FIELDS 
      Colon delimited set of fields to advertise as import data
restfilm docn_nml docn char ['any char'] null 
      main restart file name for docn model
skip_restart_read docn_nml docn logical ['.true.', '.false.'] $DOCN_SKIP_RESTART_READ 
      If set to true, than docn restarts will not be read on a continuation run.
      This capability is used, for example, in CTSM spinup runs.
sst_constant_value docn_nml docn real(30) ['any real(30)'] -1.0
is $DOCN_AQPCONST_VALUE for: {'docn_mode': 'aquap_constant'} 
      Value of globally uniform SST (K) for idealized experiments
      when data ocean mode is sst_aquap_constant
model_maskfile docn_nml streams char ['any char'] $MASK_MESH
is $ATM_DOMAIN_MESH for: {'aqua_planet': 'true'}
is null for: {'single_column': 'true'} 
      MESH for ocn mask
model_meshfile docn_nml streams char ['any char'] $OCN_DOMAIN_MESH
is null for: {'single_column': 'true'} 
      file specifying model mesh
nx_global docn_nml streams integer ['any integer'] $OCN_NX
is 1 for: {'single_column': 'true'} 
      global size of nx
ny_global docn_nml streams integer ['any integer'] $OCN_NY
is 1 for: {'single_column': 'true'} 
      global size of ny
streamslist streams_file streams char(100) ['any char'] is prescribed for: {'docn_mode': 'prescribed'}
is interannual for: {'docn_mode': 'interannual'}
is som_aquap for: {'docn_mode': 'som_aquap'}
is som for: {'docn_mode': 'som'}
is aquapfile for: {'docn_mode': 'sst_aquap_file'}
is '' for: {'docn_mode': 'sst_aquap_constant'}
is '' for: {'docn_mode': 'sst_aquap1'}
is '' for: {'docn_mode': 'sst_aquap2'}
is '' for: {'docn_mode': 'sst_aquap3'}
is '' for: {'docn_mode': 'sst_aquap4'}
is '' for: {'docn_mode': 'sst_aquap5'}
is '' for: {'docn_mode': 'sst_aquap6'}
is '' for: {'docn_mode': 'sst_aquap7'}
is '' for: {'docn_mode': 'sst_aquap8'}
is '' for: {'docn_mode': 'sst_aquap9'}
is '' for: {'docn_mode': 'sst_aquap10'}
is multilev_cplhist for: {'docn_mode': 'multilev_cplhist'}
is sst_salinity_depth_blom,prescribed for: {'docn_mode': 'multilev_dom'}
is sst_salinity_depth_blom for: {'docn_mode': 'multilev'}
is cplhist for: {'docn_mode': 'cplhist'} 
      List of streams for a given docn_mode value. Each docn_mode can
      have zero or more streams that are associated with it.
Variable Namelist Group Category Entry Type Valid Values Possible Default Values Description and out-of-the-box Default