Changes between Initial Version and Version 1 of PDAF3_put_state_3dvar_all


Ignore:
Timestamp:
Mar 30, 2025, 11:32:50 AM (3 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_put_state_3dvar_all

    v1 v1  
     1= PDAF3_put_state_3dvar_all =
     2
     3This page documents the routine `PDAF3_put_state_3dvar_all`. The routine is part of the advanced PDAF3 interface that was introduced with PDAF V3.0.
     4
     5|| This routine is universal and allows to run the analysis step of all 3D-Var methods in PDAF (parameterized 3D-Var, ensemble 3D-Var with LESTKF or ESTKF, hybrid 3D-Var with LESTKF or ESTKF). ||
     6
     7The routine is typically called in `assimilate_pdaf` or directly in the model code.
     8
     9The 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].
     10
     11The 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_hyb3dvar_lestkf], which is also used with the 'fully-parallel' implementation variant.
     12
     13The interface is:
     14{{{
     15SUBROUTINE PDAF3_put_state_3dvar_all(U_collect_state, &
     16                                 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
     17                                 U_cvt_ens, U_cvt_adj_ens, U_cvt, U_cvt_adj, &
     18                                 U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, &
     19                                 U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
     20                                 U_prepoststep, outflag)
     21}}}
     22with the following arguments:
     23 * `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.
     24 * `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.
     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_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.
     27 * `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.
     28 * `U_cvt`: [[BR]]The name of the user-supplied routine that applies the control-vector transformation (square-root of the B-matrix) on some control vector to obtain a state vector.
     29 * `U_cvt_adj`: [[BR]]The name of the user-supplied routine that applies the adjoint control-vector transformation (with square-root of the B-matrix) on some state vector to obtain the control vector.
     30 * `U_obs_op_pdafomi`: 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.
     31 * `U_obs_op_lin_pdafomi`: 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.
     32 * `U_obs_op_adj_pdafomi]: 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.
     33 * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains
     34 * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain
     35 * `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
     36 * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
     37 * `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.
     38
     39
     40The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_Hyb3DVar implementing the analysis step of hybrid 3D-Var with OMI].