Changes between Initial Version and Version 1 of PDAF_put_state_en3dvar_estkf


Ignore:
Timestamp:
Dec 9, 2021, 2:22:19 PM (3 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF_put_state_en3dvar_estkf

    v1 v1  
     1= PDAF_put_state_en3dvar_estkf =
     2
     3This page documents the routine `PDAF_put_state_en3dvar_estkf` of PDAF.
     4
     5The routine is typically called in `assimilate_pdaf` or directly in the model code.
     6
     7The routines `PDAF_put_state_*` are used with the 'flexible' implementation variant of PDAF.
     8The general aspects of the filter specific routines `PDAF_put_state_*` are described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] and its sub-page on [InsertAnalysisStep inserting the analysis step]. For the 'fully parallel' implementation variant the alternative routines `PDAF_assimilate_*` are used.
     9
     10
     11The interface is:
     12{{{
     13SUBROUTINE PDAF_put_state_en3dvar_estkf(U_collect_state, &
     14                                 U_init_dim_obs, U_obs_op, U_init_obs, U_prodRinvA, &
     15                                 U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin, U_obs_op_adj, &
     16                                 U_init_obsvar, U_prepoststep, outflag)
     17}}}
     18with the following arguments:
     19 * [#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 `PDAF_get_state` as well as here.
     20 * [#U_init_dim_obsinit_dim_obs_pdaf.F90 U_init_dim_obs]: The name of the user-supplied routine that provides the size of observation vector
     21 * [#U_obs_opobs_op_pdaf.F90 U_obs_op]: The name of the user-supplied routine that acts as the observation operator on some state vector
     22 * [#U_init_obsinit_obs_pdaf.F90 U_init_obs]: The name of the user-supplied routine that initializes the vector of observations
     23 * [#U_prodRinvAprodrinva_pdaf.F90 U_prodRinvA]: The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF. This operation occurs during the analysis step of the ETKF.
     24 * [#U_cvt_enscvt_ens_pdaf.F90 U_cvt_ens]: The name of the user-supplied routine that applies the ensemble control-vector transformation (square-root of the B-matrix) on some control vector to obtain a state vector.
     25 * [#U_cvt_adj_enscvt_adj_ens_pdaf.F90 U_cvt_adj_ens]: The name of the user-supplied routine that applies the adjoint ensemble control-vector transformation (with square-root of the B-matrix) on some state vector to obtain the control vector.
     26 * [#U_obs_op_linobs_op_lin_pdaf.F90 U_obs_op_lin]: The name of the user-supplied routine that acts as the linearized observation operator on some state vector
     27 * [#U_obs_op_adjobs_op_adj_pdaf.F90 U_obs_op_adj]: The name of the user-supplied routine that acts as the adjoint observation operator on some state vector
     28 * [#U_init_obsvarinit_obsvar_pdaf.F90 U_init_obsvar]: The name of the user-supplied routine that provides a mean observation error variance to PDAF (This routine will only be executed, if an adaptive forgetting factor is used)
     29 * [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep]: The name of the pre/poststep routine as in `PDAF_get_state`
     30 * `status`: The integer status flag. It is zero, if the routine is exited without errors.
     31
     32The user-supplied call-back routines are described on the page on [ImplementAnalysis_3DEnVar_classical implementing the analysis step of 3D Ensemble Var].
     33
     34It is recommended that the value of `status_pdaf` is checked in the program after the routine is executed. Only if its value is 0 the initialization was successful.
     35