[Dart-dev] DART/branches Revision: 11827

[dart at ucar.edu]

nancy at ucar.edu
2017-07-18 10:21:32 -0600 (Tue, 18 Jul 2017)
162
updated for kinds -> quantities.   obs_sequence_mod
still has documentation for get_expected_obs() which
should be in the obs_def_mod docs - this is still TODO.




Modified: DART/branches/rma_trunk/assimilation_code/modules/observations/DEFAULT_obs_kind_mod.html
===================================================================
--- DART/branches/rma_trunk/assimilation_code/modules/observations/DEFAULT_obs_kind_mod.html	2017-07-18 16:20:08 UTC (rev 11826)
+++ DART/branches/rma_trunk/assimilation_code/modules/observations/DEFAULT_obs_kind_mod.html	2017-07-18 16:21:32 UTC (rev 11827)
@@ -49,13 +49,14 @@
 <br> 
 To add a new specific observation type, see the
 <a href="../../../observations/forward_operators/obs_def_mod.html">obs_def_mod</a> documentation.
-If adding this type includes defining a new generic observation kind,
-then the kind must be added to the table in this file, with a unique
-integer value defined for it.
+If adding this type includes defining a new generic observation quantity,
+then the quantity must be added to the table in this file, with a unique
+integer value defined for it.  The new value(s) must also be added to the
+string-to-number section in the <em class=code>initialize_module()</em> routine below.
 In a planned future update to the preprocess program it is expected that
-this kinds table will become autogenerated, much like the types table
+this quantities table will become autogenerated, much like the types table
 described below, so no editing of this file will be needed.  But until then,
-kinds must be added by here, by hand. And note that they must be added
+quantities must be added by here, by hand. And note that they must be added
 to the template file, <em class="file">DEFAULT_obs_kind_mod.F90</em> and
 not the output of the preprocess program, 
 <em class="file">obs_kind_mod.f90</em>.  The latter file is overwritten
@@ -83,7 +84,7 @@
 type could change so these integers are for use internal to a given program
 execution only. Observation types are permanently and uniquely identified by
 a string with character values identical to the integer identifier here. In
-other words, an observation kind with integer parameter identifier 
+other words, an observation quantity with integer parameter identifier 
 RAW_STATE_VARIABLE will always be associated with a string 
 "RAW_STATE_VARIABLE" (see below).
 </li>
@@ -92,29 +93,28 @@
 ! DART PREPROCESS OBS_QTY_INFO INSERTED HERE
 </pre>
 The entries for the obs_kind_info table are initialized here. This table has a
-row for each observation kind defined in the public and integer parameter
+row for each observation quantity defined in the public and integer parameter
 declarations discussed above. For each obs_kind, the obs_kind info table
 contains the following information:
 <ol>
 <li>The integer index associated with this
-observation kind. This is the value that is defined in the integer parameter
+observation quantity. This is the value that is defined in the integer parameter
 statement above. 
 </li>
 <li>A character string with maximum length 32 characters
-that uniquely identifies the observation kind. This string is identical to the
+that uniquely identifies the observation quantity. This string is identical to the
 F90 identifier used in the integer parameter statements created above.
 </li>
-<li>A generic variable type referenced by an integer. The
+<li>A generic variable quantity referenced by an integer. The
 obs_kind_mod contains a table that defines an integer parameter that uniquely
-identifies each generic observation kind. Generic kinds can be associated with
-both a model state variable or an observation kind. For instance, the generic
-kind U_WIND_COMPONENT might be associated with model U state variables, with
-RADIOSONDE_U_WIND_COMPONENT observation kinds, and with ACARS_U_WIND_COMPONENT
-observation kinds. The distinction between generic kinds and observation types
-is important and potentially confusing, so be careful to understand this
-point. 
+identifies each generic observation quantity. Generic quantities can be associated with
+both a model state variable or an observation quantity. For instance, the generic
+quantity QTY_U_WIND_COMPONENT might be associated with model U state variables, with
+RADIOSONDE_U_WIND_COMPONENT observation types, and with ACARS_U_WIND_COMPONENT
+observation types. The distinction between generic quantites and observation types
+is important and potentially confusing, so be careful to understand this point. 
 </li>
-<li>A logical variable indicating whether observations of this kind are
+<li>A logical variable indicating whether observations of this type are
 to be assimilated in the current experiment. This variable is set from the
 obs_kind namelist (see obs_kind_mod.html in this directory).  
 The default value here is false when the obs_def_mod is
@@ -121,12 +121,18 @@
 created by the preprocess program.
 </li>
 <li>A logical
-variable indicating whether observations of this kind are to be evaluated
+variable indicating whether observations of this type are to be evaluated
 (forward operator computed and recorded) but not assimilated (again set by
 namelist).
 The default value here is false when the obs_def_mod is
 created by the preprocess program.
 </li>
+<li>A logical
+variable indicating whether observations of this type should use
+precomputed forward operator values in the observation sequence file.
+The default value here is false when the obs_def_mod is
+created by the preprocess program.
+</li>
 </ol>
 </li>
 

Modified: DART/branches/rma_trunk/assimilation_code/modules/observations/obs_kind_mod.html
===================================================================
--- DART/branches/rma_trunk/assimilation_code/modules/observations/obs_kind_mod.html	2017-07-18 16:20:08 UTC (rev 11826)
+++ DART/branches/rma_trunk/assimilation_code/modules/observations/obs_kind_mod.html	2017-07-18 16:21:32 UTC (rev 11827)
@@ -39,17 +39,17 @@
 <H4>Introduction</H4>