Changes between Initial Version and Version 1 of PDAF3_assimilate_hyb3dvar_estkf_nondiagR


Ignore:
Timestamp:
Mar 28, 2025, 2:59:37 PM (5 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_assimilate_hyb3dvar_estkf_nondiagR

    v1 v1  
     1= PDAF3_assimilate_hyb3dvar_estkf =
     2
     3This page documents the routine `PDAFomi_assimilate_hyb3dvar_estkf` of PDAF which is used in case of a non-diagonal observation error covariance matrix.  The routine is part of the advanced PDAF3 interface that was introduced with PDAF V3.0.
     4
     5The routine is typically called in `assimilate_pdaf` or directly in the model code.
     6
     7The general aspects of the filter specific routines `PDAFomi_assimilate_*` are described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] and its sub-page on [InsertAnalysisStep inserting the analysis step]. The routine is used in the fully-parallel implementation variant of the data assimilation system. When the 'flexible' implementation variant, the routines `PDAFomi_put_state_*' are used. 
     8
     9
     10The interface is:
     11{{{
     12SUBROUTINE PDAF3_assimilate_hyb3dvar_estkf_nondiagR(U_collect_state, U_distribute_state, &
     13                                 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, U_prodRinvA_pdafomi, &
     14                                 U_cvt_ens, U_cvt_adj_ens, U_cvt, U_cvt_adj, &
     15                                 U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, &
     16                                 U_prepoststep, U_next_observation, outflag)
     17}}}
     18with the following arguments:
     19 * `U_collect_state`: [[BR]]The name of the user-supplied routine that initializes a state vector from the array holding the ensemble of model states from the model fields. This is basically the inverse operation to `U_distribute_state` used in [ModifyModelforEnsembleIntegration#PDAF_get_state PDAF_get_state] and also here.
     20 * `U_distribute_state`:  [[BR]]The name of a user supplied routine that initializes the model fields from the array holding the ensemble of model state vectors.
     21 * `U_init_dim_obs_pdafomi`: [[BR]]The name of the user-supplied routine that initializes the observation information and provides the size of observation vector. This routine is part of an OMI observation module.
     22 * `U_obs_op_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the observation operator on some state vector. This routine is part of an OMI observation module.
     23 * `U_prodRinvA_pdafomi`: [[BR]]The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF.
     24 * `U_cvt_ens`: [[BR]]The name of the user-supplied routine that applies the ensemble control-vector transformation (square-root of the B-matrix) on some control vector to obtain a state vector.
     25 * `U_cvt_adj_ens`: [[BR]]The name of the user-supplied routine that applies the adjoint ensemble control-vector transformation (with square-root of the B-matrix) on some state vector to obtain the control vector.
     26 * `U_cvt`: [[BR]]The name of the user-supplied routine that applies the control-vector transformation (square-root of the B-matrix) on some control vector to obtain a state vector.
     27 * `U_cvt_adj`: [[BR]]The name of the user-supplied routine that applies the adjoint control-vector transformation (with square-root of the B-matrix) on some state vector to obtain the control vector.
     28 * `U_obs_op_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the observation operator on some state vector.  This routine is part of an OMI observation module.
     29 * `U_obs_op_lin_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the linearized observation operator on some state vector.  This routine is part of an OMI observation module.
     30 * `U_obs_op_adj_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the adjoint observation operator on some state vector. This routine is part of an OMI observation module.
     31 * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
     32 * `U_next_observation`: [[BR]]The name of the user-supplied routine that initializes the variables `nsteps`, `timenow`, and `doexit`. The same routine is also used in `PDAF_get_state`.
     33 * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors. It is recommended that the value of `status_pdaf` is checked in the program after the routine is executed. Only if its value is 0 the initialization was successful.
     34
     35**Note:**
     36 * The difference to the routine `PDAF3_assimilate_hyb3dvar_lestkf` used for diagonal R-matrices is only in the additional argument `U_prodRinvA_pdafomi`.
     37
     38The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_Hyb3DVar implementing the analysis step of hybrid 3D-Var with OMI].
     39