Changes between Version 3 and Version 4 of ImplementAnalysis_3DEnVar_untilPDAF221
- Timestamp:
- Jun 10, 2025, 2:16:56 PM (7 days ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ImplementAnalysis_3DEnVar_untilPDAF221
v3 v4 38 38 == Overview == 39 39 40 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 implemen ation of the local analysis. This approach is described on the current page on the [wiki:ImplementAnalysis_3DEnVarImplementation of the Analysis Step for 3D Ensemble Var with OMI].40 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 implementation of the local analysis. This approach is described on the current page on the [wiki:ImplementAnalysis_3DEnVar_PDAF23 Implementation of the Analysis Step for 3D Ensemble Var with OMI]. 41 41 42 42 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. … … 53 53 == Analysis Routines == 54 54 55 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.55 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. 56 56 57 57 There are two variants that either compute the transformataion of the ensemble transformation using the local LESTKF method, or the global ESTKF. … … 88 88 89 89 Note: 90 * If your code shows a call to `PDAFlocalomi_assimilate_en3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_3DEnVar Implementing the Analysis Step for 3D Ensemble Var with OMI with PDAFlocal (from V2.3 of PDAF)].90 * If your code shows a call to `PDAFlocalomi_assimilate_en3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_3DEnVar_PDAF23 Implementing the Analysis Step for 3D Ensemble Var with OMI with PDAFlocal (from V2.3 of PDAF)]. 91 91 92 92 === `PDAFomi_assimilate_en3dvar_estkf` === … … 116 116 Notes: 117 117 * The interface of `PDAFomi_assimilate_en3dvar_estkf` is identical to that of `PDAFomi_assimilate_3dvar` apart from using the routines `U_cvt_ens` and `U_cvt_adj_ens` in case of the ensemble variational method. 118 * If your code shows a call to `PDAFlocalomi_assimilate_en3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_3DEnVar Implementing the Analysis Step for 3D Ensemble Var with OMI with PDAFlocal (from V2.3 of PDAF)].118 * If your code shows a call to `PDAFlocalomi_assimilate_en3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_3DEnVar_PDAF23 Implementing the Analysis Step for 3D Ensemble Var with OMI with PDAFlocal (from V2.3 of PDAF)]. 119 119 120 120 === `PDAFomi_put_state_en3dvar_lestkf` === 121 121 122 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.122 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. 123 123 124 124 The interface when using one of the global filters is the following: … … 132 132 133 133 Note: 134 * If your code shows a call to `PDAFlocalomi_put_state_en3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_3DEnVar Implementing the Analysis Step for 3D Ensemble Var with OMI with PDAFlocal (from V2.3 of PDAF)].134 * If your code shows a call to `PDAFlocalomi_put_state_en3dvar_lestkf`, it uses the implementation variant with PDAFlocal. This is documented on the page on [wiki:ImplementAnalysis_3DEnVar_PDAF23 Implementing the Analysis Step for 3D Ensemble Var with OMI with PDAFlocal (from V2.3 of PDAF)]. 135 135 136 136 === `PDAFomi_put_state_en3dvar_estkf` === … … 148 148 == User-supplied routines == 149 149 150 Here all user-supplied routines are described that are required in the call to `PDAFomi_assimilate_3dvar`. For some of the generic routines, we link to the page on [ ModifyModelforEnsembleIntegrationmodifying the model code for the ensemble integration].150 Here all user-supplied routines are described that are required in the call to `PDAFomi_assimilate_3dvar`. For some of the generic routines, we link to the page on [wiki:ModifyModelforEnsembleIntegration_PDAF23 modifying the model code for the ensemble integration]. 151 151 152 152 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. … … 159 159 This routine is independent of the filter algorithm used. 160 160 161 See the page on [ InsertAnalysisStep#U_collect_statecollect_state_pdaf.F90 inserting the analysis step] for the description of this routine.161 See the page on [wiki:InsertAnalysisStep_PDAF23#U_collect_statecollect_state_pdaf.F90 inserting the analysis step] for the description of this routine. 162 162 163 163 … … 166 166 This routine is independent of the filter algorithm used. 167 167 168 See the page on [ InsertAnalysisStep#U_distribute_statedistribute_state_pdaf.F90 inserting the analysis step] for the description of this routine.168 See the page on [wiki:InsertAnalysisStep_PDAF23#U_distribute_statedistribute_state_pdaf.F90 inserting the analysis step] for the description of this routine. 169 169 170 170 … … 173 173 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. 174 174 175 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.175 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 176 176 177 177 … … 181 181 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. 182 182 183 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.183 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 184 184 185 185 … … 233 233 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. 234 234 235 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.235 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 236 236 237 237 … … 240 240 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. 241 241 242 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.242 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 243 243 244 244 … … 285 285 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. 286 286 287 See the [wiki:OMI_Callback_obs_pdafomi documentation on callback_obs_pdafomi.F90] for more information.287 See the [wiki:OMI_Callback_obs_pdafomi_PDAF23 documentation on callback_obs_pdafomi.F90] for more information. 288 288 289 289 … … 335 335 The routine has already been described for modifying the model for the ensemble integration and for inserting the analysis step. 336 336 337 See the page on [ InsertAnalysisStep#U_prepoststepprepoststep_ens_pdaf.F90 inserting the analysis step] for the description of this routine.337 See the page on [wiki:InsertAnalysisStep_PDAF23#U_prepoststepprepoststep_ens_pdaf.F90 inserting the analysis step] for the description of this routine. 338 338 339 339 … … 342 342 This routine is independent of the filter algorithm used. 343 343 344 See the page on [ InsertAnalysisStep#U_next_observationnext_observation_pdaf.F90 inserting the analysis step] for the description of this routine.344 See the page on [wiki:InsertAnalysisStep_PDAF23#U_next_observationnext_observation_pdaf.F90 inserting the analysis step] for the description of this routine. 345 345 346 346 … … 367 367 1. [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep] (Call to act on the analysis ensemble, called with (positive) value of the time step) 368 368 369 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].369 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]. 370 370 371 371 In case of the routine `PDAFomi_assimilate_*`, the following routines are executed after the analysis step:
