Changes between Initial Version and Version 1 of PDAF3_put_state_enkf_nondiagR


Ignore:
Timestamp:
Mar 27, 2025, 2:14:33 PM (6 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_put_state_enkf_nondiagR

    v1 v1  
     1= PDAF3_put_state_enkf_nondiagR =
     2
     3This page documents the routine `PDAF3_put_state_enkf_nondiagR` of PDAF. The routine is part of the advanced [wiki:PDAF3_interface PDAF3 interface] that was introduced with PDAF V3.0.
     4
     5The routine is used to execute the analysis step of the EnKF and LEnKF of a non-diagonal observation error covariance matrix.
     6
     7The routine is typically called in `assimilate_pdaf` or directly in the model code.
     8
     9The general aspects of the filter specific routines `PDAF3_put_state_*` 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].
     10
     11The routine is used for the offline mode of PDAF. It can also be used in the 'flexible' parallelization implementation variant of the data assimilation system, but starting with PDAF-3 we recommend to use [wiki:PDAF3_assimilate_local PDAF3_assimilate_local], which is also used with the 'fully-parallel' implementation variant.
     12
     13The interface is:
     14{{{
     15  SUBROUTINE PDAF3_put_state_enkf_nondiagR(U_collect_state, &
     16                                 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
     17                                 U_add_obs_err_pdafomi, U_init_obscovar_pdafomi, &
     18                                 U_prepoststep, status)
     19}}}
     20with the following arguments:
     21 * `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 `PDAF_get_state` as well as here.
     22 * `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.
     23 * `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.
     24 * `U_add_obs_err_pdafomi`: [[BR]]The name of the user-supplied routine that adds the observation error covariance matrix to the ensemble covariance matrix projected onto the observation space.
     25 * `U_init_obscovar_pdafomi`: [[BR]]The name of the user-supplied routine that initializes the observation error covariance matrix.
     26 * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
     27 * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors.
     28
     29Notes:
     30 * The difference to the routine `PDAF3_put_state_global` used for diagdonal R-matrices is only in the additonal arguments `U_add_obs_err_pdafomi` and `U_init_obscovar_pdafomi`.
     31 * The global filters ESTKF, ETKF, and SEIK use the separate routine [wiki:PDAF3_put_state_global_nondiagR].
     32 * The global filters NETF and PF use the separate routine [wiki:PDAF3_put_state_nonlin_nondiagR].
     33 * It is recommended that the value of `status_pdaf` is checked in the program after PDAFomi_put_state_enkf_nondiagR is executed. Only if its value is 0 the initialization was successful.
     34
     35The user-supplied call-back routines are described on the page on [ImplementAnalysisGlobal implementing the analysis step of the global filters].
     36