Changes between Initial Version and Version 1 of PDAFomi_put_state_local_si

Timestamp:

Dec 8, 2021, 5:00:00 PM (3 years ago)

Author:

lnerger

Comment:

--

PDAFomi_put_state_local_si

@@ +1 @@
+= PDAFomi_put_state_local_si = 
+
+This page documents the routine `PDAFomi_put_state_local_si` of PDAF. 
+
+The routine is typically called in `assimilate_pdaf` or directly in the model code.
+
+`PDAFomi_put_state_local_si` is the variant of [wiki:PDAFomi_put_state_local PDAFomi_put_state_local] 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.
+
+This routine is used with [wiki:PDAF_OMI_Overview PDAF-OMI] to execute the [ImplementAnalysisLocal analysis step with domain-localized filters]. The routine is used in the flexible' implementation variant. In the 'fully-parallel' implementation variant of the data assimilation system the routines [wiki:PDAFomi_assimilate_local_si PDAFomi_assimilate_local_si] or [wiki:PDAFomi_assimilate_local PDAFomi_assimilate_local] are used. 
+
+The interface is the following:
+{{{
+  SUBROUTINE PDAFomi_put_state_local_si(status_pdaf)
+}}}
+with the following arguments:
+ * `status_pdaf`: The integer status flag. It is zero, if `PDAFomi_put_state_local_si` is exited without errors.
+
+The routine calls several user-supplied call-back routines. They are described on the page on [ImplementAnalysisLocal implementing the analysis step of the local filter algorithms].
+
+It is recommended that the value of `status_pdaf` is checked in the program after PDAFomi_put_state_local is executed. Only if its value is 0 the initialization was successful.