Changes between Version 3 and Version 4 of IncrementalAnalysisUpdates

Timestamp:

Aug 21, 2025, 4:59:37 PM (5 months ago)

Author:

lnerger

Comment:

--

IncrementalAnalysisUpdates

@@ -151 +151 @@
  * In Fortran user code one has to declare a pointer like [[BR]]`REAL, POINTER :: iau_ptr(:,:) `[[BR]] and provide this as the first argument. One does not need to allocate this pointer.
 
+
+=== PDAF_iau_set_ens_pointer === 
+
+(This routine is added in the final PDAF V3.0 release, while it's not present in V3.0beta)
+
+This routine is a replacement for `PDAF_iau_set_pointer` clarifying that it relates to the increment ensemble array.
+With this routine the user can set a pointer to the PDAF-internal array of ensemble increments. This provides direct access to the increment array e.g. to analyze it or to write it into a file for restarting. The routine is different from `PDAF_iau_set_inc` in that here the user obtains access to the internal IAU array, while in `PDAF_iau_set_inc` one can only overwrite the internal array.
+
+The routine can be called by each single process, but it only provides a pointer to the process-local part of the increment array. For domain-decomposed models, this array only includes the state vector part for the process domain. In addition, it usually only contains a sub-ensemble unless one uses the flexible parallelization mode with a single model task. For the fully parallel mode, the process(es) of a single model task only hold a single ensemble state.
+
+The interface is:
+{{{
+  SUBROUTINE PDAF_iau_set_ens_pointer(iau_ens_ptr, flag)
+
+    REAL, POINTER, INTENT(out) :: iau_ens_ptr(:,:)  ! Pointer to IAU ensemble array
+    INTEGER, INTENT(out)       :: flag             ! Status flag
+}}}
+
+Hints:
+ * In Fortran user code one has to declare a pointer like [[BR]]`REAL, POINTER :: iau_ens_ptr(:,:) `[[BR]] and provide this as the first argument. One does not need to allocate this pointer.
+
+
+=== PDAF_iau_set_state_pointer === 
+
+(This routine is added in the final PDAF V3.0 release, while it's not present in V3.0beta)
+
+This routine is used in the EnOI modes (subtype 10 and 11) where only the state estimate is integrated. The routine allows the user to set a pointer to the PDAF-internal array of state vector increments. This provides direct access to the increment vector e.g. to analyze it or to write it into a file for restarting. The routine is different from `PDAF_iau_set_inc` in that here the user obtains access to the internal IAU array, while in `PDAF_iau_set_inc` one can only overwrite the internal array.
+
+The routine can be called by each single process, but it only provides a pointer to the process-local part of the increment vector. For domain-decomposed models, this array only includes the state vector part for the process domain. 
+
+The interface is:
+{{{
+  SUBROUTINE PDAF_iau_set_state_pointer(iau_state_ptr, flag)
+
+    REAL, POINTER, INTENT(out) :: iau_state_ptr(:)  ! Pointer to IAU state vector
+    INTEGER, INTENT(out)       :: flag              ! Status flag
+}}}
+
+Hints:
+ * In Fortran user code one has to declare a pointer like [[BR]]`REAL, POINTER :: iau_state_ptr(:) `[[BR]] and provide this as the first argument. One does not need to allocate this pointer.
+
 == Apply the IAU increment ==