CAM Namelist Options for COSP

NCAR's CFMIP/COSP contact: Jen Kay (jenkay at ucar dot edu)
website last updated 6-5-2013

CAM namelist variables for COSP available with CESM1_1_1 (first released with CESM1.0.4), default values are in ():
These namelist variables are also documented at CESM1_1_1 CAM namelist options.

cosp_amwg (.true.)
cosp_lite (.false.)
cosp_runall (.false.)
cosp_passive (.false.)
cosp_histfile_num (1) (NOTE: The cam html namelist documentation is wrong. It is says 2, but the default is actually 1.)
cosp_histfile_aux (.false.)
cosp_histfile_aux_num (2)
cosp_nradsteps (1)
cosp_ncolumns (50)
cosp_lmisr_sim (.false.)
cosp_lisccp_sim (.false.)
cosp_lradar_sim (.false.)
cosp_llidar_sim (.false.)
cosp_lmodis_sim (.false.)
cosp_lfrac_out (.false.)
cosp_sample_atrain (.false.) (NOTE: The cam html namelist documentation is wrong. It is says .true. but the default is actually .false. .)
cosp_atrainorbitdata (no default)
cosp_cfmip_3hr (.false.)
cosp_cfmip_da (.false.)
cosp_cfmip_mon (.false.)
cosp_cfmip_off (.false.)

The above CAM-COSP namelist defaults are all set within the interface module (wrapper) for the COSP simulator in CAM: .../models/atm/cam/src/physics/cam/cospsimulator_intr.F90.

Note: docosp=.true. will be added to cam namelist (atm_in) automatically, it does not need to be specified by the user in the namelist.
Note: To turn all COSP simulators off and run CAM even though you compiled with COSP, set docosp=.false. in the CAM namelist.

Jen's description/notes on namelist options:

###################################
cosp_amwg (.true.)
###################################
If true, COSP cloud simulators are run to produce all output required for the COSP plots in the AMWG diagnostics package. sets cosp_ncolumns=10 and cosp_nradsteps=3 (appropriate for COSP statistics derived from seasonal averages), and runs MISR, ISCCP, MODIS, CloudSat radar and CALIPSO lidar simulators (cosp_lmisr_sim=.true.,cosp_lisccp_sim=.true., cosp_lmodis_sim=.true.,cosp_lradar_sim=.true.,cosp_llidar_sim=.true.). This default logical is set in cospsimulator_intr.F90. (n/a in cam5.1, available after cam5_1_16 and in cam5.1.1/cesm1.0.4)

###################################
cosp_lite (.false.)
###################################
If true, the COSP cloud simulators are run to produce select output for the AMWG diagnostics package. sets cosp_ncolumns=10 and cosp_nradsteps=3 (appropriate for COSP statistics derived from seasonal averages), and runs MISR, ISCCP, MODIS, and CALIPSO lidar simulators (cosp_lmisr_sim=.true.,cosp_lisccp_sim=.true., cosp_lmodis_sim=.true.,cosp_llidar_sim=.true.). This default logical is set in cospsimulator_intr.F90. (n/a in cam5.1, available after cam5_1_16 and in cam5.1.1/cesm1.0.4)

###################################
cosp_runall (.false.)
###################################
If true, run all simulators using the default values cosp_ncolumns=50 and cosp_nradsteps=1. This option is mainly intended for testing, but it also must be used in order to output the input fields needed to run the simulator in an offline mode (via setting cosp_histfile_aux=.true.). (n/a in cam5.1, available after cam5_1_16 and in cam5.1.1/cesm1.0.4)

###################################
cosp_passive (.false.)
###################################
If true, the passive COSP cloud simulators are run to produce select output for the AMWG diagnostics package. sets cosp_ncolumns=10 and cosp_nradsteps=3 (appropriate for COSP statistics derived from seasonal averages), and runs MISR, ISCCP, and MODIS simulators (cosp_lmisr_sim=.true.,cosp_lisccp_sim=.true.,cosp_lmodis_sim=.true.). This default logical is set in cospsimulator_intr.F90. (n/a in cam5.1, available after cam5_1_16 and in cam5.1.1/cesm1.0.4)

###################################
cosp_active (.false.)
###################################
If true, the active COSP cloud simulators are run to produce select output for the AMWG diagnostics package. sets cosp_ncolumns=10 and cosp_nradsteps=3 (appropriate for COSP statistics derived from seasonal averages), and runs CloudSat radar and CALIPSO lidar simulators (cosp_lradar_sim=.true.,cosp_llidar_sim=.true.). This default logical is set in cospsimulator_intr.F90. (n/a in cam5.1, available after cam5_1_16 and in cam5.1.1/cesm1.0.4)

###################################
cosp_isccp (.false.)
###################################
If true, the ISCCP cloud simulator is run to produce select output for the AMWG diagnostics package. sets cosp_ncolumns=10 and cosp_nradsteps=3 (appropriate for COSP statistics derived from seasonal averages), and runs ISCCP simulator (cosp_lmisr_sim=.false.,cosp_lisccp_sim=.true., cosp_lmodis_sim=.false.,cosp_lradar_sim=.false.,cosp_llidar_sim=.false.). This default logical is set in cospsimulator_intr.F90. (n/a in cam5.1, available after cam5_1_16 and in cam5.1.1/cesm1.0.4)

###################################
cosp_histfile_num (1)
###################################
The namelist variable sets the cam history tape number for COSP output.
e.g., the default is "1", which means that COSP output will be written to *h0* CAM history files.
If you are writing monthly outputs, COSP output must be written to the *h0* CAM history files. Monthly averaged outputs from CAM are only supported on the *h0* CAM history files.

###################################
cosp_histfile_aux (.false.)
###################################
The namelist variable allows you to save all of the inputs needed to run the COSP simulator. It is intended for debug purposes.
NOTE: This namelist option only works when cosp_runall=.true., i.e., when no specific simulators are set within the namelist
e.g., the default is "false".

###################################
cosp_histfile_aux_num (2)
###################################
The namelist variable allows you to specify the history file where you will save all of the inputs needed to run the COSP simulator.
e.g., the default is "2", which saves the outputs on the *h1*.nc history files

###################################
cosp_nradsteps (1)
###################################
The namelist variable sets the frequency at which is COSP is called.
e.g., the default is "1", which means that COSP is called at every radiation timestep. If set to a number larger than 1, COSP is called at every cops_nradsteps radiation timestep. e.g., if set to 2, COSP would be called every other radiation timestep.
NOTE: If saving instantaneous outputs and calling COSP at a frequency that is less often than every radiation timestep, the CAM history files will be the same size and have no data for the timesteps in which COSP was not called.

###################################
cosp_ncolumns (50)
###################################
I included the number of subcolumns run within COSP as a namelist variable because I thought this might be something that the user would want to change. All other cosp input values are hard-coded to the defaults for CFMIP in cospsimulator_intr.F90.
50 is the recommended value for long averages (e.g., months).
For forecasts, Yuying/Jim had to use a larger number to get convergence between off-line and in-line results - e.g., 250.

###################################
cosp_lmisr_sim (.false.)
cosp_lisccp_sim (.false.)
cosp_lradar_sim (.false.)
cosp_llidar_sim (.false.)
cosp_lmodis_sim (.false.)
###################################
When called by any other method but the cosp_runall flag, the misr/isccp/modis simulators are run on day columns only. For example, setting the following in the namelist would run just the ISCCP simulator on the day columns and save all of the ISCCP output fields:
cosp_lisccp_sim = .true.
When the MODIS simulator is run, the ISCCP simulator is automatically also run.
cosp_lmodis_sim = .true.
By default, the radar/lidar simulators are run on all columns.

###################################
cosp_sample_atrain (.false.)
cosp_atrainorbitdata (no default)
###################################
e.g., if you wanted to run the radar simulator only on a-train columns, you need to specify:
cosp_lradar_sim = .true.
cosp_sample_atrain = .true.
To do the sampling along the atrain orbit (sample_atrain = .true.), an orbit data file must be provided using the namelist variable atrainorbitdata. For example,
cosp_atrainorbitdata = '/project/amp/jenkay/SCAM/repository/cloudsat_orbit_08921_14250.rev0572.nc'
The atrain orbit data file is available from the cfmip COSP website: http://cfmip.metoffice.com/COSP.html
Right now, the code will only run with this specific atrain orbit data file. It is not generalized for all orbits but eventually, it could be made smarter and able to ingest any orbital data file with fractional calendar day, and lat/lon in degrees.
The radar/lidar can also be run alone on atrain columns by setting sample_atrain = .true. So, if you wanted to run the radar simulator on all columns, you would include the following in the namelist:
cosp_lradar_sim = .true.
cosp_sample_atrain = .true.
The namelist variable sample_atrain only affects the radar/lidar simulators. For example, the following would run the radar simulator on all atrain columns and the isccp simulator on only the day columns.
cosp_lradar_sim = .true.
cosp_sample_atrain = .true.
cosp_lisccp_sim = .true.
NOTE: Please do not use the atrain sampling without checking that it is working. I have not done extensive validation.

###################################
cosp_lfrac_out (.false.)
###################################
The option to include sub-column output (cosp_lfrac_out) on the COSP history files is included as a namelist variable. Sub-column calculations aren't turned off and on. When both the isccp/misr/modis simulators and the radar/lidar simulators are run, sub-column output is saved from the isccp/misr/modis simulator columns. Sub-column outputs cannot be averaged, and thus can only be saved as instantaneous outputs. Setting avgflag_pertape = 'A' with cosp_lfrac_out = .true. will cause the model to crash "CHECK_ACCUM" error.

###################################
cosp_cfmip_da (.false.)
cosp_cfmip_mon (.false.) 
cosp_cfmip_3hr (.false.)
cosp_cfmip_off (.false.)
###################################
cosp_cfmip_* are namelist variables to only run simulators to accommodate the cfmip requested outputs. Setting these namelist variables also only puts cfmip-requested variables on specific history files by default. In other words, the namelist variable cosp_histfile_num is ignored. These are specific settings for a specific project, and likely are not of interest beyond CFMIP.
More details below for the various cfmip requested output.
1) cosp_cfmip_da.
CMOR Table cfDa: CFMIP Daily-Mean Cloud Diagnostic Fields (cfmip_da)
In CMOR Table cfDa: CFMIP daily 2D -- daily mean 2-D fields including inline ISCCP/CloudSat/CALIPSO/ PARASOL simulator output
Note: These should not be run along the a-train orbit. I set sample_atrain = .false.
COSP OUTPUT will be in *h1* files.
I added the following fields to a default CAM history file using add_default('XXX',2,' ').
Note: These are the same fields as cfmip_mon.
albisccp
clcalipso
clhcalipso
clisccp
cllcalipso
clmcalipso
cltcalipso
cltisccp
ctpisccp
parasolRefl
In CAM namelist, set:
cosp_cfmip_da = .true.
nhtfrq(2)=-24
2) cosp_cfmip_mon.
CMOR Table cfMon: CFMIP Monthly-Mean Cloud Diagnostic Fields (cfmip_mon)
In CMOR Table cfMon: CFMIP monthly inline, monthly mean inline ISCCP and CALIPSO/PARASOL simulator output
Note: These should not be run along the a-train orbit. I set sample_atrain = .false.
COSP OUTPUT will be in *h0* files.
I added the following fields to a default CAM history file using add_default('XXX',1,' ').
Why not a separate history file? Only the primary history file may be monthly averaged.
Note: These are the same fields as cfmip_da.
In CAM namelist, set:
cosp_cfmip_mon = .true.
3) cosp_cfmip_3hr
CMOR Table cf3hr: CFMIP 3-Hourly Cloud Diagnostic Fields (cfmip_3hr)
In CMOR Table cf3hr: CFMIP 3-hourly orbital offline -- CloudSat/CALIPSO/PARASOL simulator output in orbital curtain format
CFMIP requests us to extract simulator input variables from CAM along A-train orbits, and run COSP on these in 'offline' mode. We did not do this.
The CAM namelist variables run the COSP simulator and save the output for comparison with the off-line calculations.
COSP OUTPUT will be in *h2* files.
I added the following fields to a default CAM history file using add_default('XXX',3,' ')
Note: These are the same fields as cfmip_off.
clcalipso
clcalipso2
cfadDbze94
cfadLidarsr532
parasolRefl
cltcalipso
cllcalipso
clmcalipso
clhcalipso
In CAM namelist, set:
cosp_cfmip_3hr = .true.
nhtfrq(3)=-3
4) cosp_Cfmip_off
CMOR Table cfOff: CFMIP monthly offline Cloud Diagnostic Fields (cfmip_off) CMOR Table cfOff: CFMIP monthly offline -- monthly mean CloudSat/CALIPSO/PARASOL simulator output
CFMIP requests us to Calculate monthly means by averaging the orbital curtain output from CFMIP_orbital_offline. The difference between similar variables appearing in this and the previous table is in the spatial sampling and time period requested. The previous table builds monthly means from global fields, whereas this table below uses only data along the satellite track for a short period of time (one year). This will enable studies of the impact of the satellite sampling in the comparisons.
The CAM namelist variables run the COSP simulator and save the output for comparison with the off-line calculations.
COSP OUTPUT will be in *h1* files.
I added the following fields to a default CAM history file using add_default('XXX',1,' ').
Note: These are the same fields as cfmip_3hr.
In CAM namelist, set:
cosp_cfmip_off = .true.
Note: For the cf3hr and cfOff CFMIP experiments, only year 2008 is requested.