Changes between Initial Version and Version 1 of PDAFlocalomi_put_state_lknetf_nondiagR


Ignore:
Timestamp:
Sep 9, 2024, 4:09:28 PM (10 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAFlocalomi_put_state_lknetf_nondiagR

    v1 v1  
     1= PDAFlocalomi_put_state_lknetf_nondiagR =
     2
     3This page documents the routine `PDAFlocalomi_put_state_lknetf_nondiagR` of PDAF. The routine is used to execute the analysis step of the local nonlinear ensemble transform filter LKNETF 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 `PDAFlocalomi_put_state_lknetf_nondiagR` contains names for routines that operate on the local analysis domains (marked by the suffix `_l`).
     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 the LKNETF is the following:
     14{{{
     15  SUBROUTINE PDAFomi_put_state_lknetf_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, &
     19                                  U_prodRinvA_l_pdafomi, U_prodRinvA_hyb_l_pdafomi, &
     20                                  U_likelihood_l_pdafomi, U_likelihood_l_pdafomi, &
     21                                  status)
     22}}}
     23with the following arguments:
     24 * `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.
     25 * `U_init_dim_obs_pdafomi`: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector
     26 * `U_obs_op_pdafomi`: The name of the user-supplied routine that acts as the observation operator on some state vector
     27 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     28 * `U_init_n_domains`: The name of the routine that provides the number of local analysis domains
     29 * `U_init_dim_l`: The name of the routine that provides the state dimension for a local analysis domain
     30 * `U_init_dim_obs_l_pdafomi`: The name of the routine that initializes the size of the observation vector for a local analysis domain
     31 * `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.
     32 * `U_prodRinvA_hyb_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 including the hybrid weight.
     33 * `U_likelihood_l_pdafomi`: The name of the user-supplied routine that computes the local likelihood of an ensemble state.
     34 * `U_likelihood_hyb_l_pdafomi`: The name of the user-supplied routine that computes the local likelihood of an ensemble state including the hybrid weight.
     35 * `status`: The integer status flag. It is zero, if this routine is exited without errors.
     36
     37Notes:
     38 * 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.
     39 * The difference to the routine `PDAFlocalomi_put_state` used for diagonal R-matrices is in the additonal arguments `U_likelihood_l_pdafomi`,  `U_likelihood_hyb_l_pdafomi`,  `U_prodRinvA_l_pdafomi`,  `U_prodRinvA_hyb_l_pdafomi`.
     40 * The local filters LESTKF, LETKF, and LSEIK use the separate routine [wiki:PDAFlocalomi_put_state_nondiagR].
     41 * The filter LNETF uses the separate routine [wiki:PDAFlocalomi_put_state_lnetf_nondiagR]
     42
     43The user-supplied call-back routines are described on the page on [ImplementAnalysisLocal implementing the analysis step of the local filters].
     44
     45It is recommended that the value of `status_pdaf` is checked in the program after PDAFomi_assimilate_lknetf_nondiagR is executed. Only if its value is 0 the initialization was successful.
     46
     47PDAF also has a [PdafSimplifiedInterface Simplified Interface] providing the routine `PDAFlocalomi_put_state_lknetf_nondiagR_si`. In the simplified interface, the name of the user-supplied routines have predefined names and do not appear in the call to `PDAFlocalomi_put_state_lknetf_nondiagR_si`.  More information on the pre-defined names is provided in the [ImplementAnalysisLocal page on implementing the analysis step of the local filters].