Changes between Version 1 and Version 2 of PDAFomi_diag_get_HX


Ignore:
Timestamp:
Mar 26, 2025, 4:37:35 PM (7 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAFomi_diag_get_HX

    v1 v2  
    11= PDAFomi_diag_get_HX =
    22
    3 This page documents the routine `PDAFomi_diag_get_HX` of PDAF, which was introduced with PDAF V3.0. This is part of the PDAF-OMI observation diagnostics module.
     3This page documents the routine `PDAFomi_diag_get_HX` of PDAF, which was introduced with PDAF V3.0. This is part of the [wiki:PDAFomi_observation_diagnostics PDAF-OMI observation diagnostics module].
    44
    5 The routine returns a pointer to the array of the observed ensemble for the specified observation type (`id_obs`)..
     5The routine returns a pointer to the array of the observed ensemble for the specified observation type (`id_obs`).
    66
    77Usually all PDAFomi_diag routines are called in `prepoststep_pdaf` where the observation information can be retrieved and analyzed.
    88
    9 The interface is the following:
     9The interface is:
    1010{{{
    1111  SUBROUTINE PDAFomi_diag_get_HX(id_obs, dim_obs_p_diag, HX_p_ptr)
    12 }}}
    13 with the following arguments:
    14 {{{
    15     INTEGER, INTENT(in) :: id_obs                    !< Index of observation type to return
    16     INTEGER, INTENT(out) :: dim_obs_p_diag           !< Observation dimension
    17     REAL, POINTER, INTENT(out) :: HX_p_ptr(:,:)      !< Pointer to observed ensemble mean
     12
     13    INTEGER, INTENT(in)  :: id_obs                   ! Index of observation type to return
     14    INTEGER, INTENT(out) :: dim_obs_p_diag           ! Observation dimension
     15    REAL, POINTER, INTENT(out) :: HX_p_ptr(:,:)      ! Pointer to observed ensemble mean
    1816}}}
    1917
    2018**Notes:**
    21  * In case of a parallelized model, the array HX_p_prt contains the observed ensemble for the process-sub-domain
    22  * In Fortran user code the obsevation pointer should be declared in the form[[BR]] `REAL, POINTER :: HX_p_ptr(:,:)`[[BR]] It does not need to be allocated. The target array has the size `(dim_obs_p_diag, dim_ens)`
    23  * If the observation diagnostics have not be activated by using [wiki:PDAFomi_set_obs_diag] the pointer will not be set and `dim_obs_diag=0` will be returned. This value can be checked before assessing the pointer array
     19 * In case of a parallelized model, the array `HX_p_prt` contains the observed ensemble for the process-sub-domain
     20 * In Fortran user code the pointer to the observed ensemble should be declared in the form[[BR]] `REAL, POINTER :: HX_p_ptr(:,:)`[[BR]] It does not need to be allocated. The target array has the size `(dim_obs_p_diag, dim_ens)`
     21 * If the observation diagnostics have not be activated by using [wiki:PDAFomi_set_obs_diag] the pointer will not be set and `dim_obs_diag=0` will be returned. This value can be checked before assessing the pointer array.
    2422
    2523