Changes between Version 21 and Version 22 of ImplementAnalysislseik

Timestamp:

Sep 3, 2010, 3:12:30 PM (15 years ago)

Author:

lnerger

Comment:

--

ImplementAnalysislseik

@@ -356 +356 @@
 == Execution order of user-supplied routines ==
 
-The user-supplied routines are executed in the following order:
-
- 1 [#U_collect_statecollect_state.F90 U_collect_state]
- 1 [#U_prepoststepprepoststep_seik.F90 U_prepoststep]
- 1 [#U_init_n_domainsinit_n_domains.F90 U_init_n_domains]
- 1 [#U_init_dim_obs_fullinit_dim_obs_full.F90 U_init_dim_obs_full]
- 1 [#U_obs_op_fullobs_op_full.F90 U_obs_op_full]
- 1 [#U_init_obs_fullinit_obs_full.F90 U_init_obs_full]
- 1 [#U_init_obs_localinit_obs_local.F90 U_init_obs_local]
- 1 [#U_prodRinvA_localprodrinva_local.F90 U_prodRinvA_local]
- 1 [#U_init_dim_localinit_dim_local.F90 U_init_dim_local]
- 1 [#U_init_dim_obs_localinit_dim_obs_local.F90 U_init_dim_obs_local]
- 1 [#U_global2local_stateglobal2local_state.F90 U_global2local_state]
- 1 [#U_local2global_statelocal2global_state.F90 U_local2global_state]
- 1 [#U_global2local_obsglobal2local_obs.F90 U_global2local_obs]
- 1 [#U_init_obsvarinit_obsvar.F90 U_init_obsvar]
- 1 [#U_init_obsvar_localinit_obsvar_local.F90 U_init_obsvar_local]
-
-
-
-
+The user-supplied routines are executed in the order listed below. The order can be important as some routines can perform preparatory work for later routines. 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 this are given with the descriptions of the routine interfaces above.
+
+Before the analysis step is called the following is executed:
+ 1. [#U_collect_statecollect_state.F90 U_collect_state]
+
+In the analysis step, before the loop over all local analysis domains, the following routines are executed:
+ 1. [#U_prepoststepprepoststep_seik.F90 U_prepoststep]
+ 1. [#U_init_n_domainsinit_n_domains.F90 U_init_n_domains]
+ 1. [#U_init_dim_obs_fullinit_dim_obs_full.F90 U_init_dim_obs_full]
+ 1. [#U_obs_op_fullobs_op_full.F90 U_obs_op_full]
+ 1. [#U_init_obs_fullinit_obs_full.F90 U_init_obs_full] (Only executed, if the global adaptive forgetting factor is used (`type_forget=1` in the example implemention))
+ 1. [#U_init_obsvarinit_obsvar.F90 U_init_obsvar] (Only execute, if the global adaptive forgetting factor is used (`type_forget=1` in the example implemention))
+
+The the loop over all local analysis domains, it is executed:
+ 1. [#U_init_dim_localinit_dim_local.F90 U_init_dim_local]
+ 1. [#U_init_dim_obs_localinit_dim_obs_local.F90 U_init_dim_obs_local]
+ 1. [#U_global2local_stateglobal2local_state.F90 U_global2local_state]
+ 1. [#U_global2local_obsglobal2local_obs.F90 U_global2local_obs]
+ 1. [#U_init_obs_localinit_obs_local.F90 U_init_obs_local]
+ 1. [#U_global2local_obsglobal2local_obs.F90 U_global2local_obs]
+ 1. [#U_init_obsvar_localinit_obsvar_local.F90 U_init_obsvar_local] (Only, if the local adaptive forgetting factor is used (`type_forget=2` in the example implementation))
+ 1. [#U_prodRinvA_localprodrinva_local.F90 U_prodRinvA_local]
+ 1. [#U_local2global_statelocal2global_state.F90 U_local2global_state]
+
+After the loop over all local analysis domains, it is executed:
+ 1. [#U_prepoststepprepoststep_seik.F90 U_prepoststep]
+
+
+