Changes between Version 1 and Version 2 of PDAF_diag_histogram

Timestamp:

Dec 11, 2016, 9:52:00 PM (7 years ago)

Author:

lnerger

Comment:

--

PDAF_diag_histogram

@@ -20 +20 @@
  * `dim` : `integer, intent(in)`[[BR]] Size of state vector
  * `dim_ens` : `integer, intent(in)`[[BR]] Ensemble size
- * `element` : `integer, intent(in)`[[BR]] Element of state vector for which the histogram is computed. If element=0, the histogram is computed over the whole state vector
+ * `element` : `integer, intent(in)`[[BR]] Element of state vector for which the histogram is computed. If `element=0`, the histogram is computed over the whole state vector
  * `state` : `real, intent(in), dimension(dim)`[[BR]] State vector
  * `ens` : `real, intent(in), dimension(dim, dim_ens)`[[BR]] State ensemble
+ * `hist` : `integer, intent(inout), dimension(dim, dim_ens+1)`[[BR]] Histogram about the state
+ * `delta` : `real, intent(out)`[[BR]] Deviation measure from flat histogram
+ * `status` : `integer, intent(out)`[[BR]] Status flag
 
-
+Notes:
+ * The array `hist` has to be allocated and initialized with zeros before the first call to `PDAF_diag_histogram`
+ * The value of `delta` is >0 if the histogram is not flat. However, delta is not bounded and is hence difficult to interpret. 
+ * An example of using `PDAF_diag_histogram` can be found in the Lorenz-96 model example (see testsuite/src/lorenz96/compute_truermse.F90).