Changes between Version 10 and Version 11 of ImplementAnalysis_Hyb3DVar_classical


Ignore:
Timestamp:
Jun 4, 2025, 12:12:09 PM (2 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • ImplementAnalysis_Hyb3DVar_classical

    v10 v11  
    4242== Overview ==
    4343
    44 With Version 2.0 with introduced 3D variational assimilation methods to PDAF. There are genenerally three different variants: parameterized 3D-Var, 3D Ensemble Var, and hybrid (parameterized + ensemble) 3D-Var.
    45 
    46 This page describes the implementation of the analysis step for the hybrid 3D-Var in the classical way (without using PDAF-OMI).
     44PDAF provides genenerally three different variants: parameterized 3D-Var, 3D Ensemble Var, and hybrid (parameterized + ensemble) 3D-Var. These methods were introduced with PDAF V2.0.
     45
     46This page describes the implementation of the analysis step for the hybrid 3D-Var using PDAF's full interface (thus, without using PDAF-OMI).
    4747
    4848For the analysis step of 3D-Var we need different operations related to the observations. These operations are requested by PDAF by calling user-supplied routines. Intentionally, the operations are split into separate routines in order to keep the operations rather elementary as this procedure should simplify the implementation. The names of the required routines are specified in the call to the routine `PDAF_assimilate_3dvar` in the fully-parallel implementation (or `PDAF_put_state_3dvar` for the 'flexible' implementation) described below. With regard to the parallelization, all these routines (except `U_collect_state`) are executed by the filter processes (`filterpe=.true.`) only.
    … …  
    136136
    137137
     138
     139=== `PDAF_assim_offline_hyb3dvar_lestkf` ===
     140
     141This routine is used to perform the analysis step for the offline mode of PDAF.
     142The interface of the routine is identical with that of the 'assimilate'-routine, except that the user-supplied routines `U_distribute_state`, `U_collect_state` and `U_next_observation` are missing.
     143
     144The 'assim_offline' routines were introduced with PDAF V3.0 to simplify the [wiki:OfflineImplementationGuide_PDAF3 implementation of the offline mode].
     145
     146The interface is:
     147{{{
     148  SUBROUTINE PDAF_assim_offline_hyb3dvar_lestkf( &
     149                                 U_init_dim_obs, U_obs_op, U_init_obs, U_prodRinvA, &
     150                                 U_cvt_ens, U_cvt_adj_ens, U_cvt, U_cvt_adj, U_obs_op_lin, U_obs_op_adj, &
     151                                 U_init_dim_obs_f, U_obs_op_f, U_init_obs_f, U_init_obs_l, U_prodRinvA_l, &
     152                                 U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l, U_g2l_state, U_l2g_state, &
     153                                 U_g2l_obs, U_init_obsvar, U_init_obsvar_l, &
     154                                 U_prepoststep, outflag)
     155}}}
     156
     157=== `PDAF_assim_offline_hyb3dvar_estkf` ===
     158
     159The interface of this routine is analogous to that of `PDAF_assimilate_hyb3dvar_estkf'. Thus it is identical to this routine with the exception the specification of the user-supplied routines `U_distribute_state`, `U_collect_state` and `U_next_observation` are missing.
     160
     161The interface is:
     162{{{
     163  SUBROUTINE PDAF_assim_offline_hyb3dvar_estkf( &
     164                                 U_init_dim_obs, U_obs_op, U_init_obs, U_prodRinvA, &
     165                                 U_cvt_ens, U_cvt_adj_ens, U_cvt, U_cvt_adj, U_obs_op_lin, U_obs_op_adj, &
     166                                 U_init_obsvar, U_prepoststep, outflag)
     167}}}
     168
     169
     170
    138171=== `PDAF_put_state_hyb3dvar_lestkf` ===
    139172
    140 When the 'flexible' implementation variant is chosen for the assimilation system, the routine `PDAF_put_state_*` has to be used instead of `PDAF_assimilate_*`. The general aspects of the filter specific routines `PDAF_put_state_*` have been described on the page [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3 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.
    141 
    142 The interface when using one of the global filters is the following:
     173This routine exists for backward-compatibility. In implementations that were done for PDAF V2.3.1 and before, a 'put_state' routine was used for the [wiki:OnlineFlexible_PDAF3 'flexible' parallelization variant] and for the [wiki:OfflineImplementationGuide_PDAF3 offline mode].  This routine allows to continue using the previous implementation structure.
     174The interface of the routine is identical with that of the 'assimilate'-routine, except that the user-supplied routines `U_distribute_state` and `U_next_observation` are missing.
     175
     176The interface is:
    143177{{{
    144178  SUBROUTINE PDAF_put_state_hyb3dvar_lestkf(U_collect_state, &
    … …  
    155189The interface of this routine is analogous to that of `PDAF_assimilate_hyb3dvar_estkf'. Thus it is identical to this routine with the exception the specification of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing.
    156190
    157 The interface when using one of the global filters is the following:
     191The interface is:
    158192{{{
    159193  SUBROUTINE PDAF_put_state_hyb3dvar_estkf(U_collect_state, &
    … …  
    165199== User-supplied routines ==
    166200
    167 Here all user-supplied routines are described that are required in the calls to `PDAF_assimilate_hyb3dvar_*` and `PDAF_put_state_hyb3dvar_*`. For some of the generic routines, we link to the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3 modifying the model code for the ensemble integration].
     201Here, all user-supplied routines are described that are required in the calls to the analysis routines. For some of the generic routines, we link to the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3 modifying the model code for the ensemble integration].
    168202
    169203To indicate user-supplied routines we use the prefix `U_`. In the tutorials in `tutorial/` and in the template directory `templates/` these routines exist without the prefix, but with the extension `_pdaf`. The files are named correspondingly. In the section titles below we provide the name of the template file in parentheses.
    170204
    171 In the subroutine interfaces some variables appear with the suffix `_p`. This suffix indicates that the variable is particular to a model sub-domain, if a domain decomposed model is used. Thus, the value(s) in the variable will be different for different model sub-domains.
     205In the subroutine interfaces some variables appear with the suffix `_p` (short for 'process'). This suffix indicates that the variable is particular to a model sub-domain, if a domain decomposed model is used. Thus, the value(s) in the variable will be different for different model sub-domains. In addition, there will be variables with the suffix `_f` (for 'full') and with the suffix `_l` (for 'local').
     206
     207For more informstion on the localization and the meaning of the 'full' observation vector see the [wiki:ImplementAnalysislestkf Page on the analysis step of the LESTKF].
    172208
    173209
    174210=== `U_collect_state` (collect_state_pdaf.F90) ===
    175211
    176 This routine is independent of the filter algorithm used.
    177 
    178 See the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3#U_collect_statecollect_state_pdaf.F90 inserting the analysis step] for the description of this routine.
     212This routine is independent of the DA method used.
     213See the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3#collect_state_pdafcollect_state_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
    179214
    180215
    181216=== `U_distribute_state` (distribute_state_pdaf.F90) ===
    182217
    183 This routine is independent of the filter algorithm used.
    184 
    185 See the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3#U_distribute_statedistribute_state_pdaf.F90 inserting the analysis step] for the description of this routine.
    186 
     218This routine is independent of the DA method used.
     219See the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3#distribute_state_pdafdistribute_state_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
    187220
    188221
    … …  
    698731=== `U_next_observation` (next_observation_pdaf.F90) ===
    699732
    700 This routine is independent of the filter algorithm used.
    701 
    702 See the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3#U_next_observationnext_observation_pdaf.F90 inserting the analysis step] for the description of this routine.
    703 
     733This routine is independent of the DA method used.
     734
     735See the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3#next_observation_pdafnext_observation_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
    704736
    705737== Execution order of user-supplied routines ==