Using the SatSim Gridded Component
This page describes how to use the SatSim gridded component, which implements the CFMIP observational simulator package (COSP). This package simulates the cloud observations from the satellite instruments CloudSat, CALIPSO, and PARASOL, and the International Satellite Cloud Climatology Project (ISCCP). The SatSim gridded component is compiled by default into Fortuna 2.3 and later, but the latest version usually requires updating to the latest development tag.
Compile-Time Options
The SatSim gridded component is located in file GEOS_SatsimGridComp.F90 in the following sub-directory of the GEOS-5 build:
src/GEOSgcs_GridComp/GEOSgcm_GridComp/GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSradiation_GridComp/GEOSsatsim_GridComp
The other files in this directory are provided with COSP. Necessary bugfixes and updates have been applied since the Fortuna-2_3_p1 tag you should update the directory by cding to it and entering
cvs upd -r afe_F2_4_satimdev_20110519
before compiling.
At the head of the file GEOS_SatsimGridComp.F90 there are a number of preprocessor options. Leaving these alone will produce acceptable results, but those wishing to tinker should be aware of them.
The first is the directive #define USE_COSP, which is the default. This enables the use of the lidar, radar, ISCCP and MODIS simulators, and the post-simulator processing for COSP data, all of which are called in the cosp subroutine. The selection of these can be trimmed with boolean settings under the comment with "Switches".
If USE_COSP is left undefined, then USE_ICARUS, USE_LIDAR, USE_RADAR, and USE_COSP_STATS are automatically defined, causing the "bare" simulator routines to be used. These #define directives can be commented out individually. At the time of this writing the bare MODIS simulator has not been implemented. The results of all the simulators should be bit-identical to those of COSP: their purpose is to allow the implementation of a subgrid generator other than that of COSP, and to facilitate testing.
Below the #ifndef USE_COSP is another preprocessing directive, #define USE_MAPL_UNDEF. This sets all of the "undefined" values to MAPL_UNDEF from the values used by COSP and the simulator routines, preventing problems in the GEOS-5 post-processing.
Setting Up SatSim
SatSim is turned on by including the following line in the AGCM.rc file at runtime:
USE_SATSIM: 1
To produce output from SatSim you will need to provide data collections in your run's HISTORY.rc file. Samples are provided below. The collections as provided are very storage-intensive due to the many 3D global fields in lidar and radar, and more than fifty 2D fields in isccp.
Sample Collections for HISTORY.rc
The following are sample collections that can be cut and pasted into your HISTORY.rc. Don't forget to add the appropriate lines to the COLLECTIONS: section
'geosgcm_lidar'
'geosgcm_parasol'
'geosgcm_modis'
'geosgcm_radar'
'geosgcm_isccp'
The following are exports from the lidar routine, which simulates data from the CALIPSO and PARASOL satellites. As with all of the collections here, effort has been made to conform to the fields and short names specified in the CFMIP documents. The exports with names beginning respectively with CFADLIDARSR532 and PARASOLREFL and ending with a number are not CFMIP-compliant as they are supposed to be single multidimensional fields. This is due to limitations that GEOS-5 places on the structure of exports. Exports from the Moist gridded component are provided for comparison and diagnostics. The vertical levels are intended to conform to CFMIP specifications -- the levels<\code> entry should be on one line in the HISTORY.rc file.
geosgcm_lidar.template: '%y4%m2%d2_%h2%n2z.nc4',
geosgcm_lidar.archive: '%c/Y%y4',
geosgcm_lidar.format: 'CFIO',
geosgcm_lidar.mode: 'time-averaged',
geosgcm_lidar.frequency: 030000,
geosgcm_lidar.vunit: 'm',
geosgcm_lidar.vvars: 'ZL' , 'DYN' ,
geosgcm_lidar.levels: 240 720 1200 1680 2160 2640 3120 3600 4080 4560 5040 5520 6000 6480 6960 7440 7920 8400 8880 9360 9840 10320 10800 11280
11760 12240 12720 13200 13680 14160 14640 15120 15600 16080 16560 17040 17520 18000 18480 18960
geosgcm_lidar.ref_time: 210000,
geosgcm_lidar.fields: 'LIDARPMOL' , 'SATSIM' ,
'LIDARPTOT' , 'SATSIM' ,
'LIDARTAUTOT' , 'SATSIM' ,
'CLLS' , 'MOIST' ,
'FCLD' , 'MOIST' ,
'CLCALIPSO2' , 'SATSIM' ,
'CLLCALIPSO' , 'SATSIM' ,
'CLMCALIPSO' , 'SATSIM' ,
'CLHCALIPSO' , 'SATSIM' ,
'CLTCALIPSO' , 'SATSIM' ,
'CFADLIDARSR532_01' , 'SATSIM' ,
'CFADLIDARSR532_02' , 'SATSIM' ,
'CFADLIDARSR532_03' , 'SATSIM' ,
'CFADLIDARSR532_04' , 'SATSIM' ,
'CFADLIDARSR532_05' , 'SATSIM' ,
'CFADLIDARSR532_06' , 'SATSIM' ,
'CFADLIDARSR532_07' , 'SATSIM' ,
'CFADLIDARSR532_08' , 'SATSIM' ,
'CFADLIDARSR532_09' , 'SATSIM' ,
'CFADLIDARSR532_10' , 'SATSIM' ,
'CFADLIDARSR532_11' , 'SATSIM' ,
'CFADLIDARSR532_12' , 'SATSIM' ,
'CFADLIDARSR532_13' , 'SATSIM' ,
'CFADLIDARSR532_14' , 'SATSIM' ,
'CFADLIDARSR532_15' , 'SATSIM' ,
::
geosgcm_parasol.template: '%y4%m2%d2_%h2%n2z.nc4',
geosgcm_parasol.archive: '%c/Y%y4',
geosgcm_parasol.format: 'CFIO',
geosgcm_parasol.mode: 'time-averaged',
geosgcm_parasol.frequency: 030000,
geosgcm_parasol.ref_time: 210000,
geosgcm_parasol.fields: 'PARASOLREFL0' , 'SATSIM' ,
'PARASOLREFL1' , 'SATSIM' ,
'PARASOLREFL2' , 'SATSIM' ,
'PARASOLREFL3' , 'SATSIM' ,
'PARASOLREFL4' , 'SATSIM' ,
'PARASOLREFL5' , 'SATSIM' ,
::
The following provides exports from the radar routine which simulates CloudSat data. The numbered export fields with names beginning with CLOUDSATCFAD are not CFMIP-compliant for the same reasons as those in the lidar collection.
geosgcm_radar.template: '%y4%m2%d2_%h2%n2z.nc4',
geosgcm_radar.archive: '%c/Y%y4',
geosgcm_radar.format: 'CFIO',
geosgcm_radar.mode: 'time-averaged',
geosgcm_radar.frequency: 030000,
geosgcm_radar.ref_time: 210000,
geosgcm_radar.vunit: 'm',
geosgcm_radar.vvars: 'ZL' , 'DYN' ,
geosgcm_radar.levels: 240 720 1200 1680 2160 2640 3120 3600 4080 4560 5040 5520 6000 6480 6960 7440 7920 8400 8880 9360 9840 10320 10800 11280
11760 12240 12720 13200 13680 14160 14640 15120 15600 16080 16560 17040 17520 18000 18480 18960
geosgcm_radar.fields: 'RADARLTCC' , 'SATSIM' ,
'RADARZETOT' , 'SATSIM' ,
'CLCALIPSO2' , 'SATSIM' ,
'CLCALIPSO' , 'SATSIM' ,
'CLOUDSATCFAD01' , 'SATSIM' ,
'CLOUDSATCFAD02' , 'SATSIM' ,
'CLOUDSATCFAD03' , 'SATSIM' ,
'CLOUDSATCFAD04' , 'SATSIM' ,
'CLOUDSATCFAD05' , 'SATSIM' ,
'CLOUDSATCFAD06' , 'SATSIM' ,
'CLOUDSATCFAD07' , 'SATSIM' ,
'CLOUDSATCFAD08' , 'SATSIM' ,
'CLOUDSATCFAD09' , 'SATSIM' ,
'CLOUDSATCFAD10' , 'SATSIM' ,
'CLOUDSATCFAD11' , 'SATSIM' ,
'CLOUDSATCFAD12' , 'SATSIM' ,
'CLOUDSATCFAD13' , 'SATSIM' ,
'CLOUDSATCFAD14' , 'SATSIM' ,
'CLOUDSATCFAD15' , 'SATSIM' ,
'CLLS' , 'MOIST' ,
'FCLD' , 'MOIST' ,
'QLLS' , 'MOIST' ,
'QILS' , 'MOIST' ,
'RI' , 'MOIST' , 'RDFI' ,
'RL' , 'MOIST' , 'RDFL' ,
'SGFCLD' , 'SATSIM' ,
::
The following collection provides the fields from the icarus (ISCPP) routine. The CFMIP documents stipulate that ISCCP output be in a 7x7 matrix of 2D fields; these fields are broken out individually here in the exports with names that start with ISCCP. The rest of the names follow the codes outlined in the ISCCP routines for cloud type and then height (for that cloud type, increasing with U/M/O) and optical depth (A/B).
To achive partial compliance with CFMIP data specifications (to be amended in post-processing), the fields are also grouped in seven exports ISCCP1<\code> through ISCCP7<\code>, each with the increasing pressure level bands of the ISCCP data. Each export contains seven fields of increasing optical depth in that pressure band.
geosgcm_isccp.template: '%y4%m2%d2_%h2%n2z.nc4',
geosgcm_isccp.archive: '%c/Y%y4',
geosgcm_isccp.format: 'CFIO',
geosgcm_isccp.mode: 'time-averaged',
geosgcm_isccp.frequency: 030000,
geosgcm_isccp.ref_time: 210000,
geosgcm_isccp.fields: 'SGFCLD' , 'SATSIM' ,
'TCLISCCP' , 'SATSIM' ,
'ALBISCCP' , 'SATSIM' ,
'PCTISCCP' , 'SATSIM' ,
'ISCCP1' , 'SATSIM' ,
'ISCCP2' , 'SATSIM' ,
'ISCCP3' , 'SATSIM' ,
'ISCCP4' , 'SATSIM' ,
'ISCCP5' , 'SATSIM' ,
'ISCCP6' , 'SATSIM' ,
'ISCCP7' , 'SATSIM' ,
'ISCCP_CU_OA' , 'SATSIM' ,
'ISCCP_CU_OB' , 'SATSIM' ,
'ISCCP_CU_UA' , 'SATSIM' ,
'ISCCP_CU_UB' , 'SATSIM' ,
'ISCCP_STCU_OA' , 'SATSIM' ,
'ISCCP_STCU_OB' , 'SATSIM' ,
'ISCCP_STCU_UA' , 'SATSIM' ,
'ISCCP_STCU_UB' , 'SATSIM' ,
'ISCCP_ST_OA' , 'SATSIM' ,
'ISCCP_ST_OB' , 'SATSIM' ,
'ISCCP_ST_UA' , 'SATSIM' ,
'ISCCP_ST_UB' , 'SATSIM' ,
'ISCCP_ACU_OA' , 'SATSIM' ,
'ISCCP_ACU_OB' , 'SATSIM' ,
'ISCCP_ACU_UA' , 'SATSIM' ,
'ISCCP_ACU_UB' , 'SATSIM' ,
'ISCCP_AST_OA' , 'SATSIM' ,
'ISCCP_AST_OB' , 'SATSIM' ,
'ISCCP_AST_UA' , 'SATSIM' ,
'ISCCP_AST_UB' , 'SATSIM' ,
'ISCCP_NST_OA' , 'SATSIM' ,
'ISCCP_NST_OB' , 'SATSIM' ,
'ISCCP_NST_UA' , 'SATSIM' ,
'ISCCP_NST_UB' , 'SATSIM' ,
'ISCCP_CI_OA' , 'SATSIM' ,
'ISCCP_CI_OB' , 'SATSIM' ,
'ISCCP_CI_MA' , 'SATSIM' ,
'ISCCP_CI_MB' , 'SATSIM' ,
'ISCCP_CI_UA' , 'SATSIM' ,
'ISCCP_CI_UB' , 'SATSIM' ,
'ISCCP_CIST_OA' , 'SATSIM' ,
'ISCCP_CIST_OB' , 'SATSIM' ,
'ISCCP_CIST_MA' , 'SATSIM' ,
'ISCCP_CIST_MB' , 'SATSIM' ,
'ISCCP_CIST_UA' , 'SATSIM' ,
'ISCCP_CIST_UB' , 'SATSIM' ,
'ISCCP_CB_OA' , 'SATSIM' ,
'ISCCP_CB_OB' , 'SATSIM' ,
'ISCCP_CB_MA' , 'SATSIM' ,
'ISCCP_CB_MB' , 'SATSIM' ,
'ISCCP_CB_UA' , 'SATSIM' ,
'ISCCP_CB_UB' , 'SATSIM' ,
'ISCCP_SUBV1' , 'SATSIM' ,
'ISCCP_SUBV2' , 'SATSIM' ,
'ISCCP_SUBV3' , 'SATSIM' ,
'ISCCP_SUBV4' , 'SATSIM' ,
'ISCCP_SUBV5' , 'SATSIM' ,
'ISCCP_SUBV6' , 'SATSIM' ,
'ISCCP_SUBV7' , 'SATSIM' ,
'CLLS' , 'MOIST' ,
'FCLD' , 'MOIST' ,
::
Variable List
Export State
Sorted by SHORT variable name
Table 1. List of GEOS-5 Export State variables sorted by SHORT variable name
Name
Component
Units
Dim
Long Name
CALIPSOSRCFAD01
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD02
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD03
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD04
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD05
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD06
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD07
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD08
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD09
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD10
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD11
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD12
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD13
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD14
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CALIPSOSRCFAD15
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLCALIPSO2
Satsim
1
xyz
Calipsonocloudsat cloud fraction
CLCALIPSO
Satsim
1
xyz
Calipso total cloud fraction
CLHCALIPSO
Satsim
1
xy
Calipso high level cloud fraction
CLLCALIPSO
Satsim
1
xy
Calipso low level cloud fraction
CLMCALIPSO
Satsim
1
xy
Calipso mid level cloud fraction
CLOUDSATCFAD01
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD02
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD03
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD04
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD05
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD06
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD07
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD08
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD09
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD10
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD11
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD12
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD13
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD14
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLOUDSATCFAD15
Satsim
1
xyz
Cloudsat radar reflectivity cfad
CLTCALIPSO
Satsim
1
xy
Calipso total cloud fraction
ISCCP_ACU_OA
Satsim
1
xy
Fraction of thin higher altocumulus
ISCCP_ACU_OB
Satsim
1
xy
Fraction of thick higher altocumulus
ISCCP_ACU_UA
Satsim
1
xy
Fraction of thin lower altocumulus
ISCCP_ACU_UB
Satsim
1
xy
Fraction of thick lower altocumulus
ISCCP_AST_OA
Satsim
1
xy
Fraction of thin higher altostratus
ISCCP_AST_OB
Satsim
1
xy
Fraction of thick higher altostratus
ISCCP_AST_UA
Satsim
1
xy
Fraction of thin lower altostratus
ISCCP_AST_UB
Satsim
1
xy
Fraction of thick lower altostratus
ISCCP_CB_MA
Satsim
1
xy
Fraction of thin middle cumulonimbus
ISCCP_CB_MB
Satsim
1
xy
Fraction of thick middle cumulonimbus
ISCCP_CB_OA
Satsim
1
xy
Fraction of thin higher cumulonimbus
ISCCP_CB_OB
Satsim
1
xy
Fraction of thick higher cumulonimbus
ISCCP_CB_UA
Satsim
1
xy
Fraction of thin lower cumulonimbus
ISCCP_CB_UB
Satsim
1
xy
Fraction of thick lower cumulonimbus
ISCCP_CIST_MA
Satsim
1
xy
Fraction of thin middle cirrostratus
ISCCP_CIST_MB
Satsim
1
xy
Fraction of thick middle cirrostratus
ISCCP_CIST_OA
Satsim
1
xy
Fraction of thin higher cirrostratus
ISCCP_CIST_OB
Satsim
1
xy
Fraction of thick higher cirrostratus
ISCCP_CIST_UA
Satsim
1
xy
Fraction of thin lower cirrostratus
ISCCP_CIST_UB
Satsim
1
xy
Fraction of thick lower cirrostratus
ISCCP_CI_MA
Satsim
1
xy
Fraction of thin middle cirrus
ISCCP_CI_MB
Satsim
1
xy
Fraction of thick middle cirrus
ISCCP_CI_OA
Satsim
1
xy
Fraction of thin higher cirrus
ISCCP_CI_OB
Satsim
1
xy
Fraction of thick higher cirrus
ISCCP_CI_UA
Satsim
1
xy
Fraction of thin lower cirrus
ISCCP_CI_UB
Satsim
1
xy
Fraction of thick lower cirrus
ISCCP_CU_OA
Satsim
1
xy
Fraction of thin higher cumulus
ISCCP_CU_OB
Satsim
1
xy
Fraction of thick higher cumulus
ISCCP_CU_UA
Satsim
1
xy
Fraction of thin lower cumulus
ISCCP_CU_UB
Satsim
1
xy
Fraction of thick lower cumulus
ISCCP_NST_OA
Satsim
1
xy
Fraction of thin higher nimbostratus
ISCCP_NST_OB
Satsim
1
xy
Fraction of thick higher nimbostratus
ISCCP_NST_UA
Satsim
1
xy
Fraction of thin lower nimbostratus
ISCCP_NST_UB
Satsim
1
xy
Fraction of thick lower nimbostratus
ISCCP_STCU_OA
Satsim
1
xy
Fraction of thin higher stratocumulus
ISCCP_STCU_OB
Satsim
1
xy
Fraction of thick higher stratocumulus
ISCCP_STCU_UA
Satsim
1
xy
Fraction of thin lower stratocumulus
ISCCP_STCU_UB
Satsim
1
xy
Fraction of thick lower stratocumulus
ISCCP_ST_OA
Satsim
1
xy
Fraction of thin higher stratus
ISCCP_ST_OB
Satsim
1
xy
Fraction of thick higher stratus
ISCCP_ST_UA
Satsim
1
xy
Fraction of thin lower stratus
ISCCP_ST_UB
Satsim
1
xy
Fraction of thick lower stratus
ISCCP_SUBV1
Satsim
1
xy
Fraction of subvisible cloud 0 180 hPa
ISCCP_SUBV2
Satsim
1
xy
Fraction of subvisible cloud 180 310 hPa
ISCCP_SUBV3
Satsim
1
xy
Fraction of subvisible cloud 310 440 hPa
ISCCP_SUBV4
Satsim
1
xy
Fraction of subvisible cloud 440 560 hPa
ISCCP_SUBV5
Satsim
1
xy
Fraction of subvisible cloud 560 680 hPa
ISCCP_SUBV6
Satsim
1
xy
Fraction of subvisible cloud 680 800 hPa
ISCCP_SUBV7
Satsim
1
xy
Fraction of subvisible cloud 800 SFC hPa
LIDARPMOL
Satsim
m-1 sr-1
xyz
Molecular attenuated backscatter lidar signal power
LIDARPTOT
Satsim
m-1 sr-1
xyz
Total attenuated backscatter lidar signal power
LIDARTAUTOT
Satsim
1
xyz
Optical thickess integrated from top to level z
PARASOLREFL1
Satsim
1
xy
Parasol reflectance 1
PARASOLREFL2
Satsim
1
xy
Parasol reflectance 2
PARASOLREFL3
Satsim
1
xy
Parasol reflectance 3
PARASOLREFL4
Satsim
1
xy
Parasol reflectance 4
PARASOLREFL5
Satsim
1
xy
Parasol reflectance 5
RADARLTCC
Satsim
1
xy
Radar and lidar total cloud amount
RADARZETOT
Satsim
1
xyz
Radar output
SGFCLD
Satsim
1
xyz
Summed subgrid cloud fraction from scops
TCLISCCP
Satsim
1
xy
Isccp total cloud area fraction