Version 4 (modified by 22 months ago) (diff)  ,

Implementation of the Analysis Step for 3DVar with OMI
Implementation Guide
 Main page
 Adaptation of the parallelization
 Initialization of PDAF
 Modifications for ensemble integration
 Implementation of the analysis step with OMI
 Implementation for Global Filters
 Implementation for Local Filters
 Implementation for LEnKF
 Implementation for 3DVar
 Implementation for 3DEnVar
 Implementation for hybrid 3DVar
 Implementation for LEnKF
 PDAFOMI Overview
 Memory and timing information
 Ensemble Generation
 Diagnostics
Contents of this page
 Overview

PDAFomi_assimilate_3dvar

PDAFomi_put_state_global

Usersupplied routines

U_collect_state
(collect_state_pdaf.F90) 
U_distribute_state
(distribute_state_pdaf.F90) 
U_init_dim_obs_pdafomi
(callback_obs_pdafomi.F90) 
U_obs_op_pdafomi
(callback_obs_pdafomi.F90) 
U_cvt
(cvt_pdaf.F90) 
U_cvt_adj
(cvt_adj_pdaf.F90) 
U_obs_op_lin_pdafomi
(callback_obs_pdafomi.F90) 
U_obs_op_adj_pdafomi
(callback_obs_pdafomi.F90) 
U_prepoststep
(prepoststep_ens_pdaf.F90) 
U_next_observation
(next_observation_pdaf.F90)

 Execution order of usersupplied routines
Overview
With Version 2.0 with introduced 3D variational assimilation methods to PDAF. There are genenerally three different variants: parameterized 3DVar, 3D Ensemble Var, and hybrid (parameterized + ensemble) 3DVar.
This page describes the implementation of the analysis step for the parameterized 3DVar using PDAFOMI.
For the analysis step of 3DVar we need different operations related to the observations. These operations are requested by PDAF by callback routines supplied by the user and provided in the OMI structure. The names of the routines that are provided by the user are specified in the call to the routine PDAFomi_assimilate_3dvar
in the fullyparallel implementation (or PDAFomi_put_state_3dvar
for the 'flexible' implementation) that was discussed before. 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 PDAFomi_assimilate_3dvar
. Thus, some of the usersupplied routines that are explained on the page describing the modification of the model code for the ensemble integration are repeated here.
PDAFomi_assimilate_3dvar
The general aspects of the filter (or solver) specific 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. Here, we list the full interface of the routine. Subsequently, the usersupplied routines specified in the call is explained.
The interface for using the parameterized 3DVar is:
SUBROUTINE PDAFomi_assimilate_3dvar(collect_state_pdaf, distribute_state_pdaf, & U_init_dim_obs_pdafomi, U_obs_op_pdafomi, & U_cvt, U_cvt_adj, U_obs_op_lin_pdafomi, obs_op_adj_pdafomi, & prepoststep_pdaf, next_observation_pdaf, outflag)
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 inPDAF_get_state
as well as 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_pdafomi: The name of the usersupplied routine that initializes the observation information and provides the size of observation vector
 [U_cvt]: The name of the usersupplied routine that applies the controlvector transformation (squareroot of the Bmatrix) on some control vector to obtain a state vector.
 [U_cvt_adj]: The name of the usersupplied routine that applies the adjoint controlvector transformation (with squareroot of the Bmatrix) on some state vector to obtain the control vector.
 U_obs_op_pdafomi: The name of the usersupplied routine that acts as the observation operator on some state vector
 U_obs_op_lin_pdafomi: The name of the usersupplied routine that acts as the linearized observation operator on some state vector
 U_obs_op_lin_pdafomi: The name of the usersupplied routine that acts as the adjoint observation operator on some state vector
 U_prepoststep: The name of the pre/poststep routine as in
PDAF_get_state
 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, ifPDAFomi_assimilate_global
is exited without errors.
PDAFomi_put_state_global
When the 'flexible' implementation variant is chosen for the assimilation system, the routine PDAFomi_put_state_global
has to be used instead of PDAFomi_assimilate_global
. 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_global
with the exception the specification of the usersupplied routines U_distribute_state
and U_next_observation
are missing.
The interface when using one of the global filters is the following:
SUBROUTINE PDAFomi_assimilate_3dvar(collect_state_pdaf, & U_init_dim_obs_pdafomi, U_obs_op_pdafomi, & U_cvt, U_cvt_adj, U_obs_op_lin_pdafomi, obs_op_adj_pdafomi, & prepoststep_pdaf, outflag)
Usersupplied routines
Here all usersupplied 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 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 tutorial implementations in tutorial/
these routines exist without the prefix, but with the extension _pdaf.F90
. The userroutines 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.
In the subroutine interfaces some variables appear with the suffix _p
. 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.
U_collect_state
(collect_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_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_pdafomi
(callback_obs_pdafomi.F90)
This is a callback routine for PDAFOMI initializing the observation information. The routine just calls a routine from the observation module for each observation type.
See the documentation on callback_obs_pdafomi.F90 for more information.
U_obs_op_pdafomi
(callback_obs_pdafomi.F90)
This is a callback routine for PDAFOMI applying the observation operator to the state vector. The routine calls a routine from the observation module for each observation type.
See the documentation on callback_obs_pdafomi.F90 for more information.
U_cvt
(cvt_pdaf.F90)
The interface for this routine is:
SUBROUTINE cvt_pdaf(iter, dim_p, dim_cvec, cv_p, Vv_p) INTEGER, INTENT(in) :: iter ! Iteration of optimization INTEGER, INTENT(in) :: dim_p ! PElocal observation dimension INTEGER, INTENT(in) :: dim_cvec ! Dimension of control vector REAL, INTENT(in) :: cv_p(dim_cvec) ! PElocal control vector REAL, INTENT(inout) :: Vv_p(dim_p) ! PElocal result vector (state vector increment)
The routine is called during the analysis step during the iterative minimization of the cost function. It has to apply the control vector transformation to the control vector and return the transformed result vector. Usually this transformation is the multiplication with the squareroot of the background error covariance matrix B.
If the control vector is decomposed in case of parallelization it first needs to the gathered on each processor and afterwards the transformation is computed on the potentially domaindecomposed state vector.
U_cvt_adj
(cvt_adj_pdaf.F90)
The interface for this routine is:
SUBROUTINE cvt_adj_pdaf(iter, dim_p, dim_cvec, Vv_p, cv_p) INTEGER, INTENT(in) :: iter ! Iteration of optimization INTEGER, INTENT(in) :: dim_p ! PElocal observation dimension INTEGER, INTENT(in) :: dim_cvec ! Dimension of control vector REAL, INTENT(in) :: Vv_p(dim_p) ! PElocal result vector (state vector increment) REAL, INTENT(inout) :: cv_p(dim_cvec) ! PElocal control vector
The routine is called during the analysis step during the iterative minimization of the cost function. It has to apply the adjoint control vector transformation to a state vector and return the control vector. Usually this transformation is the multiplication with transposed of the squareroot of the background error covariance matrix B.
If the state vector is decomposed in case of parallelization one needs to take care that the application of the trasformation is complete. This usually requries a comminucation with MPI_Allreduce to obtain a global sun.
U_obs_op_lin_pdafomi
(callback_obs_pdafomi.F90)
This is a callback routine for PDAFOMI 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.
See the documentation on callback_obs_pdafomi.F90 for more information.
U_obs_op_adj_pdafomi
(callback_obs_pdafomi.F90)
This is a callback routine for PDAFOMI applying the adjoint observation operator to some vector inthe observation space. The routine calls a routine from the observation module for each observation type.
See the documentation on callback_obs_pdafomi.F90 for more information.
U_prepoststep
(prepoststep_ens_pdaf.F90)
The routine has already been described for modifying the model for the ensemble integration and for inserting the analysis step.
See the page on inserting the analysis step for the description of this routine.
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 essentially executed in the order they are listed in the interface to PDAFomi_assimilate_global
. The order can be important as some routines can perform preparatory work for later routines. For example, U_init_dim_obs_pdafomi
prepares an index array that provides the information for executing the observation operator in U_obs_op_pdafomi
. How this information is initialized is described in the documentation of OMI.
Before the analysis step is called the following routine is executed:
The analysis step is executed when the ensemble integration of the forecast is completed. During the analysis step the following routines are executed in the given order:
 U_prepoststep (Call to act on the forecast ensemble, called with negative value of the time step)
 U_init_dim_obs_pdafomi
 U_obs_op_pdafomi (multiple calls, one for each ensemble member)
 U_prepoststep (Call to act on the analysis ensemble, called with (positive) value of the time step)
In case of the routine PDAFomi_assimilate_global
, the following routines are executed after the analysis step: