PDAF_iau_set_pointer

This page documents the routine PDAF_iau_set_pointer of PDAF, which was introduced with PDAF V3.0.

With this routine the user can set a pointer to the PDAF-internal array of ensemble increments. This gives direct access to the increment array e.g. to analyze it or to write it into a file for restarting.

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 include the state vector part for the process domain. In addition, it usually only contains a sub-ensemlbe 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 the following:

  SUBROUTINE PDAF_iau_set_pointer(iau_ptr, flag)

with the following arguments:

    REAL, POINTER, INTENT(out) :: iau_ptr(:,:)  !< Pointer to IAU ensemble array
    INTEGER, INTENT(out)       :: flag          !< Status flag

Hints:

• In Fortran user code one has to declare
  REAL, POINTER :: iau_ptr(:,:)
  and provide this as the first argument. One does not need to allocate this pointer.