Changes between Version 2 and Version 3 of ImplementAnalysislestkf


Ignore:
Timestamp:
May 5, 2014, 12:25:39 PM (6 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ImplementAnalysislestkf

    v2 v3  
    3939
    4040
    41 == `PDAF_put_state_lestkf` ==
    42 
    43 The general espects of the filter-specific routines `PDAF_put_state_*` have been described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration].
    44 The interface for the routine `PDAF_put_state_lestkf` contains several routine names for routines that operate on the local analysis domains (marked by `_l` at the end of the routine name). In addition, there are names for routines that consider all available observations required to perform local analyses with LESTKF within some sub-domain of a domain-decomposed model (marked by `_f` at the end of the routine name). In case of a serial execution of the assimilation program, these will be all globally available observations. However, if the program is executed with parallelization, this might be a smaller set of observations.
     41== `PDAF_assimilate_lestkf` ==
     42
     43The general espects of the filter-specific routines `PDAF_assimilate_*` have been described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration].  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.
     44The interface for the routine `PDAF_assimilate_lestkf` contains several routine names for routines that operate on the local analysis domains (marked by `_l` at the end of the routine name). In addition, there are names for routines that consider all available observations required to perform local analyses with LESTKF within some sub-domain of a domain-decomposed model (marked by `_f` at the end of the routine name). In case of a serial execution of the assimilation program, these will be all globally available observations. However, if the program is executed with parallelization, this might be a smaller set of observations.
    4545
    4646To explain the  difference, it is assumed, for simplicity, that a local analysis domain consists of a single vertical column of the model grid. In addition, we assume that the domain decomposition splits the global model domain by vertical boundaries as is typical for ocean models and that the observations are spatially distributed observations of model fields that are part of the state vector.  Under these assumptions, the situation is the following: When a model uses domain decomposition, the LESTKF is executed such that for each model sub-domain a loop over all local analysis domains (e.g. vertical columns) that belong to the model sub-domain is performed. As each model sub-domain is treated by a different process, all loops are executed parallel to each other.
     
    5050The interface when using the LESTKF algorithm is the following:
    5151{{{
    52   SUBROUTINE PDAF_put_state_lestkf(U_collect_state, U_init_dim_obs_f, U_obs_op_f, U_init_obs_f, &
    53                                   U_init_obs_l, U_prepoststep, U_prodRinvA_l, U_init_n_domains, &
    54                                   U_init_dim_l, U_init_dim_obs_l, &
     52  SUBROUTINE PDAF_put_state_lestkf(U_collect_state, U_distribute_state, U_init_dim_obs_f, U_obs_op_f, &
     53                                  U_init_obs_f, U_init_obs_l, U_prepoststep, U_prodRinvA_l, &
     54                                  U_init_n_domains,U_init_dim_l, U_init_dim_obs_l, &
    5555                                  U_g2l_state, U_l2g_state, U_g2l_obs, &
    56                                   U_init_obsvar, U_init_obsvar_l, status)
     56                                  U_init_obsvar, U_init_obsvar_l, U_next_observation, status)
    5757}}}
    5858with the following arguments:
    5959 * [#U_collect_statecollect_state_pdaf.F90 U_collect_state]: The name of the user-supplied routine that initializes a state vector from the array holding the ensemble of model states from the model fields. This is basically the inverse operation to `U_distribute_state` used in [ModifyModelforEnsembleIntegration#PDAF_get_state PDAF_get_state]
     60 * [#U_distribute_statedistribute_state_pdaf.F90 U_distribute_state]:  The name of a user supplied routine that initializes the model fields from the array holding the ensemble of model state vectors.
    6061 * [#U_init_dim_obs_finit_dim_obs_f_pdaf.F90 U_init_dim_obs_f]: The name of the user-supplied routine that provides the size of the full observation vector
    6162 * [#U_obs_op_fobs_op_f_pdaf.F90 U_obs_op_f]: The name of the user-supplied routine that acts as the full observation operator on some state vector
     
    7273 * [#U_init_obsvarinit_obsvar_pdaf.F90 U_init_obsvar]: The name of the user-supplied routine that provides a global mean observation error variance (This routine will only be executed, if an adaptive forgetting factor is used)
    7374 * [#U_init_obsvar_linit_obsvar_l_pdaf.F90 U_init_obsvar_l]: The name of the user-supplied routine that provides a mean observation error variance for the local analysis domain (This routine will only be executed, if a local adaptive forgetting factor is used)
     75 * [#U_next_observationnext_observation.F90 U_next_observation]: The name of a user supplied routine that initializes the variables `nsteps`, `timenow`, and `doexit`. The same routine is also used in `PDAF_get_state`.
    7476 * `status`: The integer status flag. It is zero, if `PDAF_put_state_lestkf` is exited without errors.
    7577
     
    7779 * The order of the routine names does not show the order in which these routines are executed. See the [#Executionorderofuser-suppliedroutines section on the order of the execution] at the bottom of this page.
    7880
     81
     82
     83== `PDAF_put_state_lestkf` ==
     84
     85When the 'flexible' implementation variant is chosen for the assimilation system, the routine `PDAF_put_state_lestkf` has to be used instead of `PDAF_assimilate_lestkf`. The general espects 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_lestkf` with the exception the specification of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing.
     86
     87The interface when using the LESTKF algorithm is the following:
     88{{{
     89  SUBROUTINE PDAF_put_state_lestkf(U_collect_state, U_init_dim_obs_f, U_obs_op_f, U_init_obs_f, &
     90                                  U_init_obs_l, U_prepoststep, U_prodRinvA_l, U_init_n_domains, &
     91                                  U_init_dim_l, U_init_dim_obs_l, &
     92                                  U_g2l_state, U_l2g_state, U_g2l_obs, &
     93                                  U_init_obsvar, U_init_obsvar_l, status)
     94}}}
     95
    7996== User-supplied routines ==
    8097
     
    89106This routine is independent from the filter algorithm used.
    90107See the mape on [ModifyModelforEnsembleIntegration#U_collect_statecollect_state_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
     108
     109=== `U_distribute_state` (distribute_state_pdaf.F90) ===
     110
     111This routine is independent of the filter algorithm used.
     112See the page on [InsertAnalysisStep#U_collect_statecollect_state.F90 inserting the analysis step] for the description of this routine.
    91113
    92114
     
    410432 * If the local adaptive forgetting factor is not used, this routine has only to exist for the compilation, but it does not need functionality.
    411433
     434
     435=== `U_next_observation` (next_observation_pdaf.F90) ===
     436
     437This routine is independent of the filter algorithm used.
     438See the page on [InsertAnalysisStep#U_next_observationnext_observation.F90 inserting the analysis step] for the description of this routine.
     439
     440
    412441== Execution order of user-supplied routines ==
    413442
     
    439468 1. [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep] (Call to act on the analysis ensemble, called with (positive) value of the time step)
    440469
    441 
    442 
     470In case of the routine `PDAF_assimilate_lestkf`, the following routines are executed after the analysis step:
     471 1. [#U_distribute_statedistribute_state_pdaf.F90 U_distribute_state]
     472 1. [#U_next_observationnext_observation_pdaf.F90 U_next_observation]
     473
     474
     475