Changes between Version 10 and Version 11 of ImplementAnalysisENSRF_EAKF


Ignore:
Timestamp:
May 28, 2025, 2:20:56 PM (3 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • ImplementAnalysisENSRF_EAKF

    v10 v11  
    2020<li><a href="ImplementAnalysisenkf">Implementation for EnKF</a></li>
    2121<li><a href="ImplementAnalysislenkf">Implementation for LEnKF</a></li>
    22 <li>Implementation for ENSRF/EAKF</li>
     22<li><a href="ImplementAnalysisENSRF_EAKF">Implementation for ENSRF/EAKF</a></li>
    2323<li><a href="ImplementAnalysisnetf">Implementation for NETF</a></li>
    2424<li><a href="ImplementAnalysislnetf">Implementation for LNETF</a></li>
    … …  
    3535[[PageOutline(2-3,Contents of this page)]]
    3636
    37 || This page describes the implementation of the analysis step without using PDAF-OMI. This approach is used in older implementations of PDAF and can be seen as a export-mode. Please see the [wiki:ImplementationofAnalysisStep page on the analysis with OMI] for the more modern and efficient implementation variant using PDAF-OMI. ||
     37|| This page describes the implementation of the analysis step using PDAF's full interface, i.e. without using the advanced PDAF3 interface or PDAF-OMI. This approach  can be seen as a export-mode. Please see the [wiki:ImplementationofAnalysisStep_PDAF3 page on the analysis using the PDAF3 interface] for the more modern and efficient implementation variant. ||
    3838
    3939The ENSRF/EAKF filters were added with verson 3.0 of PDAF.
    … …  
    5757== `PDAF_assimilate_ensrf` ==
    5858
    59 The general aspects of the filter-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 [InsertAnalysisStep inserting the analysis step]. The routine is used in the fully-parallel and the flexible implementation variants of the data assimilation system. When the offline model is used, the routines `PDAF_assim_offline_*` are used. (Implementations done for PDAF2 might also use routines `PDAF_put_state_*`, which have also been used in previous PDAF releases for the 'flexible' implementation variant.) Here, we list the full interface of the routine once more. Subsequently, the full set of user-supplied routines specified in the call to `PDAF_assimilate_ensrf` is explained.
     59The general aspects of the filter-specific routines `PDAF_assimilate_*` have been described on the page [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3 Modification of the model code for the ensemble integration]. The routine is used in the fully-parallel and the flexible implementation variants of the data assimilation system. When the offline model is used, the routines `PDAF_assim_offline_*` are used. (Implementations done for PDAF2 might also use routines `PDAF_put_state_*`, which have also been used in previous PDAF releases for the 'flexible' implementation variant.) Here, we list the full interface of the routine once more. Subsequently, the full set of user-supplied routines specified in the call to `PDAF_assimilate_ensrf` is explained.
    6060
    6161The interface for the ENSRF/EAKF:
    … …  
    9696
    9797In PDAF3 this routine exists for backward-compatibility to support implementations done using PDAF2 standards.
    98 This routine was used in implementations before the release of PDAF V3.0 for the offline mode of PDAF and for the 'flexible' implementation variant of the assimilation system. The general aspects of the filter specific routines `PDAF_put_state_*` have been described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration]. The interface of the routine is identical with that of `PDAF_assimilate_ensrf` with the exception that the arguments of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing.
     98This routine was used in implementations before the release of PDAF V3.0 for the offline mode of PDAF and for the 'flexible' implementation variant of the assimilation system. 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_ensrf` with the exception that the arguments of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing.
    9999
    100100The interface is the following:
    … …  
    109109== User-supplied routines ==
    110110
    111 Here, all user-supplied routines are described that are required in the call to `PDAF_assimilate_ensrf`. For some of the generic routines, we link to the page on [ModifyModelforEnsembleIntegration modifying the model code for the ensemble integration].
     111Here, all user-supplied routines are described that are required in the call to `PDAF_assimilate_ensrf`. For some of the generic routines, we link to the page on [wiki:OnlineModifyModelforEnsembleIntegration_PDAF3 modifying the model code for the ensemble integration].
    112112
    113113To 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.
    … …  
    119119
    120120This routine is independent of the filter algorithm used.
    121 See the page on [InsertAnalysisStep#U_collect_statecollect_state_pdaf.F90 inserting the analysis step] for the description of this routine.
     121
     122See the page on [ModifyModelforEnsembleIntegration#collect_state_pdafcollect_state_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
    122123
    123124
    124125=== `U_distribute_state` (distribute_state_pdaf.F90) ===
    125126
    126 This routine is independent of the filter algorithm used.
    127 See the page on [InsertAnalysisStep#U_distribute_statedistribute_state_pdaf.F90 inserting the analysis step] for the description of this routine.
     127This is a call-back routine initializing the observation information. The routine just calls a routine from the observation module for each observation type.
     128
     129See the [wiki:OMI_Callback_obs_pdafomi_PDAF3 documentation on callback_obs_pdafomi.F90] for more information.
     130
    128131
    129132=== `U_init_dim_obs_f` (init_dim_obs_f_pdaf.F90) ===
    … …  
    226229=== `U_prepoststep` (prepoststep_ens_pdaf.F90) ===
    227230
    228 The general aspects of this routines have already been described on the [ModifyModelforEnsembleIntegration#U_prepoststepprepoststep_ens_pdaf.F90 page on modifying the model code for the ensemble integration] for the SEIK filter. For completeness, the description is repeated specifically for the ENSRF:
    229 
    230 The interface of the routine is identical for all filters, but sizes can vary. Additionally, the specific operations performed in the routine can vary for each filter algorithm.
    231 
    232 The interface for this routine is for the ENSRF
    233 {{{
    234 SUBROUTINE U_prepoststep(step, dim_p, dim_ens, dim_ens_p, dim_obs_p, &
    235                        state_p, Uinv, ens_p, flag)
    236 
    237   INTEGER, INTENT(in) :: step        ! Current time step
    238                          ! (When the routine is called before the analysis -step is provided.)
    239   INTEGER, INTENT(in) :: dim_p       ! PE-local state dimension
    240   INTEGER, INTENT(in) :: dim_ens     ! Size of state ensemble
    241   INTEGER, INTENT(in) :: dim_ens_p   ! PE-local size of ensemble
    242   INTEGER, INTENT(in) :: dim_obs_p   ! PE-local dimension of observation vector
    243   REAL, INTENT(inout) :: state_p(dim_p) ! PE-local forecast/analysis state
    244                                      ! The array 'state_p' is not generally not initialized in the case of SEIK/EnKF/ETKF.
    245                                      ! It can be used freely in this routine.
    246   REAL, INTENT(inout) :: Uinv(1, 1)  ! Not used not LEnKF
    247   REAL, INTENT(inout) :: ens_p(dim_p, dim_ens)      ! PE-local state ensemble
    248   INTEGER, INTENT(in) :: flag        ! PDAF status flag
    249 }}}
    250 
    251 The routine `U_prepoststep` is called once at the beginning of the assimilation process and subsequently during the assimilation cycles before the analysis step and after the ensemble transformation. The routine is called by all filter processes (that is `filterpe=1`).
    252 
    253 The routine provides for the user with full access to the ensemble of model states. Thus, user-controlled pre- and post-step operations can be performed. 
    254 For example, the forecast and analysis states, as well as the ensemble covariance matrix, can be analyzed, e.g., by computing the estimated variances.
    255 In addition, the estimates can be written to disk.
    256 
    257 Hint:
    258  * If a user considers to perform adjustments to the estimates (e.g., for balances), this routine is the right place for it.
    259  * The state vector (`state_p`) is allocated for all other filters, but it can be used freely during the execution of `U_prepoststep`. One cannot assume that the vector holds the correct state vector.
    260  * The array `Uinv` is not used in the EnKF. Internally to PDAF, it is allocated to be of size (1,1).
    261  * Apart from the size of the array `Uinv`, the interface is identical for all ensemble filters. In general, it should be possible to use an identical pre/poststep routine for all these filters.
    262  * The interface through which `U_prepoststep` is called does not include the array of smoothed ensembles. In order to access the smoother ensemble array one has to set a pointer to it using a call to the routine `PDAF_get_smootherens` (see the page on [AuxiliaryRoutines auxiliary routines])
     231The routine has already been described for modifying the model for the ensemble integration and for inserting the analysis step.
     232
     233See the page on [ModifyModelforEnsembleIntegration#distribute_state_pdafdistribute_state_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
     234
    263235
    264236
    … …  
    266238
    267239This routine is independent of the filter algorithm used.
    268 See the page on [InsertAnalysisStep#U_next_observationnext_observation_pdaf.F90 inserting the analysis step] for the description of this routine.
     240
     241See the page on [ModifyModelforEnsembleIntegration#distribute_state_pdafdistribute_state_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
    269242
    270243