Merge remote-tracking branch 'origin/release-v4.6.1'
[WRF.git] / doc / README.irr_diag
blobca9de1a60a0aa7f78b5293ad78640181d29779d1
2 What is IRR?
3 ============
5 Starting with WRF version 4.0 users may output Integrated Reaction Rate diagnostics
6 for the MOZART_KPP, or MOZART_MOSAIC_4BIN_KPP, or MOZART_MOSAIC_4BIN_AQ_KPP chemical
7 schemes.
9 Integrated Reaction Rate diagnostics are the time integrated value of specified
10 gas phase reaction rates in one of the above listed chemical schemes.  As an example
11 suppose that we have the following chemical reaction in the MOZCART chemical scheme:
13         k
14 OH + O3 = HO2
16 where k is the reaction rate constant.  
18 To better understand chemical kinetics one often needs to know the value of the expression k * OH * O3
20 where OH, HO2 are the concentrations of gas phase compounds OH, HO2.
22 The IRR, Integrated Reaction Rate, enhancement to WRF allows a user to output the time
23 integrated value of k * A * B at regular time intervals in units of ppmv, parts per million
24 volumetric mixing ratio.
26 How do I use IRR?
27 =================
29 First, remember that the IRR diagnostics can only be used for chemistry simulations
30 for the MOZART_KPP, or MOZART_MOSAIC_4BIN_KPP, or MOZART_MOSAIC_4BIN_AQ_KPP chemical
31 schemes. This means your executable must be compiled with the following environment
32 variable settings:
34 setenv WRF_CHEM 1            ( shell = csh, tcsh )
35 setenv WRF_KPP  1
37 export WRF_CHEM=1            ( shell = sh,bash,ksh )
38 export WRF_KPP =1
40 IRR code is in no way included in non-chemistry WRF executables.
42 To produce IRR diagnostics one needs:
44 (1)   the chem namelist group variable irr_opt must be set to 1 on a per simulation
45       domain basis; the default value is 0 which produces no IRR diagnostics
47 (2)   per simulation domain a simple ascii file named wrfchem_irr_diag_d<domain> must exist
49 For example, suppose you want have a two domain WRF simulation and you want to IRR
50 diagnostics for the first domain but none for second domain.  You would need to have
51 the following chem namelist group in the namelist.input file:
53 &chem
56 irr_opt = 1, 0,
59 /      
61 Additionally, if you wanted output for the reaction listed above you would need
62 to create a file wrfchem_irr_diag_d01 that at the least contained the following line
64 OH+O3
66 The wrfchem_irr_diag_d<domain> files are ascii files with one reaction per line.
67 If there are two reactions with the same reactants, differing products,  then
68 the second reaction is referenced by appending an _a to the reaction.  Thus if
69 there were a second reaction, OH + O3 = H + O2 + O2, then this reaction would
70 be added with the line:
72 OH+O3_a
74 in the wrfchem_irr_diag_d<domain> file.
76 Finally you can include all gas phase reactions in the IRR output by simply
77 including the line:
79 all
81 in the wrfchem_irr_diag_d<domain> file.  The entry "all" may be any mix of lower,upper case.
83 *** The wrfchem_irr_diag_d<domain> files must be in the simulation run directory. ***
85 Now you are almost ready to start using the IRR diagnostics.
87 The IRR diagnostics are bound to the auxhist9 output stream.  As such you need to include
88 the following time_control group namelist variable settings for a two domain simulation:
90 auxhist9_outname  = "IRR_DIAG_d<domain>_<date>"
91 auxhist9_interval = 60, 60
92 frames_per_auxhist9 = 1, 1
93 io_form_auxhist9    = 2
95 You may change the prefix "IRR_DIAG" in the auxhist9_outname to your own preferences.
96 Similarly the auxhist9_interval, frames_per_auxhist9, and io_form_auxhist9 settings
97 may be altered.  The above setting will produce IRR output files with the names
98 IRR_DIAG_d01_<date> and IRR_DIAG_d02_<date> with one time point per file.  The output
99 files will be produced every 60 simulation minutes and each output file will be netcdf
100 conforming.
102 Remember - quick check list
103 ===========================
105 (1) - set the chem group namelist variable irr_opt to 1 to enable IRR output on a per domain basis
106       (irr_opt defaults to 0 => IRR disabled)
107 (2) - have a wrfchem_irr_diag_d<domain> file in the run directory on a per domain basis
108 (3) - set the time_control group namelist variables related to auxhist9