Changes between Initial Version and Version 1 of PDAF3_assim_offline_en3dvar_lestkf_nondiagR


Ignore:
Timestamp:
Apr 21, 2025, 1:44:02 PM (7 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_assim_offline_en3dvar_lestkf_nondiagR

    v1 v1  
     1= PDAF3_assim_offline_en3dvar_lestkf_nondiagR =
     2
     3This page documents the routine `PDAF3_assim_offline_en3dvar_lestkf_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. 
     4
     5The routine is used for the offline coupled mode of PDAF, which is described on the page: [wiki:OfflineImplementationGuide Implementation Guide for Offline Coupling].
     6
     7The interface is:
     8{{{
     9SUBROUTINE PDAF3_assim_offline_en3dvar_lestkf_nondiagR(U_init_dim_obs_pdafomi, U_obs_op_pdafomi, prodRinvA_pdafomi, &
     10                                 U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, obs_op_adj_pdafomi, &
     11                                 U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
     12                                 U_prepoststep, outflag)
     13}}}
     14with the following arguments:
     15 * `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.
     16 * `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.
     17 * `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.
     18 * `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.
     19 * `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.
     20 * `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_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.
     22 * `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.
     23 * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains
     24 * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain
     25 * `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
     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. 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.
     28
     29The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_3DEnVar implementing the analysis step of 3D Ensemble Var with OMI].