Changes between Version 3 and Version 4 of ImplementAnalysis_Hyb3DVar_until_PDAF221
- Timestamp:
- Jun 10, 2025, 2:24:29 PM (7 days ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ImplementAnalysis_Hyb3DVar_until_PDAF221
v3 v4 37 37 == Overview == 38 38 39 This documentation describes the implementation of 3D variational assimilation methods with OMI as it was standard since their introduction in PDAF version 2.0 and until and including PDAF version 2.2.1. With PDAF 2.3 we introduced the [wiki:PDAFlocal_overview PDAFlocal interface], which simplifies the implemenation of the local analysis. This approach is described on the current page on the [wiki:ImplementAnalysis_Hyb3DVar Implementation of the Analysis Step for hybrid 3D Var with OMI].39 This documentation describes the implementation of 3D variational assimilation methods with OMI as it was standard since their introduction in PDAF version 2.0 and until and including PDAF version 2.2.1. With PDAF 2.3 we introduced the [wiki:PDAFlocal_overview PDAFlocal interface], which simplifies the implemenation of the local analysis. This approach is described on the current page on the [wiki:ImplementAnalysis_Hyb3DVar_PDAF23 Implementation of the Analysis Step for hybrid 3D Var with OMI]. 40 40 41 41 With Version 2.0 with introduced 3D variational assimilation methods to PDAF. There are genenerally three different variants of 3D variational assimilation methods in PDAF: parameterized 3D-Var, 3D Ensemble Var, and hybrid (parameterized + ensemble) 3D-Var. … … 52 52 == Analysis Routines == 53 53 54 The general aspects of the filter (or solver) specific routines `PDAF_assimilate_*` have been described on the page [ ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] and its sub-page on [InsertAnalysisStepinserting the analysis step]. The routine is used in the fully-parallel implementation variant of the data assimilation system. When the 'flexible' implementation variant is used, the routines `PDAF_put_state_*` is used as described further below. Here, we list the full interface of the routine. Subsequently, the user-supplied routines specified in the call is explained.54 The general aspects of the filter (or solver) specific routines `PDAF_assimilate_*` have been described on the page [wiki:ModifyModelforEnsembleIntegration_PDAF23 Modification of the model code for the ensemble integration] and its sub-page on [wiki:InsertAnalysisStep_PDAF23 inserting the analysis step]. The routine is used in the fully-parallel implementation variant of the data assimilation system. When the 'flexible' implementation variant is used, the routines `PDAF_put_state_*` is used as described further below. Here, we list the full interface of the routine. Subsequently, the user-supplied routines specified in the call is explained. 55 55 56 56 There are two variants that either compute the transformataion of the ensemble transformation using the local LESTKF method, or the global ESTKF. … … 90 90 91 91 Note: 92 * If your code shows a call to `PDAFlocalomi_assimilate_hyb3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_Hyb3DVar Implementing the Analysis Step for hybrid 3D Var with OMI with PDAFlocal (from V2.3 of PDAF)].92 * If your code shows a call to `PDAFlocalomi_assimilate_hyb3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_Hyb3DVar_PDAF23 Implementing the Analysis Step for hybrid 3D Var with OMI with PDAFlocal (from V2.3 of PDAF)]. 93 93 94 94 === `PDAFomi_assimilate_hyb3dvar_estkf` === … … 124 124 === `PDAFomi_put_state_hyb3dvar_lestkf` === 125 125 126 When the 'flexible' implementation variant is chosen for the assimilation system, the routine `PDAFomi_put_state_*` has to be used instead of `PDAFomi_assimilate_*`. The general aspects of the filter specific routines `PDAF_put_state_*` have been described on the page [ ModifyModelforEnsembleIntegrationModification of the model code for the ensemble integration]. The interface of the routine is identical with that of `PDAF_assimilate_*` with the exception the specification of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing.126 When the 'flexible' implementation variant is chosen for the assimilation system, the routine `PDAFomi_put_state_*` has to be used instead of `PDAFomi_assimilate_*`. The general aspects of the filter specific routines `PDAF_put_state_*` have been described on the page [wiki:ModifyModelforEnsembleIntegration_PDAF23 Modification of the model code for the ensemble integration]. The interface of the routine is identical with that of `PDAF_assimilate_*` with the exception the specification of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing. 127 127 128 128 The interface when using one of the global filters is the following: … … 137 137 138 138 Note: 139 * If your code shows a call to `PDAFlocalomi_put_state_hyb3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_Hyb3DVar Implementing the Analysis Step for hybrid 3D Var with OMI with PDAFlocal (from V2.3 of PDAF)].139 * If your code shows a call to `PDAFlocalomi_put_state_hyb3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_Hyb3DVar_PDAF23 Implementing the Analysis Step for hybrid 3D Var with OMI with PDAFlocal (from V2.3 of PDAF)]. 140 140 141 141 === `PDAFomi_put_state_hyb3dvar_estkf` === … … 154 154 == User-supplied routines == 155 155 156 Here all user-supplied routines are described that are required in the call to the assimilation routines for hybrid 3D-Var. For some of the generic routines, we link to the page on [ ModifyModelforEnsembleIntegrationmodifying the model code for the ensemble integration].156 Here all user-supplied routines are described that are required in the call to the assimilation routines for hybrid 3D-Var. For some of the generic routines, we link to the page on [wiki:ModifyModelforEnsembleIntegration_PDAF23 modifying the model code for the ensemble integration]. 157 157 158 158 To indicate user-supplied routines we use the prefix `U_`. In the template directory `templates/` as well as in the tutorial implementations in `tutorial/` these routines exist without the prefix, but with the extension `_pdaf.F90`. The user-routines relating to OMI are collected in the file `callback_obs_pdafomi.F90`. In the section titles below we provide the name of the template file in parentheses. … … 165 165 This routine is independent of the filter algorithm used. 166 166 167 See the page on [ InsertAnalysisStep#U_collect_statecollect_state_pdaf.F90 inserting the analysis step] for the description of this routine.167 See the page on [wiki:InsertAnalysisStep_PDAF23#U_collect_statecollect_state_pdaf.F90 inserting the analysis step] for the description of this routine. 168 168 169 169 … … 172 172 This routine is independent of the filter algorithm used. 173 173 174 See the page on [ InsertAnalysisStep#U_distribute_statedistribute_state_pdaf.F90 inserting the analysis step] for the description of this routine.174 See the page on [wiki:InsertAnalysisStep_PDAF23#U_distribute_statedistribute_state_pdaf.F90 inserting the analysis step] for the description of this routine. 175 175 176 176 … … 179 179 This is a call-back routine for PDAF-OMI initializing the observation information. The routine just calls a routine from the observation module for each observation type. 180 180 181 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.181 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 182 182 183 183 … … 187 187 This is a call-back routine for PDAF-OMI applying the observation operator to the state vector. The routine calls a routine from the observation module for each observation type. 188 188 189 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.189 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 190 190 191 191 … … 279 279 This is a call-back routine for PDAF-OMI applying the linearized observation operator to the state vector. The routine calls a routine from the observation module for each observation type. If the full observation operator is lineaer the same operator can be used here. 280 280 281 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.281 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 282 282 283 283 … … 286 286 This is a call-back routine for PDAF-OMI applying the adjoint observation operator to some vector inthe observation space. The routine calls a routine from the observation module for each observation type. 287 287 288 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.288 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 289 289 290 290 … … 331 331 This is a call-back routine for PDAF-OMI that initializes the local observation vector. The routine calls a routine from the observation module for each observation type. 332 332 333 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.333 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 334 334 335 335 … … 381 381 The routine has already been described for modifying the model for the ensemble integration and for inserting the analysis step. 382 382 383 See the page on [ InsertAnalysisStep#U_prepoststepprepoststep_ens_pdaf.F90 inserting the analysis step] for the description of this routine.383 See the page on [wiki:InsertAnalysisStep_PDAF23#U_prepoststepprepoststep_ens_pdaf.F90 inserting the analysis step] for the description of this routine. 384 384 385 385 … … 388 388 This routine is independent of the filter algorithm used. 389 389 390 See the page on [ InsertAnalysisStep#U_next_observationnext_observation_pdaf.F90 inserting the analysis step] for the description of this routine.390 See the page on [wiki:InsertAnalysisStep_PDAF23#U_next_observationnext_observation_pdaf.F90 inserting the analysis step] for the description of this routine. 391 391 392 392 … … 416 416 1. [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep] (Call to act on the analysis ensemble, called with (positive) value of the time step) 417 417 418 The iterative optimization abovve computes an updated ensemble mean state. Subsequently, the ensemble perturbations are updated using the LESTKF or ESTKF. The execution of the routines for these filters is described for the LESTKF on the [wiki:ImplementAnalysisLocal page on implementing the local filter analysis step] and for the ESTKF on the [wiki:ImplementAnalysisGlobalpage on implementing the global filter analysis step].418 The iterative optimization abovve computes an updated ensemble mean state. Subsequently, the ensemble perturbations are updated using the LESTKF or ESTKF. The execution of the routines for these filters is described for the LESTKF on the [wiki:ImplementAnalysisLocal_PDAF23 page on implementing the local filter analysis step] and for the ESTKF on the [wiki:ImplementAnalysisGlobal_PDAF23 page on implementing the global filter analysis step]. 419 419 420 420 In case of the routine `PDAFomi_assimilate_*`, the following routines are executed after the analysis step:
