Changes between Version 7 and Version 8 of AuxiliaryRoutines

Timestamp:

Dec 21, 2016, 2:09:30 PM (8 years ago)

Author:

lnerger

Comment:

--

AuxiliaryRoutines

@@ -30 +30 @@
 
  * Because `sens_pointer` is a pointer, the call to `PDAF_get_smootherens` needs an ''explicit'' Fortran interface. This is provided by the Fortran module `PDAF_interfaces_module`. In the header part of the routine that calls `PDAF_get_smootherens` one has to include `use PDAF_interfaces_module`!
+ * Using a pointer combined with an intent, i.e. using a pointer as argument, is a feature of Fortran 2003. Thus, if a too old compiler is used, it will provide an error when the routine is compiled.
 
 Notes:
@@ -57 +58 @@
 
  * Because `sens_pointer` is a pointer, the call to `PDAF_set_smootherens` needs an ''explicit'' Fortran interface. This is provided by the Fortran module `PDAF_interfaces_module`. In the header part of the routine that calls `PDAF_set_smootherens` one has to include `use PDAF_interfaces_module`!
+ * Using a pointer combined with an intent, i.e. using a pointer as argument, is a feature of Fortran 2003. Thus, if a too old compiler is used, it will provide an error when the routine is compiled.
 
 
@@ -122 +124 @@
 
 Note:
- * the routine can be used in the prepoststep routine when the analysis state should be analized.
+ * the routine can be used in the prepoststep routine when the analysis state should be analyzed.
 
+
+
+== PDAF-D_set_ens_pointer.F90 ==
+
+This routine allows a program to get a Fortran pointer to the internal ensemble array of PDAF. 
+
+{{{
+CALL PDAF_set_ens_pointer(ens_pointer, status)
+}}}
+
+The arguments are:
+
+ * `ens_pointer`: The pointer to the smoother ensemble. The dimension is `ens_pointer(:,:)`. Thus in the program calling `PDAF_set_ens_pointer` one has to declare `REAL, POINTER :: sens_pointer(:,:)`. On output it points to the ensemble array.
+ * `status`: Status flag. 0 for successful exit.
+
+
+'''Important:'''
+
+ * Because `ens_pointer` is a pointer, the call to `PDAF_set_ens_pointer` needs an ''explicit'' Fortran interface. This is provided by the Fortran module `PDAF_interfaces_module`. In the header part of the routine that calls `PDAF_set_ens_pointer` one has to include `use PDAF_interfaces_module`! 
+ * Using a pointer combined with an intent, i.e. using a pointer as argument, is a feature of Fortran 2003. Thus, if a too old compiler is used, it will provide an error when the routine is compiled.
+
+
+Notes:
+
+ * `PDAF_set_ens_pointer` is a special routine that is never needed when the standard online or offline modes of the implementation are used. However, the routine allows to build a model that uses each column of the ensemble array to store the model fields. Thus, one can avoid allocating additional memory for the model fields. 
+
+