Changes between Initial Version and Version 1 of PDAFomi_put_state_local_nondiagR


Ignore:
Timestamp:
Sep 8, 2024, 4:36:42 PM (11 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAFomi_put_state_local_nondiagR

    v1 v1  
     1= PDAFomi_put_state_local_nondiagR =
     2
     3This page documents the routine `PDAFomi_put_state_local_nondiagR` of PDAF. The routine is used to execute the analysis step of the local ensemble filters LESTKF, LETKF and LSEIK with PDAF-OMI for the case of a non-diagonal observation error covariance matrix. This routine was introduced with PDAF V2.3.
     4
     5The routine is typically called in `assimilate_pdaf` or directly in the model code.
     6
     7The routines `PDAF_put_state_*` are used with the 'flexible' implementation variant of PDAF.
     8The general aspects of the filter specific routines `PDAF_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]. For the 'fully parallel' implementation variant the alternative routines `PDAF_assimilate_*` are used.
     9
     10The interface for the routine `PDAFomi_put_state_local_nondiagR` contains names for routines that operate on the local analysis domains (marked by the suffix `_l`). Further there are routines that convert between a local and a global model state vector (`U_g2l_state` and `U_l2g_state`).
     11Here, we list the full interface of the routine. Subsequently, the user-supplied routines specified in the call is explained.
     12
     13The interface when using one of the local filters is the following:
     14{{{
     15  SUBROUTINE PDAFomi_put_state_local_nondiagR(U_collect_state, &
     16                                  U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
     17                                  U_prepoststep, U_init_n_domains, U_init_dim_l, &
     18                                  U_init_dim_obs_l_pdafomi, U_prodRinvA_l_pdafomi, &
     19                                  U_g2l_state, U_l2g_state, status)
     20}}}
     21with the following arguments:
     22 * `U_collect_state`: 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.
     23 * `U_init_dim_obs_pdafomi`: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector
     24 * `U_obs_op_pdafomi`: The name of the user-supplied routine that acts as the observation operator on some state vector
     25 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     26 * `U_init_n_domains`: The name of the routine that provides the number of local analysis domains
     27 * `U_init_dim_l`: The name of the routine that provides the state dimension for a local analysis domain
     28 * `U_init_dim_obs_l_pdafomi`: The name of the routine that initializes the size of the observation vector for a local analysis domain
     29 * `U_prodRinvA_l_pdafomi`: 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.
     30 * `U_g2l_state`: The name of the routine that initializes a local state vector from the global state vector
     31 * `U_l2g_state`: The name of the routine that initializes the corresponding part of the global state vector from the provided local state vector
     32 * `status`: The integer status flag. It is zero, if this routine is exited without errors.
     33
     34Notes:
     35 * The order of the routine names does not show the order in which these routines are executed. See the [ImplementAnalysisLocal#Executionorderofuser-suppliedroutines section on the order of the execution] on the page on implementing the analysis step of the local filter algorithms.
     36 * The difference to the routine `PDAFomi_put_state_local` used for diagdonal R-matrices is only in the additonal argument `U_prodRinvA_l_pdafomi`.
     37 * The filter LNETF uses the separate routine [wiki:PDAFomi_put_state_lnetf_nondiagR PDAFomi_put_state_lnetf_nondiagR].
     38 * The filter LKNETF uses the separate routine [wiki:PDAFomi_put_state_lknetf_nondiagR PDAFomi_put_state_lknetf_nondiagR]
     39
     40The user-supplied call-back routines are described on the page on [ImplementAnalysisLocal implementing the analysis step of the local filters].
     41
     42It is recommended that the value of `status_pdaf` is checked in the program after this routine is executed. Only if its value is 0 the initialization was successful.
     43
     44PDAF also has a [PdafSimplifiedInterface Simplified Interface] providing the routine `PDAFomi_put_state_local_nondiagR_si`. In the simplified interface, the name of the user-supplied routines have predefined names and do not appear in the call to `PDAFomi_put_state_local_nondiagR_si`.  More information on the pre-defined names is provided in the [ImplementAnalysisLocal page on implementing the analysis step of the local filters].
     45