Changes between Version 57 and Version 58 of OMI_observation_modules

Timestamp:

Nov 24, 2024, 4:46:57 PM (3 hours ago)

Author:

lnerger

Comment:

--

OMI_observation_modules

@@ -265 +265 @@
 }}}
 
+Starting with PDAF V2.3.1 one can also use 
+{{{
+   IF (assim_OBSTYPE) CALL PDAFomi_set_doassim(thisobs, 1)
+}}}
+
 === `thisobs%ncoord` ===
 
 This variable specifies the dimension of the distance computations. Thus thisobs%ncoord=2 will lead to distance computations in 2 dimensions.
+
+This variable can either be set directly in the code, or, starting with PDAF V2.3.1 by calling [wiki:PDAFomi_set_ncoord].
 
 
@@ -290 +297 @@
 See `/models/lorenz96/` for an example using case 1 with periodicity in one dimension.
 
+This variable can either be set directly in the code, or, starting with PDAF V2.3.1 by calling [wiki:PDAFomi_set_disttype].
+
 
 === `dim_obs_p` ===
@@ -334 +343 @@
    - The entries are the indices of four elements of the state vector
 
-'''Note:''' This array is only used in the observation operators provided by PDAF-OMI. If you don't use these observation operators, you might not need this array.
-
+'''Notes:''' 
+ * This array is only used in the observation operators provided by PDAF-OMI. If you don't use these observation operators, you might not need this array.
+
+||Starting from PDAF V2.3.1 one can also call [wiki:PDAFomi_set_id_obs_p] to initialize thisobs%id_obs_p. One provides a user-specified array of indices. The routine then allocates thisobs%id_obs_p and fills it with the provided indices. This should be particularly usable when not using Fortran. ||
 
 === `thisobs%domainsize` ===
@@ -347 +358 @@
 Setting one dimension to 0 or a negative value indicates that there is no periodicity in this direction. 
 
+|| '''Note:''' Starting from PDAF V2.3.1 one can also call [wiki:PDAFomi_set_domainsize] to initialize thisobs%domainsize. One provides a user-specified array of domain sizes. The routine then allocates thisobs%domainsize and fills it with the provided values. This should be particularly usable when not using Fortran. ||
+
 
 === `thisobs%icoeff_p` ===
@@ -358 +371 @@
 
 Please see the [wiki:OMI_observation_operators documentation of OMI observation operators] for information on how to initialize the array `thisobs%icoeff_p` using functions provided by PDAF-OMI.
+
+||Starting from PDAF V2.3.1 one can also call [wiki:PDAFomi_set_icoeff_p] to initialize thisobs%icoeff_p. One provides a user-specified array of interpolation coefficients. The routine then allocates thisobs%icoeff_p and fills it with the provided coefficients. This should be particularly usable when not using Fortran. ||
 
 
@@ -366 +381 @@
  - 1: double-exponential (Laplace) errors
 
+This variable can either be set directly in the code, or, starting with PDAF V2.3.1 by calling [wiki:PDAFomi_set_obs_err_type].
+
 
 === `thisobs%use_global_obs` ===
@@ -371 +388 @@
 In the domain-localized filters (LESTK, LETKF, LSEIK, LNETF) observations are assimilated that are located within the localization around some grid point. When a model uses parallelization with domain-decomposition some of these observations might belong to a different process-domain. In the default mode (`thisobs%use_global_obs`=1) PDAF-OMI gathers all globally available observations so that each process has access to all observations. It can be more efficient to limit the observations on a process-domain to those observations that are located inside the domain or within the localization radius around it. Then, in the local analyses less observations have to be checked for their distance. Setting `thisobs%use_global_obs=0` activates this feature. However, it needs additional preparations to make PDAF-OMI aware of the limiting coordinates of a process sub-domain. 
 
+This variable can either be set directly in the code, or, starting with PDAF V2.3.1 by calling [wiki:PDAFomi_set_use_global_obs].
+
 The use of this feature is described in the [wiki:OMI_use_global_obs documentation on using domain-limited observations].
 
+
+
 === `thisobs%inno_omit` ===
 
 Setting this variable to a value > 0.0 activates the functionality that observations are omitted (made irrelevant) from the analysis update if the difference of their value and the ensemble mean to too large. For more information see the [wiki:PDAFomi_additional_functionality#Omittingobservationsthatarepotentialoutliers page on additional OMI functionality].
+
+This variable can either be set directly in the code, or, starting with PDAF V2.3.1 by calling [wiki:PDAFomi_set_inno_omit].
+