suwavedi_mod.F90

Go to the documentation of this file.

MODULE suwavedi_mod
CONTAINS
SUBROUTINE suwavedi(KSMAX,KTMAX,KPRTRW,KMYSETW,KASM0,KSPOLEGL,KPROCM,&
                    &kumpp,kspec,kspec2,kspec2mx,kpossp,kmyms,&
                    &kptrms,kallms,kdim0g)

!**** *SUWAVEDI * - Routine to initialize spectral wave distribution

!     Purpose.
!     --------
!           Initialize arrays controlling spectral wave distribution

!**   Interface.
!     ----------
!        *CALL* *SUWAVEDI *

!        Explicit arguments : 
!        --------------------
!           KSMAX    - Spectral truncation limit (input)
!           KTMAX    - Overtruncation for KSMAX (input)
!           KPRTRW   - Number of processors in A-direction (input)
!           KMYSETW  - A-set for present processor (input)
!           KASM0    - Offsets for spectral waves (output)
!           KSPOLEGL - Local version of NSPOLEG (output)
!           KPROCM   - Where a certain spectral wave belongs  (output)
!           KUMPP    - Number of spectral waves on this PE (output)
!           KSPEC    - Local version on NSPEC (output)
!           KSPEC2   - Local version on NSPEC2 (output)
!           KSPEC2MX - Maximum KSPEC2 across PEs (output)
!           KPOSSP   - Global spectral fields partitioning (output)
!           KMYMS    - This PEs spectral zonal wavenumbers (output)

!        Implicit arguments : NONE
!        --------------------

!     Method.
!     -------
!        See documentation

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

!     Reference.
!     ----------
!        ECMWF Research Department documentation of the IFS

!     Author.
!     -------
!        MPP Group *ECMWF*

!     Modifications.
!     --------------
!        Original : 96-01-10
!        L.Isaksen: 96-02-02 - Calculation of KSPEC2MX added
!        K.YESSAD : 97-02-18 - Add KTMAX, bug correction for KSPOLEGL.
!     ------------------------------------------------------------------

USE parkind1  ,ONLY : jpim     ,jprb

IMPLICIT NONE


!     DUMMY 
INTEGER(KIND=JPIM),INTENT(IN)  :: KSMAX
INTEGER(KIND=JPIM),INTENT(IN)  :: KTMAX
INTEGER(KIND=JPIM),INTENT(IN)  :: KPRTRW
INTEGER(KIND=JPIM),INTENT(IN)  :: KMYSETW
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KSPEC
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KSPEC2
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KSPEC2MX
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KSPOLEGL

INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KASM0(0:ksmax)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KPROCM(0:ksmax)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KUMPP(kprtrw)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KMYMS(ksmax+1)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KPOSSP(kprtrw+1)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KPTRMS(kprtrw)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KALLMS(ksmax+1)
INTEGER(KIND=JPIM),OPTIONAL,INTENT(OUT) :: KDIM0G(0:ksmax)

!     LOCAL 
INTEGER(KIND=JPIM) :: IK, IL, IND, IPOS, ISPEC2P, JA, JM,JMLOC,IM
INTEGER(KIND=JPIM) :: ISPOLEGL,ISPEC2MX,IASM0(0:ksmax),IPROCM(0:ksmax)
INTEGER(KIND=JPIM) :: IUMPP(kprtrw),IMYMS(ksmax+1),IPOSSP(kprtrw+1)
INTEGER(KIND=JPIM) :: IPTRMS(kprtrw),IALLMS(ksmax+1),IDIM0G(0:ksmax)
INTEGER(KIND=JPIM) :: ISPEC(kprtrw),IC(kprtrw)


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

!*       1.    Initialize partitioning of wave numbers to PEs
!              ----------------------------------------------

ispec(:) = 0

iumpp(:) = 0
iasm0(:) = -99
ispolegl = 0

il  = 1
ind = 1
ik  = 0
ipos = 1
DO jm=0,ksmax
  ik = ik + ind
  IF (ik > kprtrw) THEN
    ik = kprtrw
    ind = -1
  ELSEIF (ik < 1) THEN
    ik = 1
    ind = 1
  ENDIF
  iprocm(jm) = ik
  ispec(ik) = ispec(ik)+ksmax-jm+1
  iumpp(ik) = iumpp(ik)+1
  IF (ik == kmysetw) THEN
    ispolegl = ispolegl +ktmax+1-jm+1
    imyms(il) = jm
    iasm0(jm) = ipos
    ipos = ipos+(ksmax-jm+1)*2
    il = il+1
  ENDIF
ENDDO

ipossp(1) = 1
ispec2p = 2*ispec(1)
ispec2mx = ispec2p
iptrms(1) = 1
DO ja=2,kprtrw
  ipossp(ja) = ipossp(ja-1)+ispec2p
  ispec2p = 2*ispec(ja)
  ispec2mx = max(ispec2mx,ispec2p)
! pointer to the first wave number of a given wave-set in NALLMS array
  iptrms(ja) = iptrms(ja-1)+iumpp(ja-1)
ENDDO
ipossp(kprtrw+1) = ipossp(kprtrw)+ispec2p

!  IALLMS :  wave numbers for all wave-set concatenated together to give all
!            wave numbers in wave-set order.
ic(:) = 0
DO jm=0,ksmax
  iallms(ic(iprocm(jm))+iptrms(iprocm(jm))) = jm
  ic(iprocm(jm)) = ic(iprocm(jm))+1
ENDDO

ipos = 1
DO ja=1,kprtrw
  DO jmloc=1,iumpp(ja)
    im = iallms(iptrms(ja)+jmloc-1)
    idim0g(im) = ipos
    ipos = ipos+(ksmax+1-im)*2
  ENDDO
ENDDO

IF(PRESENT(kspec))    kspec  = ispec(kmysetw)
IF(PRESENT(kspec2))   kspec2 = 2*ispec(kmysetw)
IF(PRESENT(kspec2mx)) kspec2mx = ispec2mx
IF(PRESENT(kspolegl)) kspolegl = ispolegl

IF(PRESENT(kasm0))  kasm0(:)  = iasm0(:)
IF(PRESENT(kprocm)) kprocm(:) = iprocm(:)
IF(PRESENT(kumpp))  kumpp(:)  = iumpp(:)
IF(PRESENT(kmyms))  kmyms(:)  = imyms(:)
IF(PRESENT(kpossp)) kpossp(:) = ipossp(:)
IF(PRESENT(kptrms)) kptrms(:) = iptrms(:)
IF(PRESENT(kallms)) kallms(:) = iallms(:)
IF(PRESENT(kdim0g)) kdim0g(:) = idim0g(:)

END SUBROUTINE suwavedi
END MODULE suwavedi_mod