diff --git a/doc/source/user_guide/ug_case_settings.rst b/doc/source/user_guide/ug_case_settings.rst index f56ac20da..6b528f7cb 100644 --- a/doc/source/user_guide/ug_case_settings.rst +++ b/doc/source/user_guide/ug_case_settings.rst @@ -185,8 +185,8 @@ setup_nml "", "``y1``", "write restart once after ``dumpfreq_n`` years", "" "", "``1``", "write restart every ``dumpfreq_n`` time steps", "" "", "``11``", "write restart once after ``dumpfreq_n`` time steps", "" - "``dumpfreq_base``", "init", "restart output frequency relative to year_init, month_init, day_init", "'init','init','init','init','init'" - "", "zero", "restart output frequency relative to year-month-day of 0000-01-01", "" + "``dumpfreq_base``", "``init``", "restart output frequency relative to year_init, month_init, day_init", "'init','init','init','init','init'" + "", "``zero``", "restart output frequency relative to year-month-day of 0000-01-01", "" "``dumpfreq_n``", "integer array", "write restart frequency with ``dumpfreq``", "1,1,1,1,1" "``dump_last``", "logical", "write restart on last time step of simulation", "``.false.``" "``histfreq``", "``d``", "write history every ``histfreq_n`` days", "'1','h','d','m','y'" @@ -195,8 +195,8 @@ setup_nml "", "``x``", "unused frequency stream (not written)", "" "", "``y``", "write history every ``histfreq_n`` years", "" "", "``1``", "write history every ``histfreq_n`` time step", "" - "``histfreq_base``", "init", "history output frequency relative to year_init, month_init, day_init", "'zero','zero','zero','zero','zero'" - "", "zero", "history output frequency relative to year-month-day of 0000-01-01", "" + "``histfreq_base``", "``init``", "history output frequency relative to year_init, month_init, day_init", "'zero','zero','zero','zero','zero'" + "", "``zero``", "history output frequency relative to year-month-day of 0000-01-01", "" "``histfreq_n``", "integer array", "frequency history output is written with ``histfreq``", "1,1,1,1,1" "``history_chunksize``", "integer array", "chunksizes (x,y) for history output (hdf5 only)", "0,0" "``history_deflate``", "integer", "compression level (0 to 9) for history output (hdf5 only)", "0" @@ -215,9 +215,9 @@ setup_nml "", "``pnetcdf5``", "write history files with pnetcdf cdf5 (netcdf3-64bit-data) format", "" "``history_iotasks``", "integer", "pe io tasks for history output with history_root and history_stride (PIO only), -99=internal default", "-99" "``history_precision``", "integer", "history file precision: 4 or 8 byte", "4" - "``history_rearranger``", "box", "box io rearranger option for history output (PIO only)", "default" - "", "default", "internal default io rearranger option for history output", "" - "", "subset", "subset io rearranger option for history output", "" + "``history_rearranger``", "``box``", "box io rearranger option for history output (PIO only)", "default" + "", "``default``", "internal default io rearranger option for history output", "" + "", "``subset``", "subset io rearranger option for history output", "" "``history_root``", "integer", "pe root task for history output with history_iotasks and history_stride (PIO only), -99=internal default", "-99" "``history_stride``", "integer", "pe stride for history output with history_iotasks and history_root (PIO only), -99=internal default", "-99" "``hist_avg``", "logical", "write time-averaged data", "``.true.,.true.,.true.,.true.,.true.``" @@ -266,9 +266,9 @@ setup_nml "", "``pnetcdf2``", "write restart files with pnetcdf cdf2 (netcdf3-64bit-offset) format", "" "", "``pnetcdf5``", "write restart files with pnetcdf cdf5 (netcdf3-64bit-data) format", "" "``restart_iotasks``", "integer", "pe io tasks for restart output with restart_root and restart_stride (PIO only), -99=internal default", "-99" - "``restart_rearranger``", "box", "box io rearranger option for restart output (PIO only)", "default" - "", "default", "internal default io rearranger option for restart output", "" - "", "subset", "subset io rearranger option for restart output", "" + "``restart_rearranger``", "``box``", "box io rearranger option for restart output (PIO only)", "default" + "", "``default``", "internal default io rearranger option for restart output", "" + "", "``subset``", "subset io rearranger option for restart output", "" "``restart_root``", "integer", "pe root task for restart output with restart_iotasks and restart_stride (PIO only), -99=internal default", "-99" "``restart_stride``", "integer", "pe stride for restart output with restart_iotasks and restart_root (PIO only), -99=internal default", "-99" "``runid``", "string", "label for run (currently CESM only)", "'unknown'" @@ -324,13 +324,13 @@ grid_nml "", "``2``", "WMO standard categories", "" "", "``3``", "asymptotic scheme", "" "``kmt_file``", "string", "name of land mask file to be read", "``unknown_kmt_file``" - "``kmt_type``", "boxislands", "ocean/land mask set internally, complex test geometory", "file" - "", "channel", "ocean/land mask set internally as zonal channel", "" - "", "channel_oneeast", "ocean/land mask set internally as single gridcell east-west zonal channel", "" - "", "channel_onenorth", "ocean/land mask set internally as single gridcell north-south zonal channel", "" - "", "default", "ocean/land mask set internally, land in upper left and lower right of domain, ", "" - "", "file", "ocean/land mask setup read from file, see kmt_file", "" - "", "wall", "ocean/land mask set at right edge of domain", "" + "``kmt_type``", "``boxislands``", "ocean/land mask set internally, complex test geometory", "file" + "", "``channel``", "ocean/land mask set internally as zonal channel", "" + "", "``channel_oneeast``", "ocean/land mask set internally as single gridcell east-west zonal channel", "" + "", "``channel_onenorth``", "ocean/land mask set internally as single gridcell north-south zonal channel", "" + "", "``default``", "ocean/land mask set internally, land in upper left and lower right of domain, ", "" + "", "``file``", "ocean/land mask setup read from file, see kmt_file", "" + "", "``wall``", "ocean/land mask set at right edge of domain", "" "``latrefrect``","real","lower left corner lat for rectgrid in deg", "71.35" "``lonrefrect``","real","lower left corner lon for rectgrid in deg", "-156.5" "``nblyr``", "integer", "number of zbgc layers", "0" @@ -559,7 +559,7 @@ shortwave_nml "", "", "", "" "``ahmax``", "real", "albedo is constant above this thickness in meters", "0.3" - "``albedo_type``", "`ccsm3``", "NCAR CCSM3 albedo implementation", "``ccsm3``" + "``albedo_type``", "``ccsm3``", "NCAR CCSM3 albedo implementation", "``ccsm3``" "", "``constant``", "four constant albedos", "" "``albicei``", ":math:`0<\alpha <1`", "near infrared ice albedo for thicker ice", "0.36" "``albicev``", ":math:`0<\alpha <1`", "visible ice albedo for thicker ice", "0.78" @@ -620,9 +620,9 @@ snow_nml "", "``ITD``", "ITD snow redistribution scheme", "" "", "``ITDrdg``", "ITDrdg snow redistribution scheme", "" "", "``none``", "snow redistribution scheme off", "" - "``snw_aging_table``", "file", "read 1D and 3D fields for dry metamorophsis lookup table", "test" - "", "snicar", "read 3D fields for dry metamorophsis lookup table", "" - "", "test", "internally generated dry metamorophsis lookup table for testing", "" + "``snw_aging_table``", "'file'", "read 1D and 3D fields for dry metamorophsis lookup table", "test" + "", "``snicar``", "read 3D fields for dry metamorophsis lookup table", "" + "", "``test``", "internally generated dry metamorophsis lookup table for testing", "" "``snw_drdt0_fname``", "string", "snow aging file drdt0 fieldname", "unknown" "``snw_filename``", "string", "snow aging table data filename", "unknown" "``snw_kappa_fname``", "string", "snow aging file kappa fieldname", "unknown" @@ -648,10 +648,9 @@ forcing_nml :widths: 15, 15, 30, 15 "", "", "", "" - "``atmbndy``", "string", "bulk transfer coefficients", "``similarity``" - "", "``similarity``", "stability-based boundary layer", "" - "", "``constant``", "constant-based boundary layer", "" + "``atmbndy``", "``constant``", "constant-based bulk transfer coeff boundary layer", "``similarity``" "", "``mixed``", "stability-based boundary layer for wind stress, constant-based for sensible+latent heat fluxes", "" + "", "``similarity``", "stability-based bulk transfer coeff boundary layer", "" "``atmiter_conv``", "real", "convergence criteria for ustar", "0.0" "``atm_data_dir``", "string", "path or partial path to atmospheric forcing data directory", "" "``atm_data_format``", "``bin``", "read direct access binary atmo forcing file format", "``bin``" @@ -709,8 +708,7 @@ forcing_nml "", "``uniform``", "ice defined at all grid points", "" "``ice_ref_salinity``", "real", "sea ice salinity for coupling fluxes (ppt)", "4.0" "``iceruf``", "real", "ice surface roughness at atmosphere interface in meters", "0.0005" - "``l_mpond_fresh``", "``.false.``", "release pond water immediately to ocean", "``.false.``" - "", "``true``", "retain (topo) pond water until ponds drain", "" + "``l_mpond_fresh``", "logical", "retain (topo) pond water until ponds drain", "``.false.``" "``natmiter``", "integer", "number of atmo boundary layer iterations", "5" "``nfreq``", "integer", "number of frequencies in ocean surface wave spectral forcing", "25" "``oceanmixed_file``", "string", "data file containing ocean forcing data", "'unknown_oceanmixed_file'"