Changes between Version 2 and Version 3 of PDAF3_assimilate_hyb3dvar_lestkf_nondiagR


Ignore:
Timestamp:
Mar 28, 2025, 2:52:52 PM (4 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_assimilate_hyb3dvar_lestkf_nondiagR

    v2 v3  
    1 = PDAF3_assimilate_en3dvar_lestkf_nondiagR =
     1= PDAF3_assimilate_hyb3dvar_lestkf_nondiagR =
    22
    3 This page documents the routine `PDAF3_assimilate_en3dvar_lestkf_nondiagR` which is used for the 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.
     3This page documents the routine `PDAF3_assimilate_hyb3dvar_lestkf_nondiagR` of PDAF which is used in case of a non-diagonal observation error covariance matrix. This routine was introduced with PDAF V2.3.
    44
    55The routine is typically called in `assimilate_pdaf` or directly in the model code.
    66
    7 The general aspects of the filter specific routines `PDAF3_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 both the fully-parallel and the flexible parallelization variant of the data assimilation system.
     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.
    88
    99
    1010The interface is:
    1111{{{
    12 SUBROUTINE PDAF3_assimilate_en3dvar_lestkf_nondiagR(U_collect_state, U_distribute_state, &
    13                                  U_init_dim_obs_pdafomi, U_obs_op_pdafomi, prodRinvA_pdafomi, &
    14                                  U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, &
    15                                  U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, U_prodRinvA_l_pdafomi, &
    16                                  U_prepoststep, U_next_observation, outflag)
     12SUBROUTINE PDAF3_assimilate_hyb3dvar_lestkf_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_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi,
     17                                 U_prodRinvA_l_pdafomi, U_prepoststep,  &
     18                                 U_next_observation, outflag)
    1719}}}
    1820with the following arguments:
    … …  
    2426 * `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.
    2527 * `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.
     28 * `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.
     29 * `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.
    2630 * `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.
    2731 * `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.
    28  * `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.
     32 * `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.
    2933 * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains
    3034 * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain
    … …  
    3640
    3741**Note:**
    38  * The difference to the routine `PDAF3_assimilate_en3dvar_lestkf` used for diagonal R-matrices is only in the additional arguments `U_prodRinvA_pdafomi` and `U_prodRinvA_l_pdafomi`.
     42 * The difference to the routine `PDAF3_assimilate_hyb3dvar_lestkf` used for diagonal R-matrices is only in the additional arguments `U_prodRinvA_pdafomi` and `U_prodRinvA_l_pdafomi`.
    3943
    4044The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_3DEnVar implementing the analysis step of 3D Ensemble Var with OMI].