Changes between Version 2 and Version 3 of PDAF3_assimilate_en3dvar_lestkf_nondiagR


Ignore:
Timestamp:
Mar 28, 2025, 12:23:07 PM (4 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_assimilate_en3dvar_lestkf_nondiagR

    v2 v3  
    1 = PDAF3_assimilate_en3dvar_estkf_nondiagR =
     1= PDAF3_assimilate_en3dvar_lestkf_nondiagR =
    22
    3 This page documents the routine `PDAF3_assimilate_en3dvar_estkf_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_en3dvar_lestkf_nondiagR`. The routine is part of the advanced PDAF3 interface that was introduced with PDAF V3.0.
    44
    55The routine is typically called in `assimilate_pdaf` or directly in the model code.
    … …  
    77The 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.
    88
     9
    910The interface is:
    1011{{{
    11 SUBROUTINE PDAF3_assimilate_en3dvar_nondiagR_estkf(U_collect_state, U_distribute_state, &
    12                                  U_init_dim_obs_pdafomi, U_obs_op_pdafomi, U_prodRinvA_pdafomi, &
    13                                  U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, &
     12SUBROUTINE 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, obs_op_adj_pdafomi, &
     15                                 U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
    1416                                 U_prepoststep, U_next_observation, outflag)
    1517}}}
    … …  
    1820 * `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.
    1921 * `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_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.
    2023 * `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.
    21  * `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.
    2224 * `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.
    2325 * `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.
    2426 * `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.
    2527 * `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.
    26  * `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.
     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.
     29 * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains
     30 * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain
     31 * `U_init_dim_obs_l_pdafomi`: [[BR]]The name of the user-supplied routine that initializes the size of the observation vector for a local analysis domain
    2732 * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
    2833 * `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`.
    2934 * `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.
    3035
    31 **Note:**
    32  * The difference to the routine `PDAF3_assimilate_en3dvar_estkf` used for diagonal R-matrices is only in the additonal argument `U_prodRinvA_pdafomi`.
    33 
    3436The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_3DEnVar implementing the analysis step of 3D Ensemble Var with OMI].
    35 
    36 
    37