Changes between Version 15 and Version 16 of OMI_Callback_obs_pdafomi

Timestamp:

Nov 24, 2020, 11:05:29 AM (3 years ago)

Author:

lnerger

Comment:

--

OMI_Callback_obs_pdafomi

@@ -11 +11 @@
 In the descriptions below we use 'TYPE' as a generic label for an observation type. When implemeting an observation type, one replace this by an actual name. For example for sea surface temperature (sst) observations, one could replace TYPE by 'sst' and write e.g. `init_dim_obs_sst`.
 
+
 == init_dim_obs_pdafomi ==
 
-The routine is called at the beginning of each analysis step.  For PDAF, it has to initialize the size `dim_obs_p` of the observation vector according to the current time step. Apart from this routine will initialize overall observation information.
+The routine is called at the beginning of each analysis step.  For PDAF, it has to initialize the size `dim_obs_p` of the observation vector according to the current time step. Apart from this routine will initialize overall observation information.  In this routine one just calls `init_dim_obs_TYPE` for each observation type.
 
 The '''interface''' for this routine is:
@@ -66 +67 @@
 == obs_op_pdafomi ==
 
-In this routine one just calls `obs_op_TYPE` for each observation type.
+The routine is called during the analysis step. It has to perform the operation of the observation operator acting on a state vector that is provided as `state_p`. The observed state has to be returned in `m_state_p`. In this routine one just calls `obs_op_TYPE` for each observation type.
+
+The '''interface''' for this routine is:
+{{{
+SUBROUTINE obs_op_pdafomi(step, dim_p, dim_obs_p, state_p, m_state_p)
+
+  INTEGER, INTENT(in) :: step               ! Currrent time step
+  INTEGER, INTENT(in) :: dim_p              ! PE-local dimension of state
+  INTEGER, INTENT(in) :: dim_obs_p          ! Dimension of observed state
+  REAL, INTENT(in)    :: state_p(dim_p)     ! PE-local model state
+  REAL, INTENT(out) :: m_state_p(dim_obs_p) ! PE-local observed state
+}}}
 
 The '''implementation steps''' are: