Version 15 (modified by 2 years ago) (diff)  ,

Implementation of the analysis step for the LESTKF
Implementation Guide
 Main page
 Adaptation of the parallelization
 Initialization of PDAF
 Modifications for ensemble integration
 Implementation of the analysis step
 Implementation for ESTKF
 Implementation for LESTKF
 Implementation for ETKF
 Implementation for LETKF
 Implementation for SEIK
 Implementation for LSEIK
 Implementation for SEEK
 Implementation for EnKF
 Implementation for LEnKF
 Implementation for NETF
 Implementation for LNETF
 Implementation for PF
 Implementation for 3DVar
 Implementation for 3D Ensemble Var
 Implementation for Hybrid 3DVar
 Memory and timing information
 Ensemble Generation
 Diagnostics
Contents of this page
 Overview

PDAF_assimilate_lestkf

PDAF_put_state_lestkf

Usersupplied routines

U_collect_state
(collect_state_pdaf.F90) 
U_distribute_state
(distribute_state_pdaf.F90) 
U_init_dim_obs_f
(init_dim_obs_f_pdaf.F90) 
U_obs_op_f
(obs_op_f_pdaf.F90) 
U_init_obs_f
(init_obs_f_pdaf.F90) 
U_init_obs_l
(init_obs_l_pdaf.F90) 
U_prepoststep
(prepoststep_ens_pdaf.F90) 
U_prodRinvA_l
(prodrinva_l_pdaf.F90) 
U_init_n_domains
(init_n_domains_pdaf.F90) 
U_init_dim_l
(init_dim_l_pdaf.F90) 
U_init_dim_obs_l
(init_dim_obs_l_pdaf.F90) 
U_g2l_state
(g2l_state_pdaf.F90) 
U_l2g_state
(l2g_state_pdaf.F90) 
U_g2l_obs
(g2l_obs_pdaf.F90) 
U_init_obsvar
(init_obsvar_pdaf.F90) 
U_init_obsvar_l
(init_obsvar_l_pdaf.F90) 
U_next_observation
(next_observation_pdaf.F90)

 Execution order of usersupplied routines
Overview
With Version 1.8 of PDAF, the LESTKF [Local Error Subspace Transform Kalman Filter] algorithm has been introduced. The usersupplied routines required for the LESTKF are identical to those required for the LSEIK filter.
For the analysis step of the LESTKF, several operations related to the observations are needed. These operations are requested by PDAF by calling usersupplied 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_lestkf
in the fullyparallel implementation (or PDAF_put_state_lestkf
for the 'flexible' implementation) described below. With regard to the parallelization, all these routines (except U_collect_state
, U_distribute_state
, and U_next_observation
) are executed by the filter processes (filterpe=.true.
) only.
For completeness we discuss here all usersupplied routines that are specified in the interface to PDAF_assimilate_lestkf
. Many of the routines are localized versions of those that are needed for the global ESTKF method. Hence, if the usersupplied routines for the global ESTKF have been already implemented, one can base on these routines to speed up the implementation. Due to this, it can also be reasonable to first fully implement a global filter version and subsequently implement the corresponding localized filter by modifying and extending the global routines.
The LESTKF and the LETKF (Local Ensemble Transform Kalman Filter) are very similar. For this reason, the interface to the usersupplied routines is almost identical. Depending on the implementation it can be possible to use identical routines for the LESTKF and the LETKF. Differences are marked in the text below.
PDAF_assimilate_lestkf
The general aspects of the filterspecific routines PDAF_assimilate_*
have been described on the page Modification of the model code for the ensemble integration and its subpage on inserting the analysis step. The routine is used in the fullyparallel 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.
The 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 subdomain of a domaindecomposed 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.
To 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 subdomain a loop over all local analysis domains (e.g. vertical columns) that belong to the model subdomain is performed. As each model subdomain is treated by a different process, all loops are executed parallel to each other.
For the update of each single vertical column, observations from some larger domain surrounding the vertical column are required. If the influence radius for the observations is sufficiently small there will be vertical columns for which the relevant observations reside completely inside the model subdomain of the process. However, if a vertical column is considered that is located close to the boundary of the model subdomain, there will be some observations that don't belong spatially to the local model subdomain, but to a neighboring model subdomain. Nonetheless, these observations are required on the local model subdomain. A simple way to handle this situation is to initialize for each process all globally available observations, together with their coordinates. While this method is simple, it can also become inefficient if the assimilation program is executed using a large number of processes. As for an initial implementation it is usually not the concern to obtain the highest parallel efficiency, the description below assumes that 'full' refers to the global model domain.
The interface when using the LESTKF algorithm is the following:
SUBROUTINE PDAF_assimilate_lestkf(U_collect_state, U_distribute_state, U_init_dim_obs_f, U_obs_op_f, & U_init_obs_f, U_init_obs_l, U_prepoststep, U_prodRinvA_l, & U_init_n_domains,U_init_dim_l, U_init_dim_obs_l, & U_g2l_state, U_l2g_state, U_g2l_obs, & U_init_obsvar, U_init_obsvar_l, U_next_observation, status)
with the following arguments:
 U_collect_state: The name of the usersupplied 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 PDAF_get_state and also here.  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.
 U_init_dim_obs_f: The name of the usersupplied routine that provides the size of the full observation vector
 U_obs_op_f: The name of the usersupplied routine that acts as the full observation operator on some state vector
 U_init_obs_f: The name of the usersupplied routine that initializes the full vector of observations
 U_init_obs_l: The name of the usersupplied routine that initializes the vector of observations for a local analysis domain
 U_prepoststep: The name of the pre/poststep routine as in
PDAF_get_state
 U_prodRinvA_l: The name of the usersupplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF.
 U_init_n_domains: The name of the routine that provides the number of local analysis domains
 U_init_dim_l: The name of the routine that provides the state dimension for a local analysis domain
 U_init_dim_obs_l: The name of the routine that initializes the size of the observation vector for a local analysis domain
 U_g2l_state: The name of the routine that initializes a local state vector from the global state vector
 U_l2g_state: The name of the routine that initializes the corresponding part of the global state vector from the the provided local state vector
 U_g2l_obs: The name of the routine that initializes a local observation vector from a full observation vector
 U_init_obsvar: The name of the usersupplied routine that provides a global mean observation error variance (This routine will only be executed, if an adaptive forgetting factor is used)
 U_init_obsvar_l: The name of the usersupplied 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)
 U_next_observation: The name of a user supplied routine that initializes the variables
nsteps
,timenow
, anddoexit
. The same routine is also used inPDAF_get_state
. status
: The integer status flag. It is zero, ifPDAF_assimilate_lestkf
is exited without errors.
Note:
 The order of the routine names does not show the order in which these routines are executed. See the section on the order of the execution at the bottom of this page.
PDAF_put_state_lestkf
When 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 aspects of the filter specific routines PDAF_put_state_*
have been described on the page 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 usersupplied routines U_distribute_state
and U_next_observation
are missing.
The interface when using the LESTKF algorithm is the following:
SUBROUTINE PDAF_put_state_lestkf(U_collect_state, U_init_dim_obs_f, U_obs_op_f, U_init_obs_f, & U_init_obs_l, U_prepoststep, U_prodRinvA_l, U_init_n_domains, & U_init_dim_l, U_init_dim_obs_l, & U_g2l_state, U_l2g_state, U_g2l_obs, & U_init_obsvar, U_init_obsvar_l, status)
Usersupplied routines
Here, all usersupplied routines are described that are required in the call to PDAF_assimilate_lestkf
or PDAF_put_state_lestkf
. For some of the generic routines, we link to the page on modifying the model code for the ensemble integration.
To indicate usersupplied routines we use the prefix U_
. In the template directory templates/
as well as in the example implementation in testsuite/src/dummymodel_1D
these routines exist without the prefix, but with the extension _pdaf.F90
. In the section titles below we provide the name of the template file in parentheses.
In the subroutine interfaces some variables appear with the suffix _p
(short for 'process'). This suffix indicates that the variable is particular to a model subdomain, if a domain decomposed model is used. Thus, the value(s) in the variable will be different for different model subdomains. In addition, there will be variables with the suffix _f
(for 'full') and with the suffix _l
(for 'local').
U_collect_state
(collect_state_pdaf.F90)
This routine is independent from the filter algorithm used. See the mape on inserting the analysis step for the description of this routine.
U_distribute_state
(distribute_state_pdaf.F90)
This routine is independent of the filter algorithm used. See the page on inserting the analysis step for the description of this routine.
U_init_dim_obs_f
(init_dim_obs_f_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE init_dim_obs_f(step, dim_obs_f) INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(out) :: dim_obs_f ! Dimension of full observation vector
The routine is called at the beginning of each analysis step, before the loop over all local analysis domains is entered. It has to initialize the size dim_obs_f
of the full observation vector according to the current time step. For simplicity, dim_obs_f
can be the size for the global model domain.
Some hints:
 It can be useful to not only determine the size of the observation vector at this point. One can also already gather information about the location of the observations, which can be used later, e.g. to implement the observation operator. In addition, one can already prepare an array that holds the full observation vector. This can be used later by
U_init_obs_l
to initialize a local vector of observations by selecting the relevant parts of the full observation vector. The required arrays can be defined in a module likemod_assimilation
.  The routine is similar to
init_dim_obs
used in the global filters. However, if the global filter is used with a domaindecomposed model, it only initializes the size of the observation vector for the local model subdomain. This is different for the local filters, as the local analysis also requires observational data from neighboring model subdomains. Nonetheless, one can base on an implemented routineinit_dim_obs
to implementinit_dim_obs_f
.
U_obs_op_f
(obs_op_f_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE obs_op_f(step, dim_p, dim_obs_f, state_p, m_state_f) INTEGER, INTENT(in) :: step ! Currrent time step INTEGER, INTENT(in) :: dim_p ! PElocal dimension of state INTEGER, INTENT(in) :: dim_obs_f ! Dimension of the full observed state REAL, INTENT(in) :: state_p(dim_p) ! PElocal model state REAL, INTENT(out) :: m_state_f(dim_obs_f) ! Full observed state
The routine is called during the analysis step, before the loop over the local analysis domain is entered. It has to perform the operation of the observation operator acting on a state vector, which is provided as state_p
. The observed state has to be returned in m_state_f
. It is the observed state corresponding to the 'full' observation vector.
Hint:
 The routine is similar to
init_dim_obs
used for the global filters. However, with a domaindecomposed modelm_state_f
will contain parts of the state vector from neighboring model subdomains. To make these parts accessible, some parallel communication will be necessary (The state information for a neighboring model subdomain, will be in the memory of the process that handles that subdomain). The example implementation intestsuite/dummymodel_1d
uses the functionMPI_AllGatherV
for this communication.
U_init_obs_f
(init_obs_f_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The routine is only called if the globally adaptive forgetting factor is used (type_forget=1
in the example implementation). For the local filters there is also the alternative to use locally adaptive forgetting factors (type_forget=2
in the example implementation)
The interface for this routine is:
SUBROUTINE init_obs_f(step, dim_obs_f, observation_f) INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: dim_obs_f ! Dimension of full observation vector REAL, INTENT(out) :: observation_f(dim_obs_f) ! Full observation vector
The routine is called during the analysis step before the loop over the local analysis domains is entered. It has to provide the full vector of observations in observation_f
for the current time step. The caller is the routine that computes an adaptive forgetting factor (PDAF_set_forget).
Hints:
 As for the other 'full' routines: While the global counterpart of this routine (
init_obs
) has to initialize the observation vector only for the local model subdomain, the 'full' routine has to include observations that spatially belong to neighboring model subdomains. As an easy choice one can simply initialize a vector of all globally available observations.  If the adaptive forgetting factor is not used, this routine only has to exist. However, no functionality is required.
U_init_obs_l
(init_obs_l_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE init_obs_l(domain_p, step, dim_obs_l, observation_l) INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: dim_obs_l ! Local dimension of observation vector REAL, INTENT(out) :: observation_l(dim_obs_l) ! Local observation vector
The routine is called during the analysis step during the loop over the local analysis domain.
It has to provide the vector of observations for the analysis in the local analysis domain with index domain_p
in observation_l
for the current time step.
Hints:
 For parallel efficiency, the LESTKF algorithm is implemented in a way that first the full vectors are initialized. These are then restricted to the local analysis domain during the loop over all local analysis domains. Thus, if the full vector of observations has been initialized before
U_init_obs_l
is executed (e.g. byU_init_dim_obs_f
), the operations performed in this routine will be to select the part of the full observation vector that is relevant for the current local analysis domain.  The routine
U_init_dim_obs_l
is executed before this routine. Thus, if that routine already prepares the information which elements ofobservation_f
are needed forobservation_l
, this information can be used efficiently here.
U_prepoststep
(prepoststep_ens_pdaf.F90)
This routine can be identical to that used for the global ESTKF algorithm, which has already been described on the page on modifying the model code for the ensemble integration. For completeness, the description is repeated:
The interface of the routine is identical for all filters. However, the particular operations that are performed in the routine can be specific for each filter algorithm.
The interface for this routine is
SUBROUTINE prepoststep(step, dim_p, dim_ens, dim_ens_p, dim_obs_p, & state_p, Uinv, ens_p, flag) INTEGER, INTENT(in) :: step ! Current time step ! (When the routine is called before the analysis step is provided.) INTEGER, INTENT(in) :: dim_p ! PElocal state dimension INTEGER, INTENT(in) :: dim_ens ! Size of state ensemble INTEGER, INTENT(in) :: dim_ens_p ! PElocal size of ensemble INTEGER, INTENT(in) :: dim_obs_p ! PElocal dimension of observation vector REAL, INTENT(inout) :: state_p(dim_p) ! PElocal forecast/analysis state ! The array 'state_p' is not generally not initialized in the case of SEIK/EnKF/ETKF/ESTKF. ! It can be used freely in this routine. REAL, INTENT(inout) :: Uinv(dim_ens1, dim_ens1) ! Inverse of matrix U REAL, INTENT(inout) :: ens_p(dim_p, dim_ens) ! PElocal state ensemble INTEGER, INTENT(in) :: flag ! PDAF status flag
The routine U_prepoststep
is called once at the beginning of the assimilation process. In addition, it is called 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
).
The routine provides for the user the full access to the ensemble of model states. Thus, usercontrolled pre and poststep operations can be performed. For example the forecast and the analysis states and ensemble covariance matrix can be analyzed, e.g. by computing the estimated variances. In addition, the estimates can be written to disk.
Hint:
 If a user considers to perform adjustments to the estimates (e.g. for balances), this routine is the right place for it.
 Only for the SEEK filter the state vector (
state_p
) is initialized. For all other filters, the array is allocated, but it can be used freely during the execution ofU_prepoststep
.  The interface has a difference for LETKF and LESTKF: For the LETKF, the array
Uinv
has sizedim_ens
xdim_ens
. In contrast it has sizedim_ens1
xdim_ens1
for the LESTKF.  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 routinePDAF_get_smootherens
(see page on auxiliary routines)
U_prodRinvA_l
(prodrinva_l_pdaf.F90)
This routine is used by the local filters (LSEIK, LETKF, LESTKF). There is a slight difference between LESTKF and LETKF for this routine, which is described below.
The interface for this routine is:
SUBROUTINE prodRinvA_l(domain_p, step, dim_obs_l, rank, obs_l, A_l, C_l) INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: dim_obs_l ! Dimension of local observation vector INTEGER, INTENT(in) :: rank ! Rank of initial covariance matrix REAL, INTENT(in) :: obs_l(dim_obs_l) ! Local vector of observations REAL, INTENT(inout) :: A_l(dim_obs_l, rank) ! Input matrix from analysis routine REAL, INTENT(out) :: C_l(dim_obs_l, rank) ! Output matrix
The routine is called during the loop over the local analysis domains. In the algorithm, the product of the inverse of the observation error covariance matrix with some matrix has to be computed. For the SEIK filter this matrix holds the observed part of the ensemble perturbations for the local analysis domain of index domain_p
. The matrix is provided as A_l
. The product has to be given as C_l
.
This routine is also the place to perform observation localization. To initialize a vector of weights, the routine PDAF_local_weight
can be called. The procedure is used in the example implementation and also demonstrated in the template routine.
Hints:
 The routine is a local variant of the routine
U_prodRinvA
. Thus if that routine has been implemented before, it can be adapted here for the local filter.  The routine does not require that the product is implemented as a real matrixmatrix product. Rather, the product can be implemented in its most efficient form. For example, if the observation error covariance matrix is diagonal, only the multiplication of the diagonal with matrix
A_l
has to be implemented.  The observation vector
obs_l
is provided through the interface for cases where the observation error variance is relative to the actual value of the observations.  The interface has a difference for LESTKF and LETKF: For LETKF the third argument is the ensemble size (
dim_ens
), while for LESTKF it is the rank (rank
) of the covariance matrix (usually ensemble size minus one). In addition, the second dimension ofA_l
andC_l
has sizedim_ens
for LETKF, while it isrank
for LESTKF. (Practically, one can usually ignore this difference as the fourth argument of the interface can be named arbitrarily in the routine.)
U_init_n_domains
(init_n_domains_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE init_n_domains(step, n_domains_p) INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(out) :: n_domains_p ! Number of analysis domains for local model subdomain
The routine is called during the analysis step before the loop over the local analysis domains is entered. It has to provide the number of local analysis domains. In case of a domaindecomposed model the number of local analysis domain for the model subdomain of the calling process has to be initialized.
Hints:
 As a simple case, if the localization is only performed horizontally, the local analysis domains can be single vertical columns of the model grid. In this case,
n_domains_p
is simply the number of vertical columns in the local model subdomain.
U_init_dim_l
(init_dim_l_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE init_dim_l(step, domain_p, dim_l) INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(out) :: dim_l ! Local state dimension
The routine is called during the loop over the local analysis domains in the analysis step.
It has to provide in dim_l
the dimension of the state vector for the local analysis domain with index domain_p
.
Hints:
 If a local analysis domain is a single vertical column of the model grid, the size of the state in the local analysis domain will be just the number of vertical grid points at this location.
U_init_dim_obs_l
(init_dim_obs_l_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE init_dim_obs_l(domain_p, step, dim_obs_f, dim_obs_l) INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: dim_obs_f ! Full dimension of observation vector INTEGER, INTENT(out) :: dim_obs_l ! Local dimension of observation vector
The routine is called during the loop over the local analysis domains in the analysis step.
It has to initialize in dim_obs_l
the size of the observation vector used for the local analysis domain with index domain_p
.
Some hints:
 Usually, the observations to be considered for a local analysis are those which reside within some distance from the local analysis domain. Thus, if the local analysis domain is a single vertical column of the model grid and if the model grid is a regular ijgrid, then one could use some range of i/j indices to select the observations and determine the local number of them. More generally, one can compute the physical distance of an observation from the local analysis domain and decide on this basis, if the observation has to be considered.
 In the loop over the local analysis domains, the routine is always called before
U_init_obs_l
is executed. Thus, asU_init_dim_obs_l
has to check which observations should be used for the local analysis domain, one can already initialize an integer array that stores the index of observations to be considered. This index should be the position of the observation in the arrayobservation_f
. With this, the initialization of the local observation vector inU_init_obs_l
can be sped up.  For PDAF, we could not join the routines
U_init_dim_obs_l
andU_init_obs_l
, because the array for the local observations is allocated internally to PDAF after its size has been determined inU_init_dim_obs_l
.
U_g2l_state
(g2l_state_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE g2l_state(step, domain_p, dim_p, state_p, dim_l, state_l) INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(in) :: dim_p ! State dimension for model subdomain INTEGER, INTENT(in) :: dim_l ! Local state dimension REAL, INTENT(in) :: state_p(dim_p) ! State vector for model subdomain REAL, INTENT(out) :: state_l(dim_l) ! State vector on local analysis domain
The routine is called during the loop over the local analysis domains in the analysis step. It has to provide the local state vector state_l
that corresponds to the local analysis domain with index domain_p
. Provided to the routine is the state vector state_p
. With a domain decomposed model, this is the state for the local model subdomain.
Hints:
 In the simple case that a local analysis domain is a single vertical column of the model grid, the operation in this routine would be to take out of
state_p
the data for the vertical column indexed bydomain_p
.
U_l2g_state
(l2g_state_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE l2g_state(step, domain_p, dim_l, state_l, dim_p, state_p) INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(in) :: dim_p ! State dimension for model subdomain INTEGER, INTENT(in) :: dim_l ! Local state dimension REAL, INTENT(in) :: state_p(dim_p) ! State vector for model subdomain REAL, INTENT(out) :: state_l(dim_l) ! State vector on local analysis domain
The routine is called during the loop over the local analysis domains in the analysis step. It has to initialize the part of the global state vector state_p
that corresponds to the local analysis domain with index domain_p
. Provided to the routine is the state vector state_l
for the local analysis domain.
Hints:
 In the simple case that a local analysis domain is a single vertical column of the model grid, the operation in this routine would be to write into
state_p
the data for the vertical column indexed bydomain_p
.
U_g2l_obs
(g2l_obs_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
The interface for this routine is:
SUBROUTINE g2l_obs(domain_p, step, dim_obs_f, dim_obs_l, mstate_f, mstate_l) INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: dim_obs_f ! Dimension of full observation vector for model subdomain INTEGER, INTENT(in) :: dim_obs_l ! Dimension of observation vector for local analysis domain REAL, INTENT(in) :: mstate_f(dim_obs_f) ! Full observation vector for model subdomain REAL, INTENT(out) :: mstate_l(dim_obs_l) ! Observation vector for local analysis domain
The routine is called during the loop over the local analysis domains in the analysis step. It has to provide a local observation vector mstate_l
for the observation domain that corresponds to the local analysis domain with index domain_p
. Provided to the routine is the full observation vector mstate_f
from which the local part has to be extracted.
Hints:
 The vector
mstate_f
that is provided to the routine is one of the observed state vectors that are produced byU_obs_op_f
.  Some operations performed here are analogous to those required to initialize a local vector of observations in
U_init_obs_l
. If that routine reads first a full vector of observations (e.g. inU_init_dim_obs_f
), this vector has to be restricted to the relevant observations for the current local analysis domain. For this operation, one can for example initialize an index array whenU_init_dim_obs_l
is executed. (Which happens beforeU_g2l_obs
)
U_init_obsvar
(init_obsvar_pdaf.F90)
This routine is used by the global filter algorithms SEIK, ETKF, and ESTKF as well as the local filters LSEIK, LETKF, ad LESTKF. The routine is only called if the adaptive forgetting factor is used (type_forget=1
in the example implementation). The difference in this routine between global and local filters is that the global filters use 'global' while the local filters use 'full' quantities.
The interface for this routine is:
SUBROUTINE init_obsvar(step, dim_obs_f, obs_f, meanvar_f) INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: dim_obs_f ! Full dimension of observation vector REAL, INTENT(in) :: obs_f(dim_obs_f) ! Full observation vector REAL, INTENT(out) :: meanvar_f ! Mean observation error variance
The routine is called in the local filters before the loop over all local analysis domains is entered. The call is by the routine that computes an adaptive forgetting factor (PDAF_set_forget
).
The routine has to initialize an average full observation error variance, which should be consistent with the observation vector initialized in U_init_ob_full
.
Hints:
 For a model with domaindecomposition one might use the mean variance for the model subdomain of the calling process. Alternatively one can compute a mean variance for the full model domain using MPI communication (e.g. the function
MPI_allreduce
).  The observation vector
obs_p
is provided to the routine for the case that the observation error variance is relative to the value of the observations.  If the adaptive forgetting factor is not used, this routine has only to exist for the compilation, but it does not need functionality.
U_init_obsvar_l
(init_obsvar_l_pdaf.F90)
This routine is used by all filter algorithms with domainlocalization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm. The routine is only called if the local adaptive forgetting factor is used (type_forget=2
in the example implementation).
The interface for this routine is:
SUBROUTINE init_obsvar_l(domain_p, step, dim_obs_l, obs_l, meanvar_l) INTEGER, INTENT(in) :: domain_p ! Current local analysis domain INTEGER, INTENT(in) :: step ! Current time step INTEGER, INTENT(in) :: dim_obs_l ! Local dimension of observation vector REAL, INTENT(in) :: obs_l(dim_obs_l) ! Local observation vector REAL, INTENT(out) :: meanvar_l ! Mean local observation error variance
The routine is called in the local filters during the loop over all local analysis domains by the routine that computes a local adaptive forgetting factor (PDAF_set_forget_l
). The routine has to initialize a local mean observation error variance for all observations used for the analysis in the current local analysis domain.
Hints:
 If the local adaptive forgetting factor is not used, this routine has only to exist for the compilation, but it does not need functionality.
U_next_observation
(next_observation_pdaf.F90)
This routine is independent of the filter algorithm used. See the page on inserting the analysis step for the description of this routine.
Execution order of usersupplied routines
The usersupplied routines are executed in the order listed below. The order can be important as some routines can perform preparatory work for routines executed later on during the analysis. For example, U_init_dim_obs_local
can prepare an index array that provides the information how to localize a 'full' vector of observations. Some hints one the efficient implementation strategy are given with the descriptions of the routine interfaces above.
Before the analysis step is called the following is executed:
 U_collect_state (called once for each ensemble member)
When the ensemble integration of the forecast is completed, the analysis step is executed. Before the loop over all local analysis domains, the following routines are executed:
 U_prepoststep (Call to act on the forecast ensemble, called with negative value of the time step)
 U_init_n_domains
 U_init_dim_obs_f
 U_obs_op_f (Called
dim_ens
times; once for each ensemble member)  U_init_obs_f (Only executed, if the global adaptive forgetting factor is used (
type_forget=1
in the example implemention))  U_init_obsvar (Only executed, if the global adaptive forgetting factor is used (
type_forget=1
in the example implemention))
In the loop over all local analysis domains, it is executed for each local analysis domain:
 U_init_dim_l
 U_init_dim_obs_l
 U_g2l_state (Called
dim_ens+1
times: Once for each ensemble member and once for the mean state estimate)  U_g2l_obs (A single call to localize the mean observed state)
 U_init_obs_l
 U_g2l_obs (
dim_ens
calls: one call to localize the observed part of each ensemble member)  U_init_obsvar_l (Only called, if the local adaptive forgetting factor is used (
type_forget=2
in the example implementation))  U_prodRinvA_l
 U_l2g_state (Called
dim_ens+1
times: Once for each ensemble member and once for the mean state estimate)
After the loop over all local analysis domains, it is executed:
 U_prepoststep (Call to act on the analysis ensemble, called with (positive) value of the time step)
In case of the routine PDAF_assimilate_lestkf
, the following routines are executed after the analysis step: