Changes between Initial Version and Version 1 of PDAFomi_gather_obsstate

Timestamp:

Dec 18, 2021, 1:02:58 PM (4 years ago)

Author:

lnerger

Comment:

--

PDAFomi_gather_obsstate

@@ +1 @@
+= PDAFomi_gather_obsstate =
+
+This page documents the routine `PDAFomi_gather_obsstate` of PDAF-OMI.
+
+The routine has to be inside an observation operator for PDAF-OMI. It initializes observation information for PDAF-OMI.
+
+Calling this routine is relevant if the user implements a new observation operator for PDAF-OMI. The observation operators provided the PDAF-OMI already include the call to `PDAFomi_gather_obsstate`. 
+
+|| See the [wiki:OMI_observation_operators page on OMI observation operators] for information about implementing a custom observation operator.||
+
+The interface is:
+{{{
+  SUBROUTINE PDAFomi_gather_obsstate(thisobs, obsstate_p, obsstate_f)
+
+    TYPE(obs_f), INTENT(inout) :: thisobs  ! Data type with full observation
+    REAL, INTENT(in) :: obsstate_p(:)      ! Vector of process-local observed state
+    REAL, INTENT(inout) :: obsstate_f(:)   ! Full observed vector for all types
+}}}
+
+'''Notes:'''
+ * `thisobs` is the observation data type initialized by `init_dim_obs_OBSTYPE`