Changes between Initial Version and Version 1 of PDAF3_put_state_en3dvar_estkf_nondiagR


Ignore:
Timestamp:
Mar 28, 2025, 12:20:31 PM (6 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_put_state_en3dvar_estkf_nondiagR

    v1 v1  
     1= PDAF3_put_state_en3dvar_estkf_nondiagR =
     2
     3This page documents the routine `PDAF3_put_state_en3dvar_estkf_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 typically called in `assimilate_pdaf` or directly in the model code.
     6
     7The 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].
     8
     9The 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_en3dvar_estkf_nondiagR], which is also used with the 'fully-parallel' implementation variant.
     10
     11The interface is:
     12{{{
     13SUBROUTINE PDAF3_put_state_en3dvar_nondiagR_estkf(U_collect_state, &
     14                                 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, U_prodRinvA_pdafomi, &
     15                                 U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, &
     16                                 U_prepoststep, outflag)
     17}}}
     18with the following arguments:
     19 * `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 [ModifyModelforEnsembleIntegration#PDAF_get_state PDAF_get_state] and also here.
     20 * `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.
     21 * `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.
     22 * `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.
     23 * `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.
     24 * `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.
     25 * `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.
     26 * `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.
     27 * `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.
     28 * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
     29 * `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.
     30
     31**Note:**
     32 * The difference to the routine `PDAF3_assimilate_en3dvar_estkf` used for diagonal R-matrices is only in the additonal argument `U_prodRinvA_pdafomi`.
     33
     34The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_3DEnVar implementing the analysis step of 3D Ensemble Var with OMI].
     35
     36
     37