[Dart-dev] DART/branches Revision: 11599

[dart at ucar.edu]

nancy at ucar.edu
2017-05-04 09:10:51 -0600 (Thu, 04 May 2017)
114
update the nml and html for assim_tools.
bring particle filter version of assim_tools
in sync with base version.




Modified: DART/branches/rma_trunk/assimilation_code/modules/assimilation/assim_tools_mod.html
===================================================================
--- DART/branches/rma_trunk/assimilation_code/modules/assimilation/assim_tools_mod.html	2017-05-03 23:01:54 UTC (rev 11598)
+++ DART/branches/rma_trunk/assimilation_code/modules/assimilation/assim_tools_mod.html	2017-05-04 15:10:51 UTC (rev 11599)
@@ -292,11 +292,12 @@
 &assim_tools_nml
    filter_kind                     = 1,
    cutoff                          = 0.2,
+   distribute_mean                 = .false.
    sort_obs_inc                    = .false.,
    spread_restoration              = .false.,
    sampling_error_correction       = .false.,
    adaptive_localization_threshold = -1,
-   adaptive_cutoff_floor           = -1.0,
+   adaptive_cutoff_floor           = 0.0,
    output_localization_diagnostics = .false.,
    localization_diagnostics_file   = "localization_diagnostics",
    print_every_nth_obs             = 0,
@@ -304,6 +305,8 @@
    gaussian_likelihood_tails       = .false.,
    close_obs_caching               = .true.,
    allow_missing_in_clm            = .false.
+   adjust_obs_impact               = .false.
+   obs_impact_filename             = ""
    special_localization_obs_types  = "",
    special_localization_cutoffs    = -1,
 /
@@ -326,13 +329,23 @@
  <TD> integer </TD>
  <TD> Selects the variant of filter to be used.
 <UL>
- <LI>1 = EAKF</LI>
- <LI>2 = ENKF,
+ <LI>1 = EAKF (Ensemble Adjustment Kalman Filter)</LI>
+ <LI>2 = ENKF (ENsemble Kalman Filter),
  <LI>3 = Kernel filter</LI> 
- <LI>4 = particle filter</LI>  
- <LI>7 = Boxcar kernel filter</LI>
+ <LI>4 = Observation Space Particle filter</LI>  
+ <LI>7 = Boxcar Kernel filter</LI>
  <LI>8 = Rank Histogram Filter</LI>
+ <LI>9 = New Particle Filter (see details below)</LI>
 </UL>
+
+The EAKF is the most commonly used filter. 
+The Rank Histgram filter can be more successful for highly nongaussian
+distributsion. 
+
+Jon Poterjoy's Particle filter is included with this code release.
+To use it rename assimilation_code/modules/assimilation/assim_tools_mod.pf.f90 to
+assim_tools_mod.f90 and rebuild filter.  There are additional namelist items in
+this version specific to the particle filter.  Read the code for more details.
  </TD> </TR>
 
 <TR>
@@ -346,6 +359,20 @@
  </TD> </TR>
 
 <TR>
+ <TD> distribute_mean </TD>
+ <TD> logical </TD>
+ <TD> If your model uses coordinates that have no options for
+different vertical coordinates then this setting has no effect
+on speed and should be .true. to use less memory.  If your model
+has code to convert between different coordinate systems, for
+example Pressure, Height, Model Levels, etc, then setting this
+.false. will generally run much faster at assimilation time
+but will require more memory per MPI task.  If you run out of
+memory, setting this to .true. may allow you to run but take
+longer.
+ </TD> </TR>
+
+<TR>
  <TD> sort_obs_inc </TD>
  <TD> logical </TD>
  <TD> If true, the final increments from obs_increment are sorted
@@ -425,36 +452,27 @@
 
 
 <TR>
- <TD> special_localization_obs_types </TD>
- <TD> character(len=32), dimension(:) </TD>
- <TD> Optional list of observation types (e.g. "RADAR_REFLECTIVITY",
-"RADIOSONDE_TEMPERATURE") which will use a different cutoff
-value other than the default specified by the 'cutoff' namelist.
-This is only implemented for the 'threed_sphere' locations module.
+ <TD> print_every_nth_obs </TD>
+ <TD> integer </TD>
+ <TD> If set to a value <em class=code>N</em> greater than 0,
+the observation assimilation loop prints out a progress message
+every <em class=code>N</em>th observations.  This can be useful to
+estimate the expected run time for a large observation file,
+or to verify progress is being made in cases with suspected problems.
  </TD> </TR>
 
 
 <TR>
- <TD> special_localization_cutoffs </TD>
- <TD> real(r8), dimension(:) </TD>
- <TD> Optional list of real values which must be the same
-length and in the same order as the observation types list