3.4. Case Settings¶
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.
3.4.1. Table of CICE Settings¶
The cice.settings file is reasonably well self documented. Several of the variables defined in the file are not used in CICE. They exist to support the CICE model.
variable |
options/format |
description |
recommended 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_COMPILER |
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 |
cice |
ICE_IOTYPE |
string |
I/O format |
set by cice.setup |
netcdf |
serial netCDF |
||
pio |
parallel netCDF |
||
none |
netCDF library is not available |
||
ICE_CLEANBUILD |
true, false |
automatically clean before building |
true |
ICE_QUIETMODE |
true, false |
reduce build output to the screen |
false |
ICE_GRID |
string (see below) |
grid |
set by cice.setup |
gx3 |
3-deg displace-pole (Greenland) global grid |
||
gx1 |
1-deg displace-pole (Greenland) global grid |
||
tx1 |
1-deg tripole global grid |
||
gbox80 |
80x80 box |
||
gbox128 |
128x128 box |
||
ICE_NTASKS |
integer |
number of tasks, must be set to 1 |
set by cice.setup |
ICE_NTHRDS |
integer |
number of threads per task, must be set to 1 |
set by cice.setup |
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_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 -td |
set by cice.setup |
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 |
0 |
15 minutes (default) |
||
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_BLDDEBUG |
true, false |
turn on compile debug flags |
false |
3.4.2. Table of namelist options¶
also in Icepack |
variable |
options/format |
description |
recommended value |
---|---|---|---|---|
setup_nml |
||||
Time, Diagnostics |
||||
* |
|
|
number of days in a model year |
365 |
* |
|
true/false |
if true, include leap days |
|
* |
|
yyyy |
the initial year, if not using restart |
|
* |
|
integer |
initial time step number |
0 |
* |
|
seconds |
thermodynamics time step length |
|
* |
|
integer |
total number of time steps to take |
|
* |
|
integer |
number of dynamics/advection/ridging/steps per thermo timestep |
1 |
Initialization/Restarting |
||||
|
|
start from |
||
|
restart using |
|||
* |
|
|
latitude and sst dependent |
default |
|
no ice |
|||
path/file |
restart file name |
|||
|
true/false |
initialize using restart file |
|
|
|
true/false |
set initial date using restart file |
|
|
|
nc |
read/write restart files (use with PIO) |
||
bin |
read/write binary restart files |
|||
|
true/false |
if true, use 64-bit format |
||
|
integer |
minimum internal IO unit number |
11 |
|
|
integer |
maximum internal IO unit number |
99 |
|
* |
|
path/ |
path to restart directory |
|
|
true/false |
read/write halo cells in restart files |
||
|
filename prefix |
output file for restart dump |
‘iced’ |
|
|
pointer filename |
contains restart filename |
||
* |
|
|
write restart every |
y |
|
write restart every |
|||
|
write restart every |
|||
|
write restart every |
|||
|
write restart every |
|||
|
integer |
frequency restart data is written |
1 |
|
* |
|
true/false |
if true, write restart on last time step of simulation |
|
Model Output |
||||
|
off/lsum4/lsum8/lsum16/ddpdd/reprosum |
global sum methods |
off |
|
* |
|
integer |
frequency of diagnostic output in |
24 |
e.g., 10 |
once every 10 time steps |
|||
* |
|
|
write diagnostic output to stdout |
|
|
write diagnostic output to file |
|||
|
filename |
diagnostic output file (script may reset) |
||
|
true/false |
print diagnostic data, global sums |
|
|
|
true/false |
print diagnostic data for two grid points |
|
|
|
real |
latitude of (2) diagnostic points |
||
|
real |
longitude of (2) diagnostic points |
||
|
true/false |
if true, write extra diagnostics |
|
|
|
string array |
defines output frequencies |
||
|
write history every |
|||
|
write history every |
|||
|
write history every |
|||
|
write history every |
|||
|
write history every |
|||
|
unused frequency stream (not written) |
|||
|
integer array |
frequency history output is written |
||
0 |
do not write to history |
|||
|
true |
write time-averaged data |
|
|
false |
write snapshots of data |
|||
|
path/ |
path to history output directory |
||
|
filename prefix |
output file for history |
‘iceh’ |
|
|
true/false |
write initial condition |
||
|
path/ |
path to initial condition directory |
||
|
filename prefix |
output file for initial condition |
‘iceh’ |
|
|
string |
label for run (currently CESM only) |
||
grid_nml |
||||
Grid |
||||
|
|
read grid and kmt files |
‘bin’ |
|
|
read direct access, binary file |
|||
|
|
defined in rectgrid |
||
|
read from file in popgrid |
|||
|
read from file in popgrid |
|||
|
read from file in popgrid |
|||
|
filename |
name of grid file to be read |
‘grid’ |
|
|
filename |
name of bathymetry file to be read |
‘grid’ |
|
|
true/false |
use read in bathymetry file for basalstress option |
||
|
filename |
name of land mask file to be read |
‘kmt’ |
|
|
filename |
input file for coupling grid info |
||
* |
|
|
original category boundary formula |
0 |
|
new formula with round numbers |
|||
|
WMO standard categories |
|||
|
one category |
|||
|
real |
x-direction grid spacing (cm) for rectangular grid |
||
|
real |
y-direction grid spacing (cm) for rectangular grid |
||
|
integer |
number of ice thickness categories |
5 |
|
|
integer |
number of floe size categories |
12 for prognostic FSD; 1 otherwise |
|
|
integer |
number of vertical layers in ice |
7 |
|
|
integer |
number of vertical layers in snow |
1 |
|
|
integer |
number of zbgc layers |
7 |
|
domain_nml |
||||
Domain |
||||
|
integer |
number of processors to use |
||
|
integer |
global grid size in x direction |
||
|
integer |
global grid size in y direction |
||
|
integer |
block size in x direction |
||
|
integer |
block size in y direction |
||
|
integer |
maximum number of blocks per MPI task for memory allocation |
||
|
|
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 |
|||
|
|
distribute blocks in 2D Cartesian array |
||
|
1 block per proc until blocks are used |
|||
|
blocks distributed to domain quadrants |
|||
|
several blocks per proc until used |
|||
|
redistribute blocks among neighbors |
|||
|
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 size sets |
||
|
latitude/ocean sets |
|||
|
filename |
distribution weight file when distribution_type is |
||
|
|
periodic boundary conditions in x-direction |
||
|
Dirichlet boundary conditions in x |
|||
|
|
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 |
|||
|
true/false |
mask unused halo cells for dynamics |
||
|
true/false |
mask unused halo cells for transport |
||
|
true/false |
mask unused halo cells for boundary updates |
||
tracer_nml |
||||
Tracers |
||||
|
integer |
number of aerosol tracers |
1 |
|
|
0,1,2,3,4,5,6 |
number of z aerosol tracers in use |
0 |
|
|
0,1,2,3 |
number of algal tracers |
0 |
|
|
0,1,2,3 |
number of dissolved organic carbon |
0 |
|
|
0,1 |
number of dissolved inorganic 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 |
|
* |
|
true/false |
ice age |
|
|
true/false |
restart tracer values from file |
||
* |
|
true/false |
first-year ice area |
|
|
true/false |
restart tracer values from file |
||
* |
|
true/false |
level ice area and volume |
|
|
true/false |
restart tracer values from file |
||
* |
|
true/false |
CESM melt ponds |
|
|
true/false |
restart tracer values from file |
||
* |
|
true/false |
topo melt ponds |
|
|
true/false |
restart tracer values from file |
||
* |
|
true/false |
level-ice melt ponds |
|
|
true/false |
restart tracer values from file |
||
* |
|
true/false |
aerosols |
|
|
true/false |
restart tracer values from file |
||
* |
|
true/false |
floe size distribution |
|
|
true/false |
restart floe size distribution values from file |
||
thermo_nml |
||||
Thermodynamics |
||||
* |
|
|
delta function ITD approximation |
1 |
|
linear remapping ITD approximation |
|||
* |
|
|
zero-layer thermodynamic model |
|
|
Bitz and Lipscomb thermodynamic model |
|||
|
mushy-layer thermodynamic model |
|||
|
thermodynamics disabled |
|||
* |
|
|
conductivity [32] |
|
|
conductivity [37] |
|||
* |
|
real |
brine channel diameter |
0.5x10 \(^{-3}\) m |
* |
|
real |
critical Rayleigh number |
10 |
* |
|
real |
brine convection aspect ratio |
1 |
* |
|
real |
drainage strength parameter |
-1.5x10 \(^{-7}\) m/s/K |
* |
|
\(0<\phi_c < 1\) |
critical liquid fraction |
0.05 |
* |
|
\(0<\phi_i < 1\) |
solid fraction at lower boundary |
0.85 |
dynamics_nml |
||||
Dynamics |
||||
|
|
dynamics OFF |
1 |
|
|
dynamics OFF |
|||
|
EVP dynamics |
|||
|
EAP dynamics |
|||
|
dynamics ON |
|||
|
true/false |
use revised EVP formulation |
||
|
integer |
number of EVP subcycles |
240 |
|
|
|
linear remapping advection |
‘remap’ |
|
|
donor cell advection |
|||
* |
|
|
ice strength formulation [11] |
1 |
|
ice strength formulation [42] |
|||
* |
|
|
old ridging participation function |
1 |
|
new ridging participation function |
|||
* |
|
|
old ridging redistribution function |
1 |
|
new ridging redistribution function |
|||
* |
|
real |
e-folding scale of ridged ice |
|
* |
|
real |
ratio of ridging work to PE change in ridging |
|
|
|
Coriolis variable by latitude |
‘latitude’ |
|
|
Constant coriolis value = 1.46e-4 |
|||
|
Zero coriolis |
|||
|
|
Ridging Enabled |
1 |
|
|
Ridging Disabled |
|||
|
|
Transport Enabled |
1 |
|
|
Transport Disabled |
|||
|
true/false |
use basal stress parameterization for landfast ice |
||
|
real |
1st free parameter for landfast parameterization |
||
|
real |
EVP ellipse aspect ratio |
2.0 |
|
|
real |
Tensile strength factor (see [2]) |
0.0 |
|
shortwave_nml |
||||
Shortwave |
||||
* |
|
|
NCAR CCSM3 distribution method |
|
|
Delta-Eddington method |
|||
* |
|
|
NCAR CCSM3 albedos |
‘default’ |
|
four constant albedos |
|||
* |
|
\(0<\alpha <1\) |
visible ice albedo for thicker ice |
|
* |
|
\(0<\alpha <1\) |
near infrared ice albedo for thicker ice |
|
* |
|
\(0<\alpha <1\) |
visible, cold snow albedo |
|
* |
|
\(0<\alpha <1\) |
near infrared, cold snow albedo |
|
* |
|
real |
albedo is constant above this thickness |
0.3 m |
* |
|
real |
tuning parameter for sea ice albedo from Delta-Eddington shortwave |
|
* |
|
real |
… for ponded sea ice albedo … |
|
* |
|
real |
… for snow (broadband albedo) … |
|
* |
|
real |
\(\Delta\) temperature per \(\Delta\) snow grain radius |
|
* |
|
real |
maximum melting snow grain radius |
|
* |
|
real |
absorption coefficient for algae |
|
ponds_nml |
||||
Melt Ponds |
||||
* |
|
real |
critical ice lid thickness for topo ponds |
0.01 m |
* |
|
real |
snow depth of transition to bare sea ice |
0.03 m |
* |
|
real |
snow depth of transition to pond ice |
0.03 m |
* |
|
real |
time scale for flushing in permeable ice |
\(1\times 10^{-3}\) |
* |
|
|
Stefan refreezing with pond ice thickness |
‘hlid’ |
|
CESM refreezing empirical formula |
|||
* |
|
\(0 \le r_{min} \le 1\) |
minimum melt water added to ponds |
0.15 |
* |
|
\(0 \le r_{max} \le 1\) |
maximum melt water added to ponds |
1.0 |
* |
|
real |
aspect ratio of pond changes (depth:area) |
0.8 |
forcing_nml |
||||
Forcing |
||||
* |
|
true/false |
calculate form drag |
|
* |
|
|
stability-based boundary layer |
‘default’ |
|
bulk transfer coefficients |
|||
* |
|
yyyy |
first year of atmospheric forcing data |
|
* |
|
integer |
number of years in forcing data cycle |
|
* |
|
true |
calculate wind stress and speed |
|
false |
read wind stress and speed from files |
|||
* |
|
true/false |
high-frequency atmo coupling |
|
* |
|
integer |
number of atmo boundary layer iterations |
|
* |
|
true/false |
calculate surface temperature |
|
* |
|
|
Sets initial values of forcing and is overwritten if forcing is read in. |
|
* |
|
|
liquid precipitation data units |
|
|
||||
|
(same as MKS units) |
|||
|
||||
* |
|
|
constant ocean freezing temperature (\(-1.8^{\circ} C\)) |
|
|
linear function of salinity (ktherm=1) |
|||
|
matches mushy-layer thermo (ktherm=2) |
|||
* |
|
real |
minimum value of ocean friction velocity |
0.0005 m/s |
* |
|
real |
emissivity of snow and ice |
0.95 |
* |
|
|
constant ocean heat transfer coefficient |
|
|
variable ocean heat transfer coefficient |
|||
* |
|
true |
include frazil water/salt fluxes in ocn fluxes |
|
false |
do not include (when coupling with POP) |
|||
* |
|
true |
retain (topo) pond water until ponds drain |
|
false |
release (topo) pond water immediately to ocean |
|||
* |
|
true/false |
active ocean mixed layer calculation |
|
* |
|
|
no wave data provided, no wave-ice interactions |
|
|
constant wave spectrum, for testing |
|||
|
wave spectrum generated using random number |
|||
|
wave spectrum read from |
|||
* |
|
true/false |
restore sst to data |
|
* |
|
integer |
sst restoring time scale (days) |
|
|
true/false |
restore ice state along lateral boundaries |
||
|
25 |
number of frequencies in ocean surface wave spectral forcing |
||
* |
|
|
constant values defined in the code |
|
|
COREII Large-Yeager (AOMIP) forcing data |
|||
|
JRA55 forcing data [49] |
|||
|
monthly forcing data |
|||
|
NCAR bulk forcing data |
|||
|
forcing data for [16] box problem |
|||
|
column forcing data |
|||
|
HYCOM atm forcing data in netcdf format |
|||
* |
|
|
constant values defined in the code |
|
|
climatological data |
|||
|
POP ocean forcing data |
|||
|
HYCOM ocean forcing data in netcdf format |
Constant initial forcing |
||
|
|
constant values defined in the code |
||
|
climatological data |
|||
|
POP ocean forcing data |
|||
|
HYCOM ocean forcing data in netcdf format |
Constant initial forcing |
||
|
|
default forcing value for iron |
||
|
iron forcing from ocean climatology |
|||
|
string |
ice initialization for special tests |
|
|
|
no special initialization |
|||
|
||||
|
initialize ice concentration and velocity for boxslotcyl test ([55]) |
|||
|
|
read atmo forcing files |
||
|
read direct access, binary files |
|||
|
|
read ocean forcing files |
||
|
read direct access, binary files |
|||
* |
|
filename |
data file containing ocean forcing data |
|
* |
|
filename |
data file containing wave spectrum forcing data |
|
|
path/ |
path to atmospheric forcing data directory |
||
|
path/ |
path to oceanic forcing data directory |
||
|
path/ |
path to oceanic forcing data directory |
||
zbgc_nml |
||||
Biogeochemistry |
More information about the BGC tuning can be found in the Icepack Documentation. |
|||
* |
|
true/false |
brine height tracer |
|
* |
|
true/false |
vertical aerosol tracers |
|
* |
|
true/false |
modal aersols |
|
|
true/false |
restore bgc to data |
||
|
true/false |
update salinity tracer profile |
||
* |
|
true/false |
biogeochemistry |
|
|
|
ice–ocean flux velocity of [22] |
||
|
constant ice–ocean flux velocity |
|||
|
true/false |
restart tracer values from file |
||
|
true/false |
algal carbon tracer |
||
|
true/false |
algal chlorophyll tracer |
||
|
true/false |
ammonium tracer |
||
|
true/false |
silicate tracer |
||
|
true/false |
particulate DMSP tracer |
||
|
true/false |
dissolved DMSP tracer |
||
|
true/false |
DMS tracer |
||
|
real |
snow porosity for brine height tracer |
||
icefields_nml |
||||
History Fields |
||||
|
string |
frequency units for writing |
||
|
write history every |
|||
|
write history every |
|||
|
write history every |
|||
|
write history every |
|||
|
write history every time step |
|||
|
do not write |
|||
|
e.g., write both monthly and daily files |
|||
|
grid cell average of |