Changes between Version 3 and Version 4 of PDAF_diag_compute_moments


Ignore:
Timestamp:
Mar 26, 2025, 2:58:34 PM (8 months ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF_diag_compute_moments

    v3 v4  
    33This page documents the routine `PDAF_diag_compute_moments` of PDAF, which was introduced with PDAF V3.0.
    44
    5 This routine computes the mean, the unbiased variance, the unbiased skewness, and the unbiased excess kurtosis from an ensemble. All moments are stored in a single array. `kmax` controls the highest order that should be computed.
     5This routine computes the mean, the unbiased variance, the unbiased skewness, and the unbiased excess kurtosis from an ensemble. All moments are stored in a single array. `kmax` controls the highest order that should be computed. With parallized models, the moments are computed for the process-local state.
    66
    77The routine can be called in the pre/poststep routine of PDAF both before and after the analysis step to compute the ensemble statistics.
    … …  
    1010{{{
    1111SUBROUTINE PDAF_diag_compute_moments(dim_p, dim_ens, ens, kmax, moments, bias)
     12
     13  INTEGER, INTENT(IN) :: dim_p              ! Local size of the state vector
     14  INTEGER, INTENT(IN) :: dim_ens            ! Number of ensemble members/samples
     15  REAL, INTENT(IN) :: ens(dim_p,dim_ens)    ! Ensemble matrix
     16  INTEGER, INTENT(IN) :: kmax               ! Highest order of statistical moment (1-4)
     17  REAL, INTENT(OUT) :: moments(dim_p, kmax) ! The statistical moments up to order `kmax` with
     18                                            !  - column 1: mean
     19                                            !  - column 2: variance
     20                                            !  - column 3: skewness
     21                                            !  - column 4: excess kurtosis
     22  INTEGER, OPTIONAL, INTENT(IN) :: bias     !< 0 to compute bias corrected values (default)
    1223}}}
    13 
    14 with the following arguments:
    15 
    16 -  `dim_p` : INTEGER, INTENT(IN) [[BR]] Size of the state vector
    17 
    18 -  `dim_ens` : INTEGER, INTENT(IN) [[BR]] Ensemble size
    19 
    20 -  `ens` : REAL, DIMENSION(dim_p,dim_ens), INTENT(IN)[[BR]] Ensemble matrix
    21 
    22 -  `kmax` : INTEGER, INTENT(IN) [[BR]] Highest order of statistical moment (1-4)
    23 
    24 -  `moments` : REAL, DIMENSION(dim_p,kmax), INTENT(OUT) [[BR]] The statistical moments up to order `kmax` with
    25   - column 1: mean
    26   - column 2: variance
    27   - column 3: skewness
    28   - colmnu 4: excess kurtosis
    29 
    30 - `bias` : INTEGER, OPTIONAL, INTENT(IN) [[BR]] If 0 bias-corrected values are computed (default)
    3124
    3225