Changes between Initial Version and Version 1 of PDAF3_assim_offline_lenkf


Ignore:
Timestamp:
Apr 21, 2025, 12:49:01 PM (7 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_assim_offline_lenkf

    v1 v1  
     1= PDAF3_assim_offline_lenkf =
     2
     3This page documents the routine `PDAF3_assim_offline_lenkf` of PDAF. The routine is part of the advanced PDAF3 interface that was introduced with PDAF V3.0.
     4
     5|| **Note:** This routine exists for backward-compatibility for the LEnKF with PDAF V2.3, in particular for existing implementations using `localize_covar_pdafomi`. We recommend to use the new PDAF3 interface using [wiki:PDAF3_put_state_global] that avoids the need to implement the additional call-back routine `localize_covar_pdafomi`. ||
     6
     7The routine is used for the offline coupled mode of PDAF, which is described on the page: [wiki:OfflineImplementationGuide Implementation Guide for Offline Coupling].
     8
     9The interface is:
     10{{{
     11  SUBROUTINE PDAF3_assim_offline_lenkf(U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
     12                                 U_localize_covar_pdafomi, U_prepoststep, &
     13                                 status)
     14}}}
     15
     16with the following arguments:
     17 * `U_init_dim_obs_pdafomi`: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector
     18 * `U_obs_op_pdafomi`: The name of the user-supplied routine that acts as the observation operator on some state vector
     19 * `U_localize_covar_pdafomi`: The name of the user-supplied routine that Applies covariance localization to the matrices HP and HPH^T^
     20 * `U_prepoststep`: The name of the user-supplied pre/poststep routine as in `PDAF_get_state` (Note that the place of `U_prepoststep` has changed compared to the previous routine `PDAFomi_assimilate_lenkf`)
     21 * `status`: The integer status flag. It is zero, if the routine is exited without errors.
     22
     23
     24For the EnKF, the user-supplied routines are essentially executed in the order they are listed in the interface to PDAFomi_put_state_lenkf.
     25
     26The user-supplied call-back routines are described on the page on [ImplementAnalysislenkf implementing the analysis step of the local EnKF].
     27
     28It is recommended that the value of `status_pdaf` is checked in the program after PDAFomi_put_state_lenkf is executed. Only if its value is 0 the initialization was successful.