The Flux Coupler uses Fortran's namelist input parameter processing capability.
The Coupler reads an input namelist, called inparm, from stdin at runtime.
This section contains a list and description of available namelist input parameters.
Example 1: an initial run
Here the inputs specify an initial run starting on 1 Jan 1980 and stopping on 1 Jul 1980.
The restart pointer file, rest_pfile, will be in the user's home directory.
The restart pointer file will contain the name of the most recently created restart file.
Restart and history files will be sent to the MSS directory "/DOE/csm/test.01/cpl/...".
History data files and restart files will be created according to the default settings
(on the 1st of each month).
Solar orbit calculations will be based on the year 1990.
The Flux Coupler will be communicating with atmosphere, ice, land, and ocean models
that are executing simultaneously.
Example 2: a continuation run
Here the inputs specify a continuation run.
Assuming this run continues from where example 1 finished,
this run will start on 1 Jul 1980 and stop on 1 Jan 1981.
Exactly where this run continues from is specified by the restart pointer file,
which contains the name of the restart file that will be used.
Restart files will be created according to the default settings (on the 1st of each month).
History data will be created every 10 days relative to the 1st day of each month,
i.e. on the 1st, 11th, 21st, and 31st of every month.
Setting diag_freq = "monthly" will signal the coupler to calculate some global diagnostic
information on the 1st of each month and write it to stdout.
New restart and history files will be sent to the MSS directory specified by mss_dir.
Setting info_dbug = 0 will minimize the amount of debugging information written to stdout.
Example 3: a branch run
Here the input parameter rest_type specifies a branch run.
The branch file (/DOE/.../r1981-01-01) must be specified.
This initial condition file was created by a previous simulation.
Since the simulation's starting date (rest_date) is unspecified in the namelist,
the date from the branch file will be used (1 Jan 1981).
The simulation will stop after advancing 31 days (1 Feb 1981).
Restart files will be created every 10 days relative to the start of the run.
Example 4: a regeneration run
Here the inputs specify a regeneration run.
The initial condition file, rest_bfile, must be specified.
The simulation's starting date is taken from this branch file (1 Jul 1980).
The stop options will cause the simulation to stop on a particular date, 1 Aug 1981.
The mass store file retention period and write password have been selected here.
6.1 List of Input Parameters
Flux Coupler input variables follow a naming convention in which the first few letters
of the variable identify a basic functionality group:
The following list of input namelist parameters includes:
Required: no, but highly recommended
Description: This is the case name text string, up to 8 characters,
which is included in output files to help identify the model run.
See Example: 1, 2, 3, 4
Required: no, but highly recommended
Description: This is a short text string, up to 80 characters,
which is included in output files to help identify the model run.
See Example: 1, 2, 3, 4
Required: no (but default is of limited usefulness)
Description: This selects the run type. Valid choices are:
"initial", "continue", "branch", "regenerate." Selecting
"branch" or "regenerate" makes rest_bfile a required input.
See Example: 1, 2, 3, 4
Required: required if rest_type = "branch" or "regeneration",
ignored otherwise
Description: This is the mass store file name of the branch file
(a.k.a. the IC data file).
See Example: 3, 4
Required: yes
Description: This is the complete path and name of the restart pointer file.
This must include an existing, NFS mounted directory.
All run types will update this file (and create it, if necessary),
but only a continuation runs requires that this file exists
prior to the start of the run.
See Example: 1, 2, 3, 4
Required: no (optional for initial and branch runs, ignored otherwise)
Description: This is the restart date (encoded: yyyymmdd).
See Example: 1
Required: no
Description: This is the restart frequency, one of "monthly", "yearly", or "ndays"
which selects how often restart data files are created.
See Example: 3
Required: no (only used if rest_freq = "ndays")
Description: If rest_freq = "ndays", restart files will be created every n days.
More specifically, whenever mod(d-p;n) = 0, where
d = the simulation day (1 Jan, year 1 <=> d = 365)
p = an offset such that mod(d-p;n) = 0 on the date specified by rest_odate
n = rest_n
See Example: 3
Required: no
Description: Selects restart file offset calendar date, used in conjunction with
rest_n when rest_freq = "ndays." If rest_odate > 0, it is a valid calendar date
(encoded: yyyymmdd). Restart data is created every n days relative to (and
including) either
Required: no
Description: Selects when to stop the simulation.
See Example: 1, 2, 3, 4
Required: no (only used when stop_option = "ndays")
Description: If stop_option = "ndays", stop after advancing stop_n days.
See Example: 3
Required: no (required if stop_option = "date", ignored otherwise)
Description: If stop_option = "date", stop on this date.
See Example: 4
Required: no
Description: One of "monthly", "biweekly", "weekly", or "ndays", which selects
how often instantaneous history data is created.
See Example: 2
Required: no (only used if hist_freq = "ndays" or "nstep")
Description: If hist_freq = "ndays" > 0, history files will be created every n
days. More specifically, whenever mod(d-p;n) = 0, where
d = the simulation day (1 Jan, year 1 <=> d = 365 )
n = hist_n
p = an offset such that mod(d-p;n) = 0 on the date specified by hist_odate
If hist_freq = "nstep" > 0, history files will be created every n time steps
including the first time step of each day.
See Example: 2
Required: no (only used if hist_freq = "ndays")
Description: Selects history file offset calendar date, used in conjunction with
hist_n when hist_freq = "ndays". If hist_odate > 1, it is a valid calendar date
(encoded: yyyymmdd). See hist_freq for usage. History data is created every n
days relative to (and including) either
See Example: 2
Required: no
Description: If hist_freq is "daily", "monthly", "quarterly", or "yearly",
instantaneous history data files will contain multiple time samples.
When the next day, month, quarter, or year (respectively) is encountered, the
data file will be archived to the MSS, a new history file will be created,
and subsequent data will be collected into this new file.
A history file's name indicates the date of the first time sample in that file.
Required: no
Description: If hist_tavg is true (non-zero), the Coupler will create monthly
average history data files and component models will be requested to do the same.
Time averaged data is not bundled
(i.e. there is always one set of monthly average fields per file).
Required: no
Description: One of "never", "monthly", "biweekly", "weekly", "ndays",
or "nstep", which selects
how often instantaneous diagnositic data is created.
Required: no (only used if diag_freq = "ndays" or "nstep")
Description: If diag_freq = "ndays",
diagnostic data will be created every n days.
More specifically, whenever mod(d-p;n) = 0, where
d = the simulation day (1 Jan, year 1 <=> d = 365 )
n = diag_n
p = an offset such that mod(d-p;n) = 0 on the date specified by diag_odate
If diag_freq = "nstep", diagnostic data will be created every n time steps
including the first time step of each day.
See Example: 2
Required: no (only used if diag_freq = "ndays")
Description: Selects diagnostic data offset calendar date, used in conjunction with
diag_n when diag_freq = "ndays". If diag_odate > 1, it is a valid calendar date
(encoded: yyyymmdd). See diag_freq for usage. Diagnostic data is created every n
days relative to (and including) either
Required: no
Description:
If true (non-zero), the atm is sent albedo fields which are zenith angle independent.
The default is that the atm is sent albedo fields which are zenith angle dependent.
Typically flx_albav is only turned on when the atm component is
a climatological data atm model that is sending daily average data to the coupler.
Required: no
Description: If true (non-zero), adjust the precipitation field over the
non-land-locked ocean and ice by a spatially constant factor. The default factor
is such that E + P = 0 (globally integrated) over that ocean and ice surface area,
but the ocean model may provide an alternate factor during execution.
Typically flx_epbal is only turned on if the lnd component is not sending
runoff data to the coupler (i.e. it is sending all zero runoff data)
or if the ocean model is ignoring the runoff data it receives from the coupler.
Required: no
Description:
If true (non-zero), the coupler redistributes the atm net solar data amoungst the
surface types. The redistribution is based upon the surface albedos.
Note that while land, ice, or ocean may be underneath an atm grid cell,
the atm only computes one net solar field for that grid cell
(based upon the average surface albedo for that cell).
Thus, if flx_solar = 0, and (e.g.) both ice and ocn lie under one atm grid cell,
the ice and ocn would both get the same absorbed solar radiation in spite of
their widely varying surface albedos.
Required: yes
Description:
This is the calendar year which is used to determine the solar orbit and
resulting solar angles. Valid values are in the range [-1000000, +1000000].
A typical value might be 1990.
See Examples: 1,2,3,4
Required: yes
Description: This is a mass store directory name. Restart and history files go
into this directory. For continuation or regeneration runs, the initial condition
restart file must also be in this directory.
Required: no
Description: Options used when data files are sent to NCAR's Mass Storage
System (MSS) via a mswrite library call. This default request uses asynchronous
data file transfer. See the mswrite man pages at NCAR for more details.
See Example: 4
Required: no
Description: Mswrite password string for files sent to the MSS.
See the mswrite man pages at NCAR for more details.
The mswrite password format is "[read-password][,write-password]".
See Example: 4
Required: no
Description: Retention period, in days, for data files sent to the MSS.
See the mswrite man pages at NCAR for more details.
See Example: 4
6.2 Example Input Namelists
$inparm
case_name = "test.01"
case_desc = "testing an initial run "
rest_type = "initial"
rest_pfile = "$HOME/cpl.test.01.rpointer"
rest_date = 19800101
stop_option = "date"
stop_date = 19800701
orb_year = 1990
mss_dir = "/DOE/csm/test.01/cpl/ "
/
$inparm
case_name = "test.01"
case_desc = "testing a continuation run "
rest_type = "continue"
rest_pfile = "$HOME/cpl.test.01.rpointer"
stop_option = "newyear"
hist_freq = "ndays"
hist_n = 10
hist_odate = 1
diag_freq = "monthly"
orb_year = 1990
mss_dir = "/DOE/csm/test.01/cpl/ "
info_dbug = 0
/
$inparm
case_name = "test.02"
case_desc = "testing a branch run "
rest_type = "branch"
rest_pfile = "$HOME/cpl.test.02.rpointer"
rest_bfile = "/DOE/csm/test.01/cpl/r1981-01-01 "
rest_freq = "ndays"
rest_n = 10
stop_option = "ndays"
stop_n = 31
orb_year = 1990
mss_dir = "/DOE/csm/test.02/cpl/ "
/
$inparm
case_name = "test.01"
case_desc = "regenerate some data "
rest_type = "regeneration"
rest_pfile = "$HOME/cpl.test.01.rpointer"
rest_bfile = "/DOE/csm/test.01/cpl/r1980-07-01 "
stop_option = "date"
stop_date = 19800801
orb_year = 1990
mss_dir = "/DOE/csm/test.01/cpl/ "
mss_rtpd = 30
mss_pass = ",rosebud"
mss_opts = "nowait"
/