| | 1 | = PDAFlocalomi_put_state_hyb3dvar_lestkf = |
| | 2 | |
| | 3 | This page documents the routine `PDAFlocalomi_put_state_hyb3dvar_lestkf` of PDAF. |
| | 4 | |
| | 5 | The routine is typically called in `assimilate_pdaf` or directly in the model code. |
| | 6 | |
| | 7 | The routines `PDAFomi_put_state_*` are used with the 'flexible' implementation variant of PDAF. |
| | 8 | The general aspects of the filter specific routines `PDAFomi_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 | |
| | 10 | |
| | 11 | The interface is: |
| | 12 | {{{ |
| | 13 | SUBROUTINE PDAFlocalomi_put_state_hyb3dvar_lestkf(U_collect_state, & |
| | 14 | U_init_dim_obs_pdafomi, U_obs_op_pdafomi, & |
| | 15 | U_cvt_ens, U_cvt_adj_ens, U_cvt, U_cvt_adj, & |
| | 16 | U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, & |
| | 17 | U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, & |
| | 18 | U_prepoststep, outflag) |
| | 19 | }}} |
| | 20 | with the following arguments: |
| | 21 | * [#U_collect_statecollect_state_pdaf.F90 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 `PDAF_get_state` as well as here. |
| | 22 | * [#U_init_dim_obs_pdafomicallback_obs_pdafomi.F90 U_init_dim_obs_pdafomi]: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector |
| | 23 | * [#U_obs_op_pdafomicallback_obs_pdafomi.F90 U_obs_op_pdafomi]: The name of the user-supplied routine that acts as the observation operator on some state vector |
| | 24 | * [#U_cvt_enscvt_ens_pdaf.F90 U_cvt_ens]: 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. |
| | 25 | * [#U_cvt_adj_enscvt_adj_ens_pdaf.F90 U_cvt_adj_ens]: 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. |
| | 26 | * [#U_cvtcvt_pdaf.F90 U_cvt]: 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. |
| | 27 | * [#U_cvt_adjcvt_adj_pdaf.F90 U_cvt_adj]: 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. |
| | 28 | * [#U_obs_op_pdafomicallback_obs_pdafomi.F90 U_obs_op_lin_pdafomi]: The name of the user-supplied routine that acts as the linearized observation operator on some state vector |
| | 29 | * [#U_obs_op_pdafomicallback_obs_pdafomi.F90 U_obs_op_lin_pdafomi]: The name of the user-supplied routine that acts as the adjoint observation operator on some state vector |
| | 30 | * [#U_init_n_domainsinit_n_domains_pdaf.F90 U_init_n_domains]: The name of the routine that provides the number of local analysis domains |
| | 31 | * [#U_init_dim_linit_dim_l_pdaf.F90 U_init_dim_l]: The name of the routine that provides the state dimension for a local analysis domain |
| | 32 | * [#U_init_dim_obs_l_pdafomicallback_obs_pdafomi.F90 U_init_dim_obs_l_pdafomi]: The name of the routine that initializes the size of the observation vector for a local analysis domain |
| | 33 | * [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep]: The name of the pre/poststep routine as in `PDAF_get_state` |
| | 34 | * `status`: The integer status flag. It is zero, if the routine is exited without errors. |
| | 35 | |
| | 36 | |
| | 37 | |
| | 38 | The user-supplied call-back routines are described on the page on [ImplementAnalysis_Hyb3DVar implementing the analysis step of hybrid 3D-Var with OMI]. |
| | 39 | |
| | 40 | 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. |
