Chapter 4. CPL7 Namelist

Table of Contents
Namelist Overview
cpl_modelio.nml Input File
drv_in Input File
seq_maps.rc Input File

Namelist Overview

In general, a user can modify the driver/coupler settings by editing either env variables or the buildnml files under Buildconf. Specifically, the driver/coupler namelist can be found in and will be generated by the script, $CASEROOT/Buildconf/cpl.buildnml.csh.

There are several namelists associated with the driver/coupler and they will be described below. Not all namelist variables are resolved in the buildnml script, but they all can be used. Below, a description of each namelist group and each namelist variable in each group will be presented including a summary of the type and defaults and whether any env variable is associated with the setting. The types are either char (character string), int (integer), r4 (real*4), r8 (real*8), or log (logical).

There are three important driver/coupler namelist input files (cpl_modelio.nml, drv_in, and seq_maps.rc) and each file has at least one namelist input group. The namelist groups are modelio, seq_infodata_inparm, seq_timemgr_inparm, ccsm_pes, prof_inparm, pio_inparm, and seq_maps. The files, namelist groups, and list of variables in each namelist group are

cpl_modelio.nml (input_filename)
   modelio (cpl_modelio.nml namelist)
      diri - obsolete
      diro - obsolete - obsolete
      logfile - logfile name

drv_in (input filename)
   seq_infodata_inparm (drv_in namelist)
      case_desc - case description
      case_name - case name
      start_type - start type
      model_version - model version
      username - current username
      hostname - hostname
      brnch_retain_casename - retain branch casename
      info_debug - debug level
      bfbflag - bit for bit flag
      drv_threading - turn on variable threading in driver
      samegrid_ao - atm and ocean samegrid flag
      samegrid_al - atm and land samegrid flag
      samegrid_ro - runoff and ocean samegrid flag
      eps_frac - domain checking fraction tolerance
      eps_amask - domain checking atm/lnd mask tolerance
      eps_agrid - domain checking atm/lnd grid tolerance
      eps_aarea - domain checking atm/lnd area tolerance
      eps_omask - domain checking ocn/ice mask tolerance
      eps_ogrid - domain checking ocn/ice grid tolerance
      eps_oarea - domain checking ocn/ice area tolerance
      shr_map_dopole - polar correction in shr_map
      vect_map - vector mapping algorithm for vectors in a2o mapping
      flux_epbal - fresh water balance
      flux_albav - albedo averaging mode
      aoflux_grid - grid for atmocn flux calculation
      ocean_tight_coupling - tight ocean coupling flag
      perpetual - perpetual mode, untested
      perpetual_ymd, perpetual date, untested
      orb_mode - orbital mode
      orb_iyear_align - orbital model year alignment
      orb_iyear - orbital year
      orb_obliq - orbital obliquity
      orb_eccen - orbital eccentricity
      orb_mvelp - orbital vernal equinox
      atm_adiabatic - atm adiabatic mode
      atm_ideal_phys - atm ideal physics mode
      aqua_planet - aqua planet
      single_column - single column mode
      scmlon - single column longitude
      scmlat - single column latitude
      do_budgets - turn on budgets
      budget_inst - instantaneous budget flag
      budget_daily - daily budget flag
      budget_month - monthly budget flag
      budget_ann - annual budget flag
      budget_ltann - long term annual budget flag
      budget_ltend - long term end of run budget flag
      cpl_cdf64 - turn on 64bit netcdf files in driver
      restart_pfile - restart pointer file
      restart_file - restart filename
      timing_dir - timing output directory
      tchkpt_dir - timing checkpoint directory
      logFilePostFix - untested
      outPathRoot - untested
      histaux_a2x - driver aux history files for a2x fields
      histaux_a2x3hr - driver aux history files for a2x 3 hour fields 
      histaux_a2x3hrp - driver aux history file for a2x 3 hour precip fields
      histaux_a2x24hr - driver aux history file for a2x daily fields
      histaux_l2x - driver aux history file for l2x fields
      histaux_r2x - driver aux history file for r2x fields

   seq_timemgr_inparm (drv_in namelist)
      calendar - calendar type
      start_ymd - start year/month/day
      start_tod - start time of day
      ref_ymd - reference year/month/day
      ref_tod - reference time of day
      curr_ymd - current year/month/day, obsolete
      curr_tod - current time of day, obsolete
      atm_cpl_dt - atm coupling period
      ocn_cpl_dt - ocn coupling period
      ice_cpl_dt - ice coupling period
      lnd_cpl_dt - lnd coupling period
      glc_cpl_dt - glc coupling period
      atm_cpl_offset - atm coupling offset
      lnd_cpl_offset - lnd coupling offset
      ocn_cpl_offset - ocn coupling offset
      ice_cpl_offset - ice coupling offset
      glc_cpl_offset - glc coupling offset
      stop_option - stop flag
      stop_n - stop value
      stop_ymd - stop date
      stop_tod - stop time of day
      restart_option - restart flag
      restart_n - restart value
      restart_ymd - restart date
      end_restart - restart at end of run
      history_option - driver snapshot history flag
      history_n - driver snapshot history value
      history_ymd - driver snapshot history date
      histavg_option - driver average history flag
      histavg_n - driver average history value
      histavg_ymd - driver average history date
      tprof_option - timing flag
      tprof_n - timing value
      tprof_ymd - timing date

   ccsm_pes (drv_in namelist)
      atm_ntasks - atm mpi tasks
      atm_rootpe - atm root task in global comm
      atm_pestride - atm mpi task stride
      atm_nthreads - atm threads per mpi task
      lnd_ntasks - lnd mpi tasks
      lnd_rootpe - lnd root task in global comm
      lnd_pestride - lnd mpi task stride
      lnd_nthreads - lnd threads per mpi task
      ice_ntasks - ice mpi tasks
      ice_rootpe - ice root task in global comm
      ice_pestride - ice mpi task stride
      ice_nthreads - ice threads per mpi task
      ocn_ntasks - ocn mpi tasks
      ocn_rootpe - ocn root task in global comm
      ocn_pestride - ocn mpi task stride
      ocn_nthreads - ocn threads per mpi task
      glc_ntasks - glc mpi tasks
      glc_rootpe - glc root task in global comm
      glc_pestride - glc mpi task stride
      glc_nthreads - glc threads per mpi task
      cpl_ntasks - cpl mpi tasks
      cpl_rootpe - cpl root task in global comm
      cpl_pestride - cpl mpi task stride
      cpl_nthreads - cpl threads per mpi task

   prof_inparm (drv_in namelist)

   pio_inparm (drv_in namelist)
      pio_async_interface - future asynchronous IO capability (not currently supported)
      pio_numtasks - number of io tasks in pio used generically, component based value takes precedent
      pio_root - io task root in pio used generically, component based value takes precedent
      pio_stride - stride of tasks in pio used generically, component based value takes precedent
      pio_typename - io type in pio used generically, component based value takes precedent
      pio_debug_level - debug level for pio
      cpl_pio_numtasks - number of io tasks in pio for coupler
      cpl_pio_root - io task root in pio for coupler
      cpl_pio_stride - stride of tasks in pio for coupler
      cpl_pio_typename - io type in pio for coupler
      atm_pio_numtasks - number of io tasks in pio for atmosphere
      atm_pio_root - io task root in pio for atmosphere
      atm_pio_stride - stride of tasks in pio for atmosphere
      atm_pio_typename - io type in pio for atmosphere
      lnd_pio_numtasks - number of io tasks in pio for land
      lnd_pio_root - io task root in pio for land
      lnd_pio_stride - stride of tasks in pio for land
      lnd_pio_typename - io type in pio for land
      ice_pio_numtasks - number of io tasks in pio for ice
      ice_pio_root - io task root in pio for ice
      ice_pio_stride - stride of tasks in pio for ice
      ice_pio_typename - io type in pio for ice
      ocn_pio_numtasks - number of io tasks in pio for ocean
      ocn_pio_root - io task root in pio for ocean
      ocn_pio_stride - stride of tasks in pio for ocean
      ocn_pio_typename - io type in pio for ocean
      glc_pio_numtasks - number of io tasks in pio for land ice
      glc_pio_root - io task root in pio for land ice
      glc_pio_stride - stride of tasks in pio for land ice
      glc_pio_typename - io type in pio for land ice

seq_maps.rc (input filename)
   seq_maps (not a Fortran namelist)
      atm2ocnFmapname - atm to ocn flux mapping file
      atm2ocnFmaptype - atm to ocn flux mapping type
      atm2ocnSmapname - atm to ocn state mapping file
      atm2ocnSmaptype - atm to ocn state mapping type
      ocn2atmFmapname - ocn to atm flux mapping file
      ocn2atmFmaptype - ocn to atm flux mapping type
      ocn2atmSmapname - ocn to atm state mapping file
      ocn2atmSmaptype - ocn to atm state mapping type
      atm2iceFmapname - atm to ice flux mapping file
      atm2iceFmaptype - atm to ice flux mapping type
      atm2iceSmapname - atm to ice state mapping file
      atm2iceSmaptype - atm to ice state mapping type
      ice2atmFmapname - ice to atm flux mapping file
      ice2atmFmaptype - ice to atm flux mapping type
      ice2atmSmapname - ice to atm state mapping file
      ice2atmSmaptype - ice to atm state mapping type
      atm2lndFmapname - atm to lnd flux mapping file
      atm2lndFmaptype - atm to lnd flux mapping type
      atm2lndSmapname - atm to lnd state mapping file
      atm2lndSmaptype - atm to lnd state mapping type
      lnd2atmFmapname - lnd to atm flux mapping file
      lnd2atmFmaptype - lnd to atm flux mapping type
      lnd2atmSmapname - lnd to atm state mapping file
      lnd2atmSmaptype - lnd to atm state mapping type
      rof2ocnFmapname - rof to ocn flux mapping file
      rof2ocnFmaptype - rof to ocn flux mapping type