| | 1 | = PDAF3_assim_offline_3dvar_all = |
| | 2 | |
| | 3 | This page documents the routine `PDAF3_assim_offline_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 | |
| | 7 | The routine is used for the offline coupled mode of PDAF, which is described on the page: [wiki:OfflineImplementationGuide Implementation Guide for Offline Coupling]. |
| | 8 | |
| | 9 | The interface is: |
| | 10 | {{{ |
| | 11 | SUBROUTINE PDAF3_assim_offline_3dvar_all(U_init_dim_obs_pdafomi, U_obs_op_pdafomi, & |
| | 12 | U_cvt_ens, U_cvt_adj_ens, U_cvt, U_cvt_adj, & |
| | 13 | U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, & |
| | 14 | U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, & |
| | 15 | U_prepoststep, outflag) |
| | 16 | }}} |
| | 17 | with the following arguments: |
| | 18 | * `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. |
| | 19 | * `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. |
| | 20 | * `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. |
| | 21 | * `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. |
| | 22 | * `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. |
| | 23 | * `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. |
| | 24 | * `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. |
| | 25 | * `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. |
| | 26 | * `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. |
| | 27 | * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains |
| | 28 | * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain |
| | 29 | * `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 |
| | 30 | * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state` |
| | 31 | * `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. |
| | 32 | |
| | 33 | |
| | 34 | The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_Hyb3DVar implementing the analysis step of hybrid 3D-Var with OMI]. |
