eltinv_mod.F90 Source File


This file depends on

sourcefile~~eltinv_mod.f90~~EfferentGraph sourcefile~eltinv_mod.f90 eltinv_mod.F90 sourcefile~abort_trans_mod.f90 abort_trans_mod.F90 sourcefile~eltinv_mod.f90->sourcefile~abort_trans_mod.f90 sourcefile~buffered_allocator_mod.f90 buffered_allocator_mod.F90 sourcefile~eltinv_mod.f90->sourcefile~buffered_allocator_mod.f90 sourcefile~easre1b_mod.f90 easre1b_mod.F90 sourcefile~eltinv_mod.f90->sourcefile~easre1b_mod.f90 sourcefile~eleinv_mod.f90 eleinv_mod.F90 sourcefile~eltinv_mod.f90->sourcefile~eleinv_mod.f90 sourcefile~eprfi1b_mod.f90 eprfi1b_mod.F90 sourcefile~eltinv_mod.f90->sourcefile~eprfi1b_mod.f90 sourcefile~espnsde_mod.f90 espnsde_mod.F90 sourcefile~eltinv_mod.f90->sourcefile~espnsde_mod.f90 sourcefile~evdtuv_mod.f90 evdtuv_mod.F90 sourcefile~eltinv_mod.f90->sourcefile~evdtuv_mod.f90 sourcefile~parkind_ectrans.f90 parkind_ectrans.F90 sourcefile~eltinv_mod.f90->sourcefile~parkind_ectrans.f90 sourcefile~tpm_dim.f90 tpm_dim.F90 sourcefile~eltinv_mod.f90->sourcefile~tpm_dim.f90 sourcefile~tpm_distr.f90 tpm_distr.F90 sourcefile~eltinv_mod.f90->sourcefile~tpm_distr.f90 sourcefile~tpm_trans.f90 tpm_trans.F90 sourcefile~eltinv_mod.f90->sourcefile~tpm_trans.f90 sourcefile~tpmald_dim.f90 tpmald_dim.F90 sourcefile~eltinv_mod.f90->sourcefile~tpmald_dim.f90 sourcefile~tpm_gen.f90 tpm_gen.F90 sourcefile~abort_trans_mod.f90->sourcefile~tpm_gen.f90 sourcefile~buffered_allocator_mod.f90->sourcefile~abort_trans_mod.f90 sourcefile~growing_allocator_mod.f90 growing_allocator_mod.F90 sourcefile~buffered_allocator_mod.f90->sourcefile~growing_allocator_mod.f90 sourcefile~easre1b_mod.f90->sourcefile~tpm_dim.f90 sourcefile~easre1b_mod.f90->sourcefile~tpm_distr.f90 sourcefile~easre1b_mod.f90->sourcefile~tpm_trans.f90 sourcefile~easre1b_mod.f90->sourcefile~tpmald_dim.f90 sourcefile~eleinv_mod.f90->sourcefile~abort_trans_mod.f90 sourcefile~eleinv_mod.f90->sourcefile~buffered_allocator_mod.f90 sourcefile~eleinv_mod.f90->sourcefile~tpm_dim.f90 sourcefile~eleinv_mod.f90->sourcefile~tpm_distr.f90 sourcefile~eleinv_mod.f90->sourcefile~tpmald_dim.f90 sourcefile~eleinv_mod.f90->sourcefile~tpm_gen.f90 sourcefile~tpm_hicfft.f90 tpm_hicfft.F90 sourcefile~eleinv_mod.f90->sourcefile~tpm_hicfft.f90 sourcefile~eprfi1b_mod.f90->sourcefile~tpm_distr.f90 sourcefile~tpmald_distr.f90 tpmald_distr.F90 sourcefile~eprfi1b_mod.f90->sourcefile~tpmald_distr.f90 sourcefile~espnsde_mod.f90->sourcefile~tpmald_distr.f90 sourcefile~tpmald_geo.f90 tpmald_geo.F90 sourcefile~espnsde_mod.f90->sourcefile~tpmald_geo.f90 sourcefile~evdtuv_mod.f90->sourcefile~abort_trans_mod.f90 sourcefile~evdtuv_mod.f90->sourcefile~tpm_distr.f90 sourcefile~evdtuv_mod.f90->sourcefile~tpmald_distr.f90 sourcefile~tpmald_fields.f90 tpmald_fields.F90 sourcefile~evdtuv_mod.f90->sourcefile~tpmald_fields.f90 sourcefile~evdtuv_mod.f90->sourcefile~tpmald_geo.f90 sourcefile~growing_allocator_mod.f90->sourcefile~abort_trans_mod.f90 sourcefile~growing_allocator_mod.f90->sourcefile~tpm_gen.f90 sourcefile~tpm_hicfft.f90->sourcefile~growing_allocator_mod.f90

Files dependent on this one

sourcefile~~eltinv_mod.f90~~AfferentGraph sourcefile~eltinv_mod.f90 eltinv_mod.F90 sourcefile~einv_trans_ctl_mod.f90 einv_trans_ctl_mod.F90 sourcefile~einv_trans_ctl_mod.f90->sourcefile~eltinv_mod.f90 sourcefile~eltinv_ctl_mod.f90 eltinv_ctl_mod.F90 sourcefile~eltinv_ctl_mod.f90->sourcefile~eltinv_mod.f90 sourcefile~einv_trans.f90 einv_trans.F90 sourcefile~einv_trans.f90->sourcefile~einv_trans_ctl_mod.f90 sourcefile~einv_trans.f90~2 einv_trans.F90 sourcefile~einv_trans.f90~2->sourcefile~einv_trans_ctl_mod.f90 sourcefile~einv_trans_ctl_mod.f90~2 einv_trans_ctl_mod.F90 sourcefile~einv_trans_ctl_mod.f90~2->sourcefile~eltinv_ctl_mod.f90

Source Code

#define ALIGN(I, A) (((I)+(A)-1)/(A)*(A))
MODULE ELTINV_MOD
  USE BUFFERED_ALLOCATOR_MOD

  IMPLICIT NONE

  PRIVATE
  PUBLIC :: ELTINV, ELTINV_HANDLE, PREPARE_ELTINV

  TYPE ELTINV_HANDLE
    TYPE(ALLOCATION_RESERVATION_HANDLE) :: HFFT
    TYPE(ALLOCATION_RESERVATION_HANDLE) :: HFFT_OUT
    TYPE(ALLOCATION_RESERVATION_HANDLE) :: HFOUBUF_IN
    !TYPE(ALLOCATION_RESERVATION_HANDLE) :: HFOUBUF
  END TYPE

CONTAINS
  FUNCTION PREPARE_ELTINV(ALLOCATOR,KF_UV,KF_SCALARS,KF_SCDERS,KF_OUT_LT) RESULT(HELTINV)
    USE PARKIND_ECTRANS, ONLY: JPIM, JPRBT, JPRD
    USE TPM_DISTR, ONLY: D
    USE TPM_DIM, ONLY: R
    USE TPMALD_DIM      ,ONLY : RALD
    USE ISO_C_BINDING

    IMPLICIT NONE

    TYPE(BUFFERED_ALLOCATOR), INTENT(INOUT) :: ALLOCATOR
    INTEGER(KIND=JPIM), INTENT(IN) ::KF_UV,KF_SCALARS,KF_SCDERS,KF_OUT_LT

    TYPE(ELTINV_HANDLE) :: HELTINV

    INTEGER(KIND=C_SIZE_T) :: IALLOC_SZ
    REAL(KIND=JPRBT) :: ZPRBT_DUMMY
    
    ! ZFFT    
    IALLOC_SZ = ALIGN((RALD%NDGLSUR+R%NNOEXTZG)*D%NUMP*(8*KF_UV + 2*KF_SCALARS + 2*KF_SCDERS)*SIZEOF(ZPRBT_DUMMY), 128)
    HELTINV%HFFT = RESERVE(ALLOCATOR, IALLOC_SZ)
    
#ifndef IN_PLACE_FFT
    ! ZFFT    
    IALLOC_SZ = ALIGN((RALD%NDGLSUR+R%NNOEXTZG)*D%NUMP*(8*KF_UV + 2*KF_SCALARS + 2*KF_SCDERS)*SIZEOF(ZPRBT_DUMMY), 128)
    HELTINV%HFFT_OUT = RESERVE(ALLOCATOR, IALLOC_SZ)
#endif

    ! FOUBUF_IN
    IALLOC_SZ = D%NLENGT1B*2*KF_OUT_LT*SIZEOF(ZPRBT_DUMMY)
    HELTINV%HFOUBUF_IN = RESERVE(ALLOCATOR, IALLOC_SZ)
    
  END FUNCTION PREPARE_ELTINV

SUBROUTINE ELTINV(ALLOCATOR,HELTINV,KF_OUT_LT,KF_UV,KF_SCALARS,KF_SCDERS,KLEI2,KDIM1,FOUBUF_IN,&
 & PSPVOR,PSPDIV,PSPSCALAR,&
 & PSPSC3A,PSPSC3B,PSPSC2 , &
 & KFLDPTRUV,KFLDPTRSC,FSPGL_PROC,PSPMEANU,PSPMEANV)

USE ISO_C_BINDING

USE PARKIND1  ,ONLY : JPIM     ,JPRB
USE YOMHOOK   ,ONLY : LHOOK,   DR_HOOK, JPHOOK

USE TPM_DIM         ,ONLY : R
USE TPM_DISTR         ,ONLY : D
USE TPM_TRANS       ,ONLY : LDIVGP, LVORGP, NF_SC2, NF_SC3A, NF_SC3B
USE TPMALD_DIM      ,ONLY : RALD
USE EPRFI1B_MOD     ,ONLY : EPRFI1B
USE EVDTUV_MOD      ,ONLY : EVDTUV
USE ESPNSDE_MOD     ,ONLY : ESPNSDE
USE ELEINV_MOD      ,ONLY : ELEINV
USE EASRE1B_MOD     ,ONLY : EASRE1B
!!! FIXME !!! USE FSPGL_INT_MOD   ,ONLY : FSPGL_INT
USE ABORT_TRANS_MOD ,ONLY : ABORT_TRANS

!**** *LTINV* - Inverse Legendre transform

!     Purpose.
!     --------
!        Tranform from Laplace space to Fourier space, compute U and V
!        and north/south derivatives of state variables.

!**   Interface.
!     ----------
!        *CALL* *LTINV(...)

!        Explicit arguments :
!        --------------------
!          KM        - zonal wavenumber
!          KMLOC     - local zonal wavenumber
!          PSPVOR    - spectral vorticity
!          PSPDIV    - spectral divergence
!          PSPSCALAR - spectral scalar variables

!        Implicit arguments :  The Laplace arrays of the model.
!        --------------------  The values of the Legendre polynomials
!                              The grid point arrays of the model
!     Method.
!     -------

!     Externals.
!     ----------

!         PREPSNM - prepare REPSNM for wavenumber KM
!         PRFI1B  - prepares the spectral fields
!         VDTUV   - compute u and v from vorticity and divergence
!         SPNSDE  - compute north-south derivatives
!         LEINV   - Inverse Legendre transform
!         ASRE1   - recombination of symmetric/antisymmetric part

!     Reference.
!     ----------
!        ECMWF Research Department documentation of the IFS
!        Temperton, 1991, MWR 119 p1303

!     Author.
!     -------
!        Mats Hamrud  *ECMWF*

!     Modifications.
!     --------------
!        Original : 00-02-01 From LTINV in IFS CY22R1
!        M.Hamrud      01-Oct-2003 CY28 Cleaning
!        D. Degrauwe  (Feb 2012): Alternative extension zone (E')
!        R. El Khatib 26-Aug-2021 Optimization for EASRE1B
!     ------------------------------------------------------------------

IMPLICIT NONE

TYPE(BUFFERED_ALLOCATOR), INTENT(IN) :: ALLOCATOR
TYPE(ELTINV_HANDLE), INTENT(IN) :: HELTINV
INTEGER(KIND=JPIM), INTENT(IN) :: KF_OUT_LT
INTEGER(KIND=JPIM), INTENT(IN) :: KF_UV
INTEGER(KIND=JPIM), INTENT(IN) :: KF_SCALARS
INTEGER(KIND=JPIM), INTENT(IN) :: KF_SCDERS
INTEGER(KIND=JPIM), INTENT(IN) :: KLEI2
INTEGER(KIND=JPIM), INTENT(IN) :: KDIM1
REAL(KIND=JPRB), INTENT(OUT), POINTER ::  FOUBUF_IN(:)

REAL(KIND=JPRB)   ,OPTIONAL,INTENT(IN)  :: PSPVOR(:,:)
REAL(KIND=JPRB)   ,OPTIONAL,INTENT(IN)  :: PSPDIV(:,:)
REAL(KIND=JPRB)   ,OPTIONAL,INTENT(IN)  :: PSPSCALAR(:,:)
REAL(KIND=JPRB)   ,OPTIONAL,INTENT(IN)  :: PSPSC2(:,:)
REAL(KIND=JPRB)   ,OPTIONAL,INTENT(IN)  :: PSPSC3A(:,:,:)
REAL(KIND=JPRB)   ,OPTIONAL,INTENT(IN)  :: PSPSC3B(:,:,:)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(IN)  :: KFLDPTRUV(:)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(IN)  :: KFLDPTRSC(:)
REAL(KIND=JPRB)   ,OPTIONAL, INTENT(IN) :: PSPMEANU(:)
REAL(KIND=JPRB)   ,OPTIONAL, INTENT(IN) :: PSPMEANV(:)
EXTERNAL  FSPGL_PROC
OPTIONAL  FSPGL_PROC

REAL(KIND=JPRB), POINTER ::  ZFFT_L(:), ZFFT(:,:,:),  ZFFT_L_OUT(:), ZFFT_OUT(:,:,:)
INTEGER(KIND=JPIM) :: IFC, ISTA
INTEGER(KIND=JPIM) :: IVORL,IVORU,IDIVL,IDIVU,IUL,IUU,IVL,IVU,ISL,ISU,IDL,IDU
INTEGER(KIND=JPIM) :: IFIRST, ILAST,IDIM1,IDIM3,J3
INTEGER(KIND=C_SIZE_T) :: IALLOC_SZ
REAL(KIND=JPHOOK) :: ZHOOK_HANDLE



!     ------------------------------------------------------------------

!*       3.    SPECTRAL COMPUTATIONS FOR U,V AND DERIVATIVES.
!              ----------------------------------------------

IF (LHOOK) CALL DR_HOOK('ELTINV_MOD:ELTINV',0,ZHOOK_HANDLE)

! ZFFT
IALLOC_SZ = ALIGN((RALD%NDGLSUR+R%NNOEXTZG)*D%NUMP*KLEI2*SIZEOF(ZFFT_L(1)), 128)
CALL ASSIGN_PTR(ZFFT_L, GET_ALLOCATION(ALLOCATOR, HELTINV%HFFT),&
    & 1_JPIB, IALLOC_SZ)
CALL C_F_POINTER(C_LOC(ZFFT_L), ZFFT, (/ RALD%NDGLSUR+R%NNOEXTZG,D%NUMP,KLEI2 /))

#ifdef OMPGPU
#endif
#ifdef ACCGPU
    !$ACC DATA COPYIN(PSPVOR,PSPDIV) IF(KF_UV > 0)
    !$ACC DATA COPYIN(PSPSCALAR) IF(PRESENT(PSPSCALAR) .AND. KF_SCALARS > 0)
    !$ACC DATA COPYIN(PSPSC2) IF(PRESENT(PSPSC2))
    !$ACC DATA COPYIN(PSPSC3A) IF(PRESENT(PSPSC3A))
    !$ACC DATA COPYIN(PSPSC3B) IF(PRESENT(PSPSC3B))
    !$ACC DATA COPYIN(PSPMEANU) IF(KF_UV > 0)
    !$ACC DATA COPYIN(PSPMEANV) IF(KF_UV > 0)
#endif

IFIRST = 1
ILAST  = 4*KF_UV

! TODO: this zero-initialization is needed, but could be moved more efficiently inside EPRFI1B/EVDTUV/ESPNSDE
!$acc kernels present (ZFFT)
ZFFT = 0.0_JPRB
!$acc end kernels

IF (KF_UV > 0) THEN
  IVORL = 1
  IVORU = 2*KF_UV
  IDIVL = 2*KF_UV+1
  IDIVU = 4*KF_UV
  IUL   = 4*KF_UV+1
  IUU   = 6*KF_UV
  IVL   = 6*KF_UV+1
  IVU   = 8*KF_UV
  CALL EPRFI1B(ZFFT(:,:,IVORL:IVORU),PSPVOR,KF_UV,KFLDPTRUV)
  CALL EPRFI1B(ZFFT(:,:,IDIVL:IDIVU),PSPDIV,KF_UV,KFLDPTRUV)
  
  ILAST = ILAST+4*KF_UV

  CALL EVDTUV(KF_UV,KFLDPTRUV,ZFFT(:,:,IVORL:IVORU),ZFFT(:,:,IDIVL:IDIVU),&
   & ZFFT(:,:,IUL:IUU),ZFFT(:,:,IVL:IVU),PSPMEANU,PSPMEANV)

ENDIF

IF(KF_SCALARS > 0)THEN
  IF(PRESENT(PSPSCALAR)) THEN
    IFIRST = ILAST+1
    ILAST  = IFIRST - 1 + 2*KF_SCALARS
    CALL EPRFI1B(ZFFT(:,:,IFIRST:ILAST),PSPSCALAR(:,:),KF_SCALARS,KFLDPTRSC)
  ELSE
    IF(PRESENT(PSPSC2) .AND. NF_SC2 > 0) THEN
      IFIRST = ILAST+1
      ILAST  = IFIRST-1+2*NF_SC2
      CALL EPRFI1B(ZFFT(:,:,IFIRST:ILAST),PSPSC2(:,:),NF_SC2)
    ENDIF
    IF(PRESENT(PSPSC3A) .AND. NF_SC3A > 0) THEN
      IDIM1=NF_SC3A
      IDIM3=UBOUND(PSPSC3A,3)
      DO J3=1,IDIM3
        IFIRST = ILAST+1
        ILAST  = IFIRST-1+2*IDIM1
        CALL EPRFI1B(ZFFT(:,:,IFIRST:ILAST),PSPSC3A(:,:,J3),IDIM1)
      ENDDO
    ENDIF
    IF(PRESENT(PSPSC3B) .AND. NF_SC3B > 0) THEN
      IDIM1=NF_SC3B
      IDIM3=UBOUND(PSPSC3B,3)
      DO J3=1,IDIM3
        IFIRST = ILAST+1
        ILAST  = IFIRST-1+2*IDIM1
        CALL EPRFI1B(ZFFT(:,:,IFIRST:ILAST),PSPSC3B(:,:,J3),IDIM1)
      ENDDO
    ENDIF
  ENDIF
  IF(ILAST /= 8*KF_UV+2*KF_SCALARS) THEN
    WRITE(0,*) 'LTINV:KF_UV,KF_SCALARS,ILAST ',KF_UV,KF_SCALARS,ILAST
    CALL ABORT_TRANS('LTINV_MOD:ILAST /= 8*KF_UV+2*KF_SCALARS')
  ENDIF
ENDIF

IF (KF_SCDERS > 0) THEN
  ISL = 2*(4*KF_UV)+1
  ISU = ISL+2*KF_SCALARS-1
  IDL = 2*(4*KF_UV+KF_SCALARS)+1
  IDU = IDL+2*KF_SCDERS-1
  CALL ESPNSDE(KF_SCALARS,ZFFT(:,:,ISL:ISU),ZFFT(:,:,IDL:IDU))
ENDIF

!     ------------------------------------------------------------------

!*       4.    INVERSE LEGENDRE TRANSFORM.
!              ---------------------------

ISTA = 1
IFC  = 2*KF_OUT_LT
IF(KF_UV > 0 .AND. .NOT. LVORGP) THEN
  ISTA = ISTA+2*KF_UV
ENDIF
IF(KF_UV > 0 .AND. .NOT. LDIVGP) THEN
  ISTA = ISTA+2*KF_UV
ENDIF

! ZFFT_OUT
#ifdef IN_PLACE_FFT
  ZFFT_OUT=>ZFFT
#else
  IALLOC_SZ = ALIGN((RALD%NDGLSUR+R%NNOEXTZG)*D%NUMP*KLEI2*SIZEOF(ZFFT_L_OUT(1)), 128)
  CALL ASSIGN_PTR(ZFFT_L_OUT, GET_ALLOCATION(ALLOCATOR, HELTINV%HFFT_OUT),&
      & 1_JPIB, IALLOC_SZ)
  CALL C_F_POINTER(C_LOC(ZFFT_L_OUT), ZFFT_OUT, (/ RALD%NDGLSUR+R%NNOEXTZG,D%NUMP,KLEI2 /))
#endif

CALL ELEINV(ALLOCATOR,ZFFT,ZFFT_OUT) 

!     ------------------------------------------------------------------

!*       5.    RECOMBINATION SYMMETRIC/ANTISYMMETRIC PART.
!              --------------------------------------------


! FOUBUF_IN
IALLOC_SZ = D%NLENGT1B*2*KF_OUT_LT*SIZEOF(FOUBUF_IN(1))
CALL ASSIGN_PTR(FOUBUF_IN, GET_ALLOCATION(ALLOCATOR, HELTINV%HFOUBUF_IN),&
    & 1_JPIB, IALLOC_SZ)

CALL EASRE1B(KF_OUT_LT,ZFFT_OUT(:,:,ISTA:ISTA+IFC-1),FOUBUF_IN)

!     ------------------------------------------------------------------

!     6. OPTIONAL COMPUTATIONS IN FOURIER SPACE

IF(PRESENT(FSPGL_PROC)) THEN
!!! FIXME !!!   CALL FSPGL_INT(KF_UV,KF_SCALARS,KF_SCDERS,KF_OUT_LT,FSPGL_PROC,&
!!! FIXME !!!    & KFLDPTRUV,KFLDPTRSC)
CALL ABORT('FIXME')
ENDIF

#ifdef ACCGPU
    !$ACC WAIT(1)
    !$ACC END DATA
    !$ACC END DATA
    !$ACC END DATA
    !$ACC END DATA
    !$ACC END DATA
    !$ACC END DATA
    !$ACC END DATA
#endif

IF (LHOOK) CALL DR_HOOK('ELTINV_MOD:ELTINV',1,ZHOOK_HANDLE)

!     ------------------------------------------------------------------

END SUBROUTINE ELTINV
END MODULE ELTINV_MOD