Changes between Version 20 and Version 21 of OMI_Callback_obs_pdafomi

Timestamp:

Dec 9, 2021, 3:41:34 PM (3 years ago)

Author:

lnerger

Comment:

--

OMI_Callback_obs_pdafomi

@@ -121 +121 @@
 
 '''Notes:'''
- - The arguments in the calls to `obs_op_TYPE` are input argumnets to `obs_op_pdafomi`. They are just passed on.
+ - The arguments in the calls to `obs_op_TYPE` are input arguments to `obs_op_pdafomi`. They are just passed on.
  - The order of the calls to `obs_op_TYPE` is not relevant because the setup of the overall full observation vector is defined by the order of the calls in init_dim_obs_pdafomi. Anyway, it's good practice to keep the order of the calls consistent.
  - We don't need an IF-statement with `assim_TYPE` here. The check is done within each obs-module.
@@ -187 +187 @@
  - The order of the calls to `obs_op_TYPE` is not relevant because the setup of the overall full observation vector is defined by the order of the calls in init_dim_obs_pdafomi. Anyway, it's good practice to keep the order of the calls consistent.
 
+
+
+== obs_op_lin_pdafomi ==
+
+The routine is called during the analysis step of the 3D-Var methods and it is only required in this case (3D-Var methods have been added with PDAF V2.0). It has to perform the operation of the linearized 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_lin_TYPE` for each observation type. 
+
+The '''interface''' for this routine is:
+{{{
+SUBROUTINE obs_op_lin_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 the same as for `obs_op_pdafomi`.
+
+An '''example''' is provided in `tutorial/variational/online_2D_serialmodel/`.
+
+'''Notes:'''
+ - The arguments in the calls to `obs_op_lin_TYPE` are input arguments to `obs_op_pdafomi`. They are just passed on.
+ - The order of the calls to `obs_op_TYPE` is not relevant because the setup of the overall full observation vector is defined by the order of the calls in init_dim_obs_pdafomi. Anyway, it's good practice to keep the order of the calls consistent.
+ - We don't need an IF-statement with `assim_TYPE` here. The check is done within each obs-module.
+ - If the full observation operator for the observation type is linear by itself, one can just call `obs_op_TYPE`. Thus, no additional routine inside the observation module is required in this case.
+
+
+== obs_op_lin_pdafomi ==
+
+The routine is called during the analysis step of the 3D-Var methods and it is only required in this case (3D-Var methods have been added with PDAF V2.0). It has to perform the operation of the adjoint observation operator acting on an observation vector that is provided as `m_state_p`. The resulting state vector has to be returned in `state_p`. In this routine one just calls `obs_op_adj_TYPE` for each observation type. 
+
+The '''interface''' for this routine is:
+{{{
+SUBROUTINE obs_op_adj_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)    :: m_state_p(dim_obs_p) ! PE-local full observed state
+  REAL, INTENT(inout) :: state_p(dim_p)     ! PE-local model state
+}}}
+
+
+The '''implementation steps''' are the same as for `obs_op_pdafomi`.
+
+An '''example''' is provided in `tutorial/variational/online_2D_serialmodel/`.
+
+'''Notes:'''
+ - The arguments in the calls to `obs_op_adj_TYPE` are input arguments to `obs_op_adj_pdafomi`. They are just passed on.
+ - The order of the calls to `obs_op_adj_TYPE` is not relevant because the setup of the overall full observation vector is defined by the order of the calls in init_dim_obs_pdafomi. Anyway, it's good practice to keep the order of the calls consistent.
+ - We don't need an IF-statement with `assim_TYPE` here. The check is done within each obs-module.
+
+
+
+
+
 == deallocate_obs_pdafomi == 
 
 The file callback_obs_pdafomi.F90 also contains a routine deallocate_obs_pdafomi. Each obs-module allocates arrays in the observation type `obs_f` and `deallocate_obs_pdafomi` is used to deallocate the different observation-specific arrays after the analysis step. 
+
+[[span(style=color: #FF0000, '''Warning:''' Calling `deallocate_obs_pdafomi` is only required in PDAF V1.16. It is obsolete in PDAF V2.0 and later)]]
 
 The '''implementation steps''' are: