Changes between Version 4 and Version 5 of PDAF_localfilter

Timestamp:

Mar 24, 2025, 9:50:07 AM (8 days ago)

Author:

lnerger

Comment:

--

PDAF_localfilter

@@ -1 +1 @@
 = PDAF_localfilter = 
 
-This page documents the function `PDAF_localfilter` of PDAF, which are introduced with PDAF 3.0.
+This page documents the function `PDAF_localfilter` of PDAF, which was introduced with PDAF 3.0.
 
-The function is an altenative to the routine [wiki:PDAF_get_localfilter]. Here the values is the return value of the function, while for `PDAF_get_localfilter` the return value is an argument of the routine.
+The function is an alternative to the subroutine [wiki:PDAF_get_localfilter]. In `PDAF_localfilter` the return value of the function is directly used, while for `PDAF_get_localfilter` the return value is an argument of the routine.
 
-The function returns the information whether the chosen filter is a domain-localized filter (LESTKF, LETKF, LSEIK, LNETF). It can be called in assimilate_pdaf.F90 to control whether to call either PDAF3_assimilate_global or PDAF3_assimilate_local (or PDAF3_put_state_global or PDAF3_put_state_local).
+The function returns the information whether the chosen filter is a domain-localized filter (LESTKF, LETKF, LSEIK, LNETF). It also indicates the ENSRF since these filters use the same observation handling of the domain-localized filters. The function can be called in `assimilate_pdaf` to control whether to call either PDAF3_assimilate_global or PDAF3_assimilate_local (or PDAF3_put_state_global or PDAF3_put_state_local).
+The function can only be used if PDAF was initialized before by a call to `PDAF_init`.
 
-The routine is typically called in the model code in assimilate_pdaf. The function can only be used if PDAF was initialized before by a call to `PDAF_init`.
-
-The interface is the following:
+The interface is:
 {{{
   INTEGER FUNCTION PDAF_localfilter()