3.4. Case Settings, Model Namelist, and CPPs¶
There are two important files that define the case, cice.settings and ice_in. cice.settings is a list of env variables that define many values used to setup, build and run the case. ice_in is the input namelist file for CICE. Variables in both files are described below. In addition, the first table lists available preprocessor macros to activate or deactivate various features when compiling.
3.4.1. Table of C Preprocessor (CPP) Macros¶
The CICE model supports a number of C Preprocessor (CPP) Macros. These can be turned on during compilation to activate different pieces of source code. The main purpose is to introduce build-time code modifications to include or exclude certain libraries or Fortran language features. More information can be found in C Preprocessor (CPP) Macros. The following CPPs are available.
CPP name |
description |
---|---|
General Macros |
|
CESM1_PIO |
Provide backwards compatible support for PIO interfaces/version released with CESM1 in about 2010 |
ESMF_INTERFACE |
Turns on ESMF support in a subset of driver code. Also USE_ESMF_LIB and USE_ESMF_METADATA |
FORTRANUNDERSCORE |
Used in ice_shr_reprosum86.c to support Fortran-C interfaces. This should generally be turned on at all times. There are other CPPs (FORTRANDOUBULEUNDERSCORE, FORTRANCAPS, etc) in ice_shr_reprosum.c that are generally not used in CICE but could be useful if problems arise in the Fortran-C interfaces |
GPTL |
Turns on GPTL initialization if needed for PIO |
NO_F2003 |
Turns off some Fortran 2003 features |
NO_I8 |
Converts integer*8 to integer*4. This could have adverse affects for certain algorithms including the ddpdd implementation associated with the |
NO_R16 |
Converts real*16 to real*8. This could have adverse affects for certain algorithms including the lsum16 implementation associated with the |
NO_SNICARHC |
Does not compile hardcoded (HC) 5 band snicar tables tables needed by |
USE_NETCDF |
Turns on netCDF code. This is normally on and is needed for released configurations. An older value, ncdf, is still supported. |
USE_PIO1 |
Modifies CICE PIO implementation to be compatible with PIO1. By default, code is compatible with PIO2 |
Application Macros |
|
CESMCOUPLED |
Turns on code changes for the CESM coupled application |
CICE_IN_NEMO |
Turns on code changes for coupling in the NEMO ocean model |
CICE_DMI |
Turns on code changes for the DMI coupled model application |
ICE_DA |
Turns on code changes in the hadgem driver |
RASM_MODS |
Turns on code changes for the RASM coupled application |
Library Macros |
|
_OPENMP |
Automatically defined when compiling with OpenMP |
_OPENACC |
Automatically defined when compiling with OpenACC |
3.4.2. Table of CICE Settings¶
The cice.settings file contains a number of environment variables that define configuration, file system, run, and build settings. Several variables are set by the cice.setup script. This file is created on a case by case basis and can be modified as needed.
variable |
options/format |
description |
default value |
---|---|---|---|
ICE_CASENAME |
string |
case name |
set by cice.setup |
ICE_SANDBOX |
string |
sandbox directory |
set by cice.setup |
ICE_MACHINE |
string |
machine name |
set by cice.setup |
ICE_ENVNAME |
string |
environment name |
set by cice.setup |
ICE_MACHCOMP |
string |
machine_environment name |
set by cice.setup |
ICE_SCRIPTS |
string |
scripts directory |
set by cice.setup |
ICE_CASEDIR |
string |
case directory |
set by cice.setup |
ICE_RUNDIR |
string |
run directory |
set by cice.setup |
ICE_OBJDIR |
string |
compile directory |
${ICE_RUNDIR}/compile |
ICE_RSTDIR |
string |
unused |
${ICE_RUNDIR}/restart |
ICE_HSTDIR |
string |
unused |
${ICE_RUNDIR}/history |
ICE_LOGDIR |
string |
log directory |
${ICE_CASEDIR}/logs |
ICE_DRVOPT |
string |
unused |
standalone/cice |
ICE_TARGET |
string |
build target |
set by cice.setup |
ICE_IOTYPE |
string |
I/O source code |
set by cice.setup |
binary |
uses io_binary directory, no support for netCDF files |
||
netcdf |
uses io_netCDF directory, supports netCDF files |
||
pio1 |
uses io_pio directory with PIO1 library, supports netCDF and parallel netCDF thru PIO interfaces |
||
pio2 |
uses io_pio directory with PIO2 library, supports netCDF and parallel netCDF thru PIO interfaces |
||
ICE_CLEANBUILD |
true, false |
automatically clean before building |
true |
ICE_CPPDEFS |
user defined preprocessor macros for build |
null |
|
ICE_QUIETMODE |
true, false |
reduce build output to the screen |
false |
ICE_GRID |
string (see below) |
grid |
set by cice.setup |
gbox12 |
12x12 box |
||
gbox80 |
80x80 box |
||
gbox128 |
128x128 box |
||
gbox180 |
180x180 box |
||
gx1 |
1-deg displace-pole (Greenland) global grid |
||
gx3 |
3-deg displace-pole (Greenland) global grid |
||
tx1 |
1-deg tripole global grid |
||
ICE_NTASKS |
integer |
number of MPI tasks |
set by cice.setup |
ICE_NTHRDS |
integer |
number of threads per task |
set by cice.setup |
ICE_OMPSCHED |
string |
OpenMP SCHEDULE env setting |
static,1 |
ICE_TEST |
string |
test setting if using a test |
set by cice.setup |
ICE_TESTNAME |
string |
test name if using a test |
set by cice.setup |
ICE_TESTID |
string |
test name testid |
set by cice.setup |
ICE_BASELINE |
string |
baseline directory name, associated with cice.setup –bdir |
set by cice.setup |
ICE_BASEGEN |
string |
baseline directory name for regression generation, associated with cice.setup -bgen |
set by cice.setup |
ICE_BASECOM |
string |
baseline directory name for regression comparison, associated with cice.setup -bcmp |
set by cice.setup |
ICE_BFBCOMP |
string |
location of case for comparison, associated with cice.setup –bcmp |
set by cice.setup |
ICE_BFBTYPE |
string |
type and files used in BFBCOMP |
restart |
log |
log file comparison for bit for bit |
||
logrest |
log and restart files for bit for bit |
||
qcchk |
QC test for same climate |
||
qcchkf |
QC test for different climate |
||
restart |
restart files for bit for bit |
||
ICE_SPVAL |
string |
special value for cice.settings strings |
set by cice.setup |
ICE_RUNLENGTH |
integer (see below) |
batch run length default |
set by cice.setup |
-1 |
15 minutes (default) |
||
0 |
30 minutes |
||
1 |
59 minutes |
||
2 |
2 hours |
||
other \(2 < N < 8\) |
N hours |
||
8 or larger |
8 hours |
||
ICE_ACCOUNT |
string |
batch account number |
set by cice.setup, .cice_proj or by default |
ICE_QUEUE |
string |
batch queue name |
set by cice.setup or by default |
ICE_THREADED |
true, false |
force threading in compile, will always compile threaded if ICE_NTHRDS \(> 1\) |
false |
ICE_COMMDIR |
mpi, serial |
specify infrastructure comm version |
set by ICE_NTASKS |
ICE_SNICARHC |
true, false |
turn on hardcoded (HC) SNICAR tables in Icepack |
false |
ICE_BLDDEBUG |
true, false |
turn on compile debug flags |
false |
ICE_COVERAGE |
true, false |
turn on code coverage flags |
false |
3.4.3. Tables of Namelist Options¶
CICE reads a namelist input file, ice_in, consisting of several namelist groups. The tables below summarize the different groups and the variables in each group. The variables are organized alphabetically and the default values listed are the values defined in the source code. Those values will be used unless overridden by the CICE namelist file, ice_in. The source code default values as listed in the table are not necessarily the recommended production values.
3.4.3.1. setup_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
|
local reduction then global scalar sum |
|
|
local reduction with real*4 then global scalar sum |
||
|
local reduction with real*8 then global scalar sum |
||
|
local reduction with real*16 then global scalar sum |
||
|
parallel double double algorithm |
||
|
fixed point double integer sum |
||
|
logical |
check conservation |
|
|
logical |
couple bgc thru driver |
|
|
integer |
number of days in a model year |
365 |
|
integer |
the initial day of the month if not using restart |
1 |
|
logical |
write extra forcing diagnostics |
|
|
logical |
write extended model point diagnostics |
|
|
integer |
local i index of debug_model point |
-1 |
|
integer |
iblk value for debug_model point |
-1 |
|
integer |
local j index of debug_model point |
-1 |
|
integer |
mpi task value for debug_model point |
-1 |
|
logical |
initial timestep to write |
0 |
|
integer |
frequency of diagnostic output in timesteps |
24 |
|
|
write diagnostic output to stdout |
|
|
write diagnostic output to file |
||
|
string |
diagnostic output file |
‘ice_diag.d’ |
|
real |
thermodynamics time step length in seconds |
|
|
|
write restart every |
‘y’,’x’,’x’,’x’,’x’ |
|
write restart once after |
||
|
write restart every |
||
|
write restart once after |
||
|
write restart every |
||
|
write restart once after |
||
|
write restart every |
||
|
write restart once after |
||
|
write restart every |
||
|
write restart once after |
||
|
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 |
||
|
integer array |
write restart frequency with |
1,1,1,1,1 |
|
logical |
write restart on last time step of simulation |
|
|
|
write history every |
‘1’,’h’,’d’,’m’,’y’ |
|
write history every |
||
|
write history every |
||
|
unused frequency stream (not written) |
||
|
write history every |
||
|
write history every |
||
|
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 |
||
|
integer array |
frequency history output is written with |
1,1,1,1,1 |
|
integer array |
chunksizes (x,y) for history output (hdf5 only) |
0,0 |
|
integer |
compression level (0 to 9) for history output (hdf5 only) |
0 |
|
string |
path to history output directory |
‘./’ |
|
string |
output file for history |
‘iceh’ |
|
|
write history files with binary format |
|
|
write history files with netcdf cdf1 (netcdf3-classic) format |
||
|
write history files with netcdf cdf2 (netcdf3-64bit-offset) format |
||
|
write history files with netcdf cdf5 (netcdf3-64bit-data) format |
||
|
write history files in default format |
||
|
write history files with netcdf hdf5 (netcdf4) format |
||
|
write history files with pnetcdf in PIO, deprecated |
||
|
write history files with netcdf in PIO, deprecated |
||
|
write history files with pnetcdf cdf1 (netcdf3-classic) format |
||
|
write history files with pnetcdf cdf2 (netcdf3-64bit-offset) format |
||
|
write history files with pnetcdf cdf5 (netcdf3-64bit-data) format |
||
|
integer |
pe io tasks for history output with history_root and history_stride (PIO only), -99=internal default |
-99 |
|
integer |
history file precision: 4 or 8 byte |
4 |
|
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 |
||
|
integer |
pe root task for history output with history_iotasks and history_stride (PIO only), -99=internal default |
-99 |
|
integer |
pe stride for history output with history_iotasks and history_root (PIO only), -99=internal default |
-99 |
|
logical |
write time-averaged data |
|
|
character array |
appended to history_file when not x |
|
|
character |
history file time axis interval location: begin, middle, end |
end |
|
|
equal to internal |
|
|
initial conditions set based on ice_data_type,conc,dist inputs |
||
|
no ice |
||
‘path/file’ |
restart file name |
||
|
string |
path to initial condition directory |
‘./’ |
|
string |
output file prefix for initial condition |
‘iceh_ic’ |
|
integer |
initial time step number |
0 |
|
real |
latitude of (2) diagnostic points |
90.0,-65.0 |
|
logical |
use 64-bit netCDF format, deprecated, see history_format, restart_format |
|
|
real |
longitude of (2) diagnostic points |
0.0,-45.0 |
|
logical |
turns on memory use diagnostics |
|
|
integer |
the initial month if not using restart |
1 |
|
integer |
number of dynamics/advection/ridging/steps per thermo timestep |
1 |
|
integer |
total number of npt_units to run the model |
99999 |
|
|
run |
1 |
|
run |
||
|
run |
||
|
run |
||
|
run |
||
|
run |
||
|
integer |
minimum internal IO unit number |
11 |
|
integer |
maximum internal IO unit number |
99 |
|
string |
restart pointer filename |
‘ice.restart_file’ |
|
logical |
print global sums diagnostic data |
|
|
logical |
print diagnostic data for two grid points |
|
|
logical |
exists but deprecated, now set internally based on other inputs |
|
|
integer array |
chunksizes (x,y) for restart output (hdf5 only) |
0,0 |
|
integer |
compression level (0 to 9) for restart output (hdf5 only) |
0 |
|
string |
path to restart directory |
‘./’ |
|
logical |
read/write halo cells in restart files |
|
|
string |
output file prefix for restart dump |
‘iced’ |
|
|
write restart files with binary format |
|
|
write restart files with netcdf cdf1 (netcdf3-classic) format |
||
|
write restart files with netcdf cdf2 (netcdf3-64bit-offset) format |
||
|
write restart files with netcdf cdf5 (netcdf3-64bit-data) format |
||
|
write restart files in default format |
||
|
write restart files with netcdf hdf5 (netcdf4) format |
||
|
write restart files with pnetcdf in PIO, deprecated |
||
|
write restart files with netcdf in PIO, deprecated |
||
|
write restart files with pnetcdf cdf1 (netcdf3-classic) format |
||
|
write restart files with pnetcdf cdf2 (netcdf3-64bit-offset) format |
||
|
write restart files with pnetcdf cdf5 (netcdf3-64bit-data) format |
||
|
integer |
pe io tasks for restart output with restart_root and restart_stride (PIO only), -99=internal default |
-99 |
|
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 |
||
|
integer |
pe root task for restart output with restart_iotasks and restart_stride (PIO only), -99=internal default |
-99 |
|
integer |
pe stride for restart output with restart_iotasks and restart_root (PIO only), -99=internal default |
-99 |
|
string |
label for run (currently CESM only) |
‘unknown’ |
|
|
restart using |
|
|
start from |
||
|
integer |
the initial second if not using restart |
0 |
|
logical |
controls extra timer output |
|
|
logical |
include leap days |
|
|
logical |
set initial date using restart file on initial runtype only |
|
|
string |
model version |
‘unknown_version_name’ |
|
logical |
write initial condition |
|
|
integer |
the initial year if not using restart |
0 |
3.4.3.2. grid_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
string |
name of bathymetry file to be read |
‘unknown_bathymetry_file’ |
|
|
NetCDF depth field |
‘default’ |
|
pop thickness file in cm in ascii format |
||
|
logical |
force two gridcell wide land mask on boundaries for rectangular grids |
|
|
real |
x-direction grid spacing for rectangular grid in cm |
0.0 |
|
real |
user defined rectgrid x-grid scale factor |
1.0 |
|
real |
y-direction grid spacing for rectangular grid in cm |
0.0 |
|
real |
user defined rectgrid y-grid scale factor |
1.0 |
|
string |
input file for coupling grid info |
‘unknown_gridcpl_file’ |
|
|
atm forcing/coupling grid, all fields on T grid |
|
|
atm forcing/coupling grid, thermo fields on T grid, dyn fields on U grid |
||
|
atm forcing/coupling grid, thermo fields on T grid, dynu fields on E grid, dynv fields on N grid |
||
|
atm forcing/coupling grid, thermo fields on T grid, dyn fields on N and E grid |
||
|
string |
name of grid file to be read |
‘unknown_grid_file’ |
|
|
read direct access grid and kmt files |
|
|
read grid and kmt files |
||
|
|
use B grid structure with T at center and U at NE corner |
|
|
use C grid structure with T at center, U at E edge, V at N edge |
||
|
|
ocn forcing/coupling grid, all fields on T grid |
|
|
ocn forcing/coupling grid, thermo fields on T grid, dyn fields on U grid |
||
|
ocn forcing/coupling grid, thermo fields on T grid, dynu fields on E grid, dynv fields on N grid |
||
|
ocn forcing/coupling grid, thermo fields on T grid, dyn fields on N and E grid |
||
|
|
read from file in popgrid |
|
|
defined in rectgrid |
||
|
read from file in popgrid |
||
|
read from file in popgrid |
||
|
|
single category formulation |
1 |
|
old formulation |
||
|
new formulation with round numbers |
||
|
WMO standard categories |
||
|
asymptotic scheme |
||
|
string |
name of land mask file to be read |
|
|
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 |
||
|
real |
lower left corner lat for rectgrid in deg |
71.35 |
|
real |
lower left corner lon for rectgrid in deg |
-156.5 |
|
integer |
number of zbgc layers |
0 |
|
integer |
number of ice thickness categories |
0 |
|
integer |
number of floe size categories |
1 |
|
integer |
number of vertical layers in ice |
0 |
|
integer |
number of vertical layers in snow |
0 |
|
logical |
use orca haloed grid for data/grid read |
|
|
logical |
apply dxscale, dyscale to rectgrid |
|
|
logical |
use read in bathymetry file for seabedstress option |
|
3.4.3.3. domain_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
logical |
throttle communication |
|
|
integer |
block size in x direction |
-1 |
|
integer |
block size in y direction |
-1 |
|
logical |
add additional print statements to debug the block decomposition |
|
|
|
2D cartesian block distribution method |
|
|
redistribute blocks among neighbors |
||
|
1 block per proc until blocks are used |
||
|
blocks distributed to domain quadrants |
||
|
several blocks per proc until used |
||
|
distribute blocks via space-filling curves |
||
|
distribute blocks via roundrobin from center of grid outward in a spiral |
||
|
distribute blocks based on weights specified in |
||
|
|
full block weight method with land block elimination |
|
|
full block weight method without land block elimination |
||
|
latitude/ocean sets |
||
|
string |
distribution weight file when distribution_type is |
‘unknown’ |
|
|
periodic boundary conditions in x-direction |
|
|
Dirichlet boundary conditions in x |
||
|
logical |
mask unused halo cells for dynamics |
|
|
logical |
mask unused halo cells for transport |
|
|
logical |
mask unused halo cells for boundary updates |
|
|
integer |
maximum number of blocks per MPI task for memory allocation |
-1 |
|
integer |
number of MPI tasks to use |
-1 |
|
find number of MPI tasks automatically |
||
|
|
periodic boundary conditions in y-direction |
|
|
Dirichlet boundary conditions in y |
||
|
U-fold tripole boundary conditions in y |
||
|
T-fold tripole boundary conditions in y |
||
|
integer |
global grid size in x direction |
-1 |
|
integer |
global grid size in y direction |
-1 |
|
|
1 processor in the y direction used with |
|
|
1 processor in the y direction (tall, thin) |
||
|
2 processors in the y direction (thin) |
||
|
more processors in x than y, \(\sim\) square |
||
|
more processors in y than x, \(\sim\) square |
||
3.4.3.4. tracer_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
integer |
number of aerosol tracers |
0 |
|
0,1,2,3 |
number of algal tracers |
0 |
|
0,1 |
number of dissolved inorganic carbon |
0 |
|
0,1,2,3 |
number of dissolved organic carbon |
0 |
|
0,1 |
number of dissolved organize nitrogen |
0 |
|
0,1,2 |
number of dissolved iron tracers |
0 |
|
0,1,2 |
number of particulate iron tracers |
0 |
|
integer |
number of isotope tracers |
0 |
|
0,1,2,3,4,5,6 |
number of z aerosol tracers in use |
0 |
|
logical |
aerosols |
|
|
logical |
floe size distribution |
|
|
logical |
first-year ice area |
|
|
logical |
ice age |
|
|
logical |
isotopes |
|
|
logical |
level ice area and volume |
|
|
logical |
level-ice melt ponds |
|
|
DEPRECATED |
||
|
logical |
topo melt ponds |
|
|
logical |
advanced snow physics |
|
|
logical |
restart tracer values from file |
|
|
logical |
restart tracer values from file |
|
|
logical |
restart floe size distribution values from file |
|
|
logical |
restart tracer values from file |
|
|
logical |
restart tracer values from file |
|
|
logical |
restart tracer values from file |
|
|
logical |
restart tracer values from file |
|
|
logical |
restart tracer values from file |
|
|
logical |
restart snow tracer values from file |
|
3.4.3.5. thermo_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
real |
brine channel diameter in m |
0.5e-3 |
|
real |
brine convection aspect ratio |
1.0 |
|
|
conductivity scheme [45] |
|
|
conductivity [40] |
||
|
real |
slow drainage strength parameter m/s/K |
-1.5e-7 |
|
real |
effective floe diameter for lateral melt in m |
300.0 |
|
real |
min thickness of new frazil ice in m |
0.05 |
|
real |
minimum ice thickness in m |
0.01 |
|
|
delta function ITD approximation |
1 |
|
linear remapping ITD approximation |
||
|
real |
snow thermal conductivity |
0.3 |
|
|
thermodynamic model disabled |
1 |
|
Bitz and Lipscomb thermodynamic model |
||
|
mushy-layer thermodynamic model |
||
|
\(0<\phi_c < 1\) |
critical liquid fraction |
0.05 |
|
\(0<\phi_i < 1\) |
solid fraction at lower boundary |
0.85 |
|
real |
critical Rayleigh number |
10.0 |
|
real |
maximum liquidus temperature of mush (C) |
0.0 |
3.4.3.6. dynamics_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
|
linear remapping advection scheme |
|
|
donor cell advection |
||
|
|
use nonlinear anderson algorithm for implicit solver |
picard |
|
use picard algorithm |
||
|
real |
\(\alpha_{b}\) factor in [34] |
20.0 |
|
real |
revised_evp value |
300.0 |
|
real |
revised_evp value |
300.0 |
|
|
max capping in [15] |
max |
|
sum capping in [31] |
||
|
real |
ratio of ridging work to PE change in ridging |
17.0 |
|
|
constant coriolis value = 1.46e-4 s\(^{-1}\) |
|
|
coriolis variable by latitude |
||
|
zero coriolis |
||
|
real |
constant in Hibler strength formula |
20 |
|
real |
minimum delta for viscosities |
1e-11 |
|
real |
minimum delta for viscosities |
2e-9 |
|
integer |
maximum number of Arnoldi iterations for FGMRES solver |
50 |
|
integer |
maximum number of Arnoldi iterations for PGMRES preconditioner |
5 |
|
real |
aspect ratio of elliptical plastic potential |
2.0 |
|
real |
aspect ratio of elliptical yield curve |
2.0 |
|
real |
elastic damping parameter |
0.36 |
|
|
standard 2d EVP memory parallel solver |
standard_2d |
|
1d shared memory solver |
||
|
|
dynamics algorithm OFF |
1 |
|
dynamics OFF |
||
|
EVP dynamics |
||
|
EAP dynamics |
||
|
VP dynamics |
||
|
|
ice strength formulation [15] |
1 |
|
ice strength formulation [52] |
||
|
|
old ridging participation function |
1 |
|
new ridging participation function |
||
|
|
old ridging redistribution function |
1 |
|
new ridging redistribution function |
||
|
|
ridging disabled |
1 |
|
ridging enabled |
||
|
|
transport disabled |
1 |
|
transport enabled |
||
|
real |
Tensile strength factor (see [3]) |
0.0 |
|
real |
1st free parameter for landfast parameterization |
7.5 |
|
real |
2nd free parameter (N/m\(^3\)) for landfast parameterization |
15.0 |
|
integer |
maximum number of restarts for FGMRES solver |
1 |
|
integer |
maximum number of nonlinear iterations for VP solver |
10 |
|
integer |
maximum number of restarts for PGMRES preconditioner |
1 |
|
logical |
write velocity norm at each FGMRES iteration |
|
|
logical |
write velocity norm at each nonlinear iteration |
|
|
logical |
write velocity norm at each PGMRES iteration |
|
|
real |
e-folding scale of ridged ice for |
3.0 |
|
integer |
number of EVP subcycles |
120 |
|
|
Use classical Gram-Shchmidt in FGMRES solver |
|
|
Use modified Gram-Shchmidt in FGMRES solver |
||
|
|
Use Jacobi preconditioner for the FGMRES solver |
|
|
Don’t use a preconditioner for the FGMRES solver |
||
|
Use GMRES as preconditioner for FGMRES solver |
||
|
real |
constant in Hibler strength formula (N/m\(^2\)) |
2.75e4 |
|
real |
relative tolerance for FGMRES solver |
1e-1 |
|
real |
relative tolerance for nonlinear solver |
1e-8 |
|
real |
relative tolerance for PGMRES preconditioner |
1e-6 |
|
logical |
use revised EVP formulation |
|
|
logical |
use seabed stress parameterization for landfast ice |
|
|
|
linear keel draft method [34] |
|
|
probability of contact method [11] |
||
|
|
computed from coupled sea surface height gradient |
|
|
computed from ocean velocity |
||
|
real |
Max water depth for grounding (see [1]) |
|
|
logical |
Use mean of two previous iterations for vrel in VP |
|
|
|
average strength for viscosities on U grid |
|
|
average zeta for viscosities on U grid |
||
|
|
elliptical yield curve |
|
3.4.3.7. shortwave_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
real |
albedo is constant above this thickness in meters |
0.3 |
|
ccsm3` |
NCAR CCSM3 albedo implementation |
|
|
four constant albedos |
||
|
\(0<\alpha <1\) |
near infrared ice albedo for thicker ice |
0.36 |
|
\(0<\alpha <1\) |
visible ice albedo for thicker ice |
0.78 |
|
\(0<\alpha <1\) |
near infrared, cold snow albedo |
0.70 |
|
\(0<\alpha <1\) |
visible, cold snow albedo |
0.98 |
|
real |
\(\Delta\) temperature per \(\Delta\) snow grain radius |
1.5 |
|
real |
absorption coefficient for algae |
0.6 |
|
real |
maximum melting snow grain radius |
|
|
real |
tuning parameter for sea ice albedo from Delta-Eddington shortwave |
0.0 |
|
real |
tuning parameter for ponded sea ice albedo from Delta-Eddington shortwave |
0.0 |
|
real |
tuning parameter for snow (broadband albedo) from Delta-Eddington shortwave |
1.5 |
|
|
NCAR CCSM3 shortwave distribution method |
|
|
Delta-Eddington method (3-band) |
||
|
Delta-Eddington method with 5 band snow |
||
|
|
lookup table for dEdd_snicar_ad |
|
|
reduced lookup table for dEdd_snicar_ad testing |
||
|
real |
temperature difference from melt to start redistributing |
0.02 |
|
real |
fraction redistributed |
0.9 |
|
logical |
redistribute internal shortwave to surface |
|
3.4.3.8. ponds_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
real |
time scale for flushing in permeable ice |
1.0 |
|
|
CESM pond refreezing forumulation |
|
|
Stefan refreezing with pond ice thickness |
||
|
real |
critical ice lid thickness for topo ponds in m |
0.01 |
|
real |
snow depth of transition to bare sea ice in m |
|
|
real |
snow depth of transition to pond ice in m |
0.03 |
|
real |
aspect ratio of pond changes (depth:area) |
0.8 |
|
\(0 \le r_{max} \le 1\) |
maximum melt water added to ponds |
0.85 |
|
\(0 \le r_{min} \le 1\) |
minimum melt water added to ponds |
0.15 |
3.4.3.9. snow_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
real |
wind compactions factor for now in kg-s/m^4 |
27.3 |
|
real |
maximum snow density in kg/m^3 |
|
|
real |
minimum snow density in kg/m^3 |
|
|
real |
new snow density in kg/m^3 |
|
|
real |
radius of new snow in 1.0e-6 m |
|
|
real |
maximum snow radius in 1.0e-6 m |
|
|
logical |
snow metamorophsis flag |
|
|
real |
fractional increase in snow |
0.3 |
|
|
bulk snow redistribution scheme |
|
|
ITD snow redistribution scheme |
||
|
ITDrdg snow redistribution scheme |
||
|
snow redistribution scheme off |
||
|
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 |
||
|
string |
snow aging file drdt0 fieldname |
unknown |
|
string |
snow aging table data filename |
unknown |
|
string |
snow aging file kappa fieldname |
unknown |
|
string |
snow aging file rhos fieldname |
unknown |
|
string |
snow aging file T fieldname |
unknown |
|
string |
snow aging file tau fieldname |
unknown |
|
string |
snow aging file Tgrd fieldname |
unknown |
|
logical |
use liquid in snow for ponds |
|
|
real |
minimum wind speed to compact snow in m/s |
|
3.4.3.10. forcing_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
string |
bulk transfer coefficients |
|
|
stability-based boundary layer |
||
|
constant-based boundary layer |
||
|
stability-based boundary layer for wind stress, constant-based for sensible+latent heat fluxes |
||
|
real |
convergence criteria for ustar |
0.0 |
|
string |
path or partial path to atmospheric forcing data directory |
|
|
|
read direct access binary atmo forcing file format |
|
|
read netcdf atmo forcing files |
||
|
|
forcing data for [20] box problem |
|
|
constant values defined in the code |
||
|
HYCOM atm forcing data in netCDF format |
||
|
JRA55 forcing data [61] |
||
|
JRA55do forcing data [61] |
||
|
monthly forcing data |
||
|
NCAR bulk forcing data |
||
|
column forcing data |
||
|
string |
date of atm data forcing file creation |
|
|
string |
path to oceanic forcing data directory |
‘unknown_bgc_data_dir’ |
|
|
bgc climatological data |
|
|
constant values defined in the code |
||
|
HYCOM ocean forcing data in netCDF format |
||
|
POP ocean forcing data |
||
|
|
read wind stress and speed from files |
|
|
calculate wind stress and speed |
||
|
logical |
calculate surface temperature |
|
|
|
frazil water/salt fluxes are handled outside of Icepack |
|
|
correct fresh-ice frazil water/salt fluxes for mushy physics |
||
|
send full frazil water/salt fluxes for mushy physics |
||
|
|
forcing initial summer values |
|
|
forcing initial winter values |
||
|
real |
emissivity of snow and ice |
0.985 |
|
|
variable ocean heat transfer coefficient scheme |
|
|
constant ocean heat transfer coefficient |
||
|
|
ocean climatology forcing value for iron |
|
|
default forcing value for iron |
||
|
logical |
calculate form drag |
|
|
integer |
first year of atmospheric forcing data |
1900 |
|
logical |
high-frequency atmo coupling |
|
|
|
ice distribution ramped from 0 to 1 west to east consistent with box2001 test ([20]) |
|
|
initial ice concentation of 1.0 |
||
|
same as parabolic |
||
|
initial concentration of 0.5 |
||
|
initial concentration of 0.8 |
||
|
initial concentration of 0.9 |
||
|
parabolic in ice thickness space with sum of aicen=1.0 |
||
|
|
ice distribution ramped from 0 to 1 west to east consistent with box2001 test ([20]) |
|
|
uniform distribution, equivalent to uniform |
||
|
gauss distbution of ice with a peak in the center of the domain |
||
|
uniform distribution, equivalent to default |
||
|
|
ice block covering about 25 percent of the area in center of domain |
|
|
slot cylinder ice mask associated with boxslotcyl test ([67]) |
||
|
|||
|
ice defined on entire grid in i-direction and 50% in j-direction in center of domain |
||
|
same as latsst |
||
|
ice block covering about 25 percent of domain at the east edge of the domain |
||
|
ice dependent on latitude and ocean temperature |
||
|
ice defined at all grid points |
||
|
real |
sea ice salinity for coupling fluxes (ppt) |
4.0 |
|
real |
ice surface roughness at atmosphere interface in meters |
0.0005 |
|
|
release pond water immediately to ocean |
|
|
retain (topo) pond water until ponds drain |
||
|
integer |
number of atmo boundary layer iterations |
5 |
|
integer |
number of frequencies in ocean surface wave spectral forcing |
25 |
|
string |
data file containing ocean forcing data |
‘unknown_oceanmixed_file’ |
|
logical |
active ocean mixed layer calculation |
|
|
string |
path to oceanic forcing data directory |
‘unknown_ocn_data_dir’ |
|
|
read direct access binary ocean forcing files |
|
|
read netCDF ocean forcing files |
||
|
|
ocean climatological data formulation |
|
|
constant values defined in the code |
||
|
HYCOM ocean forcing data in netCDF format |
||
|
POP ocean forcing data |
||
|
|
liquid precipitation data units |
|
|
|||
|
(same as MKS units) |
||
|
|||
|
logical |
read/write coszen in restart files |
|
|
logical |
restore sst to data |
|
|
logical |
restore ice state along lateral boundaries |
|
|
logical |
rotate wind from east/north to computation grid |
|
|
|
computed using ice_ref_salinity |
|
|
computed using prognostic salinity |
||
|
|
constant ocean freezing temperature (Tocnfrz) |
|
|
linear function of salinity (ktherm=1) |
||
|
constant ocean freezing temperature (\(-1.8^{\circ} C\)) |
||
|
matches mushy-layer thermo (ktherm=2) |
||
|
integer |
sst restoring time scale (days) |
90 |
|
real |
minimum value of ocean friction velocity in m/s |
0.0005 |
|
|
do not include frazil water/salt fluxes in ocn fluxes |
|
|
include frazil water/salt fluxes in ocn fluxes |
||
|
string |
data file containing wave spectrum forcing data |
|
|
|
wave data file is provided, constant wave spectrum, for testing |
|
|
no wave data provided, no wave-ice interactions |
||
|
no wave data file is provided, use fixed dummy wave spectrum, for testing |
||
|
wave data file is provided, wave spectrum generated using random number |
||
|
integer |
number of years in forcing data cycle |
1 |
3.4.3.11. zbgc_nml¶
variable |
options/format |
description |
default value |
---|---|---|---|
|
real |
mobility type between stationary and mobile algal diatoms |
0.0 |
|
real |
mobility type between stationary and mobile algal phaeocystis |
0.5 |
|
real |
mobility type between stationary and mobile small plankton |
0.5 |
|
real |
1.11e-8 |
|
|
real |
light limitation diatoms 1/(W/m^2) |
0.8 |
|
real |
light limitation phaeocystis 1/(W/m^2) |
0.67 |
|
real |
light limitation small plankton 1/(W/m^2) |
0.67 |
|
real |
mobility type between stationary and mobile ammonium |
1.0 |
|
real |
light inhibition diatoms 1/(W/m^2) |
0.18 |
|
real |
light inhibition phaeocystis 1/(W/m^2) |
0.01 |
|
real |
light inhibition small plankton 1/(W/m^2) |
0.0025 |
|
|
constant ice–ocean flux velocity |
|
|
ice–ocean flux velocity of [26] |
||
|
real |
chl absorbtion diatoms 1/m/(mg/m^3) |
0.03 |
|
real |
chl absorbtion phaeocystis 1/m/(mg/m^3) |
0.05 |
|
real |
chl absorbtion small plankton 1/m/(mg/m^3) |
0.01 |
|
logical |
|
|
|
real |
mobility type between stationary and mobile dmspd |
-1.0 |
|
real |
mobility type between stationary and mobile dmspp |
0.5 |
|
real |
mobility type between stationary and mobile doc lipids |
0.5 |
|
real |
mobility type between stationary and mobile doc saccharids |
0.5 |
|
real |
mobility type between stationary and mobile don proteins |
0.5 |
|
real |
solubility fraction |
0.005 |
|
real |
mobility type between stationary and mobile fed lipids |
0.5 |
|
real |
mobility type between stationary and mobile fep lipids |
0.5 |
|
real |
increase in initial bio bracer from ocean scavenging |
1.0 |
|
real |
fraction of remineralized nitrogen in units of algal iron |
0.3 |
|
real |
fraction grazed diatoms |
0.01 |
|
real |
fraction of assimilation excreted |
0.5 |
|
real |
fraction grazed phaeocystis |
0.1 |
|
real |
fraction of grazing spilled or slopped |
0.5 |
|
real |
fraction grazed small plankton |
0.1 |
|
real |
fractionation of mortality to Am |
0.5 |
|
real |
frac of algal growth lost due to respiration |
0.05 |
|
real |
DMSPd fraction of respiration loss as DMSPd |
0.75 |
|
real |
salinity limitation ppt |
1.0 |
|
real |
scales absorbed radiation for dEdd chl diatoms |
2.0 |
|
real |
scales absorbed radiation for dEdd chl phaeocystis |
5.0 |
|
real |
scales absorbed radiation for dEdd small plankton |
4.0 |
|
real |
fraction of mortality to DOC lipids |
0.4 |
|
real |
fraction of mortality to DOC saccharides |
0.4 |
|
real |
fraction of remineralized DON to ammonium |
0.25 |
|
real |
fraction of spilled grazing to proteins |
0.6 |
|
real |
fraction of exudation to DOC lipids |
1.0 |
|
real |
fraction of exudation to DOC saccharids |
1.0 |
|
real |
z biology for bottom flux |
5.0 |
|
real |
z biology for top flux |
5.0 |
|
real |
zsalinity DEPRECATED |
|
|
real |
temperature dependence growth diatoms per degC |
0.06 |
|
real |
temperature dependence growth phaeocystis per degC |
0.06 |
|
real |
temperature dependence growth small plankton per degC |
0.06 |
|
real |
mobility type between stationary and mobile hum |
1.0 |
|
real |
fraction of ocean trcr concentration in bio tracers |
1.0 |
|
real |
ammonium half saturation diatoms mmol/m^3 |
0.3 |
|
real |
ammonium half saturation phaeocystis mmol/m^3 |
0.3 |
|
real |
ammonium half saturation small plankton mmol/m^3 |
0.3 |
|
real |
Bacterial degredation of DOC lipids per day |
0.03 |
|
real |
Bacterial degredation of DOC saccharids per day |
0.03 |
|
real |
algal exudation diatoms per day |
0.0 |
|
real |
algal exudation phaeocystis per day |
0.0 |
|
real |
algal exudation small plankton per day |
0.0 |
|
real |
iron half saturation diatoms nM |
1.0 |
|
real |
iron half saturation phaeocystis nM |
0.1 |
|
real |
iron half saturation small plankton nM |
0.2 |
|
real |
nitrification rate per day |
0.0 |
|
real |
nitrate half saturation diatoms mmol/m^3 |
1.0 |
|
real |
nitrate half saturation phaeocystis mmol/m^3 |
1.0 |
|
real |
nitrate half saturation small plankton mmol/m^3 |
1.0 |
|
real |
silicate half saturation diatoms mmol/m^3 |
4.0 |
|
real |
silicate half saturation phaeocystis mmol/m^3 |
0.0 |
|
real |
silicate half saturation small plankton mmol/m^3 |
0.0 |
|
real |
bacterial degradation of DON per day |
0.03 |
|
real |
characteristic diffusive scale in m |
7.0 |
|
real |
zsalinity DEPRECATED |
|
|
real |
max ratio of dFe to saccharides in the ice in nm Fe / muM C |
0.2 |
|
real |
restrict uptake to percent of remaining value |
0.9 |
|
logical |
modal aerosols |
|
|
real |
mortality diatoms |
0.007 |
|
real |
mortality phaeocystis |
0.007 |
|
real |
mortality small plankton |
0.007 |
|
real |
temperature dependence of mortality diatoms per degC |
0.03 |
|
real |
temperature dependence of mortality phaeocystis per degC |
0.03 |
|
real |
temperature dependence of mortality small plankton per degC |
0.03 |
|
real |
maximum growth rate diatoms per day |
1.2 |
|
real |
maximum growth rate phaeocystis per day |
0.851 |
|
real |
maximum growth rate small plankton per day |
0.851 |
|
real |
mobility type between stationary and mobile nitrate |
-1.0 |
|
real |
light attenuates for optical depths exceeding min |
0.1 |
|
real |
snow porosity for brine height tracer |
0.5 |
|
real |
algal chl to N in mg/mmol diatoms |
2.1 |
|
real |
algal chl to N in mg/mmol phaeocystis |
0.84 |
|
real |
algal chl to N in mg/mmol small plankton |
1.1 |
|
real |
algal C to N in mol/mol diatoms |
7.0 |
|
real |
algal C to N in mol/mol phaeocystis |
7.0 |
|
real |
algal C to N in mol/mol proteins |
7.0 |
|
real |
algal C to N in mol/mol small plankton |
7.0 |
|
real |
algal Fe to C in umol/mol diatoms |
0.0033 |
|
real |
algal Fe to C in umol/mol phaeocystis |
1.0 |
|
real |
algal Fe to C in umol/mol small plankton |
0.0033 |
|
real |
algal Fe to N in umol/mol diatoms |
0.23 |
|
real |
algal Fe to N in umol/mol phaeocystis |
0.7 |
|
real |
algal Fe to N in umol/mol small plankton |
0.23 |
|
real |
Fe to C of DON saccharids nmol/umol |
1.0 |
|
real |
Fe to C of DOC lipids nmol/umol |
0.033 |
|
real |
Fe to C of DON nmol/umol |
0.023 |
|
real |
algal Si to N in mol/mol diatoms |
1.8 |
|
real |
algal Si to N in mol/mol phaeocystis |
0.0 |
|
real |
algal Si to N in mol/mol small plankton |
0.0 |
|
real |
algal S to N in mol/mol diatoms |
0.03 |
|
real |
algal S to N in mol/mol phaeocystis |
0.03 |
|
real |
algal S to N in mol/mol small plankton |
0.03 |
|
logical |
restart tracer values from file |
|
|
logical |
|
|
|
logical |
zsalinity DEPRECATED |
|
|
logical |
restore bgc to data |
|
|
real |
g/g [57] |
0.035 |
|
logical |
|
|
|
real |
mobility type between stationary and mobile silicate |
-1.0 |
|
logical |
biogeochemistry |
|
|
logical |
|
|
|
logical |
zsalinity DEPRECATED, update salinity tracer profile |
|
|
real |
long time mobile to stationary exchanges |
1.73e-5 |
|
real |
rapid module to stationary exchanges |
|
|
logical |
ammonium tracer |
|
|
logical |
algal carbon tracer |
|
|
logical |
algal chlorophyll tracer |
|
|
logical |
DMS tracer |
|
|
logical |
DON tracer |
|
|
logical |
iron tracer |
|
|
logical |
|
|
|
logical |
|
|
|
logical |
PON tracer |
|
|
logical |
silicate tracer |
|
|
logical |
brine height tracer |
|
|
logical |
vertical aerosol tracers |
|
|
real |
desorption loss pFe to dFe in days |
|
|
real |
Stefels conversion time in days |
3.0 |
|
real |
DMS oxidation time in days |
10.0 |
|
real |
maximum temperature degC |
0.0 |
|
real |
fraction conversion given high yield |
0.5 |
|
real |
mobility type between stationary and mobile zaero bc1 |
1.0 |
|
real |
mobility type between stationary and mobile zaero bc2 |
1.0 |
|
real |
mobility type between stationary and mobile zaero dust1 |
1.0 |
|
real |
mobility type between stationary and mobile zaero dust2 |
1.0 |
|
real |
mobility type between stationary and mobile zaero dust3 |
1.0 |
|
real |
mobility type between stationary and mobile zaero dust4 |
1.0 |
|
logical |
|
|
3.4.3.12. icefields_nml¶
There are several icefield namelist groups to control model history output. See the source code for a full list of supported output fields.
icefields_nml
is in cicecore/cicedyn/analysis/ice_history_shared.F90icefields_bgc_nml
is in cicecore/cicedyn/analysis/ice_history_bgc.F90icefields_drag_nml
is in cicecore/cicedyn/analysis/ice_history_drag.F90icefields_fsd_nml
is in cicecore/cicedyn/analysis/ice_history_fsd.F90icefields_mechred_nml
is in cicecore/cicedyn/analysis/ice_history_mechred.F90icefields_pond_nml
is in cicecore/cicedyn/analysis/ice_history_pond.F90icefields_snow_nml
is in cicecore/cicedyn/analysis/ice_history_snow.F90
variable |
options/format |
description |
default value |
---|---|---|---|
|
|
write field var every |
|
|
write field var every |
||
|
write field var every |
||
|
do not write var to history |
||
|
write field var every |
||
|
write field var every time step |
||
|
e.g., write both monthly and daily files |
||
|
|
write field cell average var every |
|
|
write field cell average var every |
||
|
write field cell average var every |
||
|
do not write cell average var to history |
||
|
write field cell average var every |
||
|
write field cell average var every time step |
||
|
e.g., write both monthly and daily files |
||