Changes between Initial Version and Version 1 of PDAFomi_gather_obs

Timestamp:

Dec 18, 2021, 12:23:28 PM (2 years ago)

Author:

lnerger

Comment:

--

PDAFomi_gather_obs

@@ +1 @@
+= PDAFomi_gather_obs =
+
+This page documents the routine `PDAFomi_gather_obs of PDAF-OMI.
+
+The routine ha to be called in `init_dim_obs_OBTYPE` in each observation module. It initializes the observation information for PDAF-OMI.
+
+|| See the [wiki:OMI_observation_modules page describing PDAF-OMI observation modules] for the full documentation of the modules.||
+
+The interface is:
+{{{
+  SUBROUTINE PDAFomi_gather_obs(thisobs, dim_obs_p, obs_p, ivar_obs_p, ocoord_p, &
+       ncoord, lradius, dim_obs)
+
+    TYPE(obs_f), INTENT(inout) :: thisobs   ! Data type with full observation information
+    INTEGER, INTENT(in) :: dim_obs_p        ! Number of process-local observations
+    REAL, INTENT(in) :: obs_p(:)            ! Vector of process-local observations
+    REAL, INTENT(in) :: ivar_obs_p(:)       ! Vector of process-local inverse observation error variance
+    REAL, INTENT(in) :: ocoord_p(:,:)       ! Array of process-local observation coordinates
+    INTEGER, INTENT(in) :: ncoord           ! Number of rows (first index) of coordinate array
+    REAL, INTENT(in) :: lradius             ! Typical localization radius (the maximum radius used in this process domain) 
+    INTEGER, INTENT(out) :: dim_obs         ! Full number of observations
+
+}}}
+
+'''Notes:'''
+* The only direect output is `dim_obs`, which is then returned to `init_dim_obs_pdafomi` in `callback_obs_pdafomi.F90`.
+* The value of `lradius` can be some maximum value. It is only utilized if domain-limited observations are activated ([wiki:OMI_use_global_obs see page on using the option `use_global_obs`])