Changes between Initial Version and Version 1 of PDAF_put_state_lenkf_si

Timestamp:

Dec 8, 2021, 4:15:30 PM (3 years ago)

Author:

lnerger

Comment:

--

PDAF_put_state_lenkf_si

@@ +1 @@
+= PDAF_put_state_lenkf_si = 
+
+This page documents the routine `PDAF_put_state_lenkf_si` of PDAF. 
+
+`PDAF_assimilate_lenkf_si` is the variant of [wiki:PDAF_put_state_lenkf PDAF_put_state_lenkf] with the [PdafSimplifiedInterface simplified interface]. The difference between both routines is that in the simplified interface the names of the call-back subroutines are not specified. Instead the routine assumes that the call-back routines have a standard name as specified at the end of this page.
+
+The routine is typically called in `assimilate_pdaf` or directly in the model code.
+
+The general aspects of the filter specific routines `PDAF_assimilate_*` 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]. The routine is used in the fully-parallel implementation variant of the data assimilation system. When the 'flexible' implementation variant, the routines `PDAF_put_state_*' are used. 
+
+The interface when using the localized EnKF is the following:
+{{{
+  SUBROUTINE PDAF_put_state_lenkf_si(status_pdaf)
+}}}
+with the following arguments:
+ * `status_pdaf`: The integer status flag. It is zero, if `PDAF_put_state_enkf_si` is exited without errors. 
+
+The routine calls several user-supplied call-back routines. They are described on the page on [ImplementAnalysislenkf implementing the analysis step of the localized EnKF].
+
+It is recommended that the value of `status_pdaf` is checked in the program after PDAF_assimilate_lenkf_si is executed. Only if its value is 0 the initialization was successful.