setup_trans.F90

Go to the documentation of this file.

SUBROUTINE setup_trans(KSMAX,KDGL,KLOEN,LDLINEAR_GRID,LDSPLIT,&
&kapsets,ktmax,kresol)

!**** *SETUP_TRANS* - Setup transform package for specific resolution

!     Purpose.
!     --------
!     To setup for making spectral transforms. Each call to this routine
!     creates a new resolution up to a maximum of NMAX_RESOL set up in
!     SETUP_TRANS0. You need to call SETUP_TRANS0 before this routine can
!     be called.

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

!     Explicit arguments : KLOEN,LDLINEAR_GRID,LDSPLIT,KAPSETS are optional arguments
!     -------------------- 
!     KSMAX - spectral truncation required
!     KDGL  - number of Gaussian latitudes
!     KLOEN(:) - number of points on each Gaussian latitude [2*KDGL]
!     LDSPLIT - true if split latitudes in grid-point space [false]
!     LDLINEAR_GRID - true if linear grid
!     KAPSETS - Number of apple sets in the distribution [0]
!     KTMAX - truncation order for tendencies?
!     KRESOL - the resolution identifier

!     KSMAX,KDGL,KTMAX and KLOEN are GLOBAL variables desribing the resolution
!     in spectral and grid-point space

!     LDSPLIT and KAPSETS describe the distribution among processors of
!     grid-point data and has no relevance if you are using a single processor
 
!     Method.
!     -------

!     Externals.  SET_RESOL   - set resolution
!     ----------  SETUP_DIMS  - setup distribution independent dimensions
!                 SUMP_TRANS_PRELEG - first part of setup of distr. environment
!                 SULEG - Compute Legandre polonomial and Gaussian 
!                         Latitudes and Weights
!                 SETUP_GEOM - Compute arrays related to grid-point geometry
!                 SUMP_TRANS - Second part of setup of distributed environment
!                 SUFFT - setup for FFT

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

!     Modifications.
!     --------------
!        Original : 00-03-03

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

USE parkind1  ,ONLY : jpim     ,jprb

!ifndef INTERFACE

USE tpm_gen
USE tpm_dim
USE tpm_distr
USE tpm_geometry
USE tpm_fields
USE tpm_fft

USE set_resol_mod
USE setup_dims_mod
USE sump_trans_mod
USE sump_trans_preleg_mod
USE suleg_mod
USE setup_geom_mod
USE sufft_mod
USE abort_trans_mod
USE yomhook   ,ONLY : lhook,   dr_hook

!endif INTERFACE

IMPLICIT NONE

! Dummy arguments

INTEGER(KIND=JPIM) ,INTENT(IN) :: KSMAX,KDGL
INTEGER(KIND=JPIM) ,OPTIONAL,INTENT(IN) :: KLOEN(:)
LOGICAL   ,OPTIONAL,INTENT(IN) :: LDLINEAR_GRID
LOGICAL   ,OPTIONAL,INTENT(IN) :: LDSPLIT
INTEGER(KIND=JPIM) ,OPTIONAL,INTENT(IN) :: KAPSETS
INTEGER(KIND=JPIM) ,OPTIONAL,INTENT(IN) :: KTMAX
INTEGER(KIND=JPIM) ,OPTIONAL,INTENT(OUT):: KRESOL

!ifndef INTERFACE

! Local variables
INTEGER(KIND=JPIM) :: JGL

LOGICAL :: LLP1,LLP2
REAL(KIND=JPRB) :: ZHOOK_HANDLE

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

IF (lhook) CALL dr_hook('SETUP_TRANS',0,zhook_handle)

IF(msetup0 /= 1) THEN
  CALL abort_trans('SETUP_TRANS: SETUP_TRANS0 HAS TO BE CALLED BEFORE SETUP_TRANS')
ENDIF
llp1 = nprintlev>0
llp2 = nprintlev>1
IF(llp1) WRITE(nout,*) '=== ENTER ROUTINE SETUP_TRANS ==='

! Allocate resolution dependent structures
IF(.NOT. ALLOCATED(dim_resol)) THEN
  ndef_resol = 1
  ALLOCATE(dim_resol(nmax_resol))
  ALLOCATE(fields_resol(nmax_resol))
  ALLOCATE(geom_resol(nmax_resol))
  ALLOCATE(distr_resol(nmax_resol))
  ALLOCATE(fft_resol(nmax_resol))
ELSE
  ndef_resol = ndef_resol+1
  IF(ndef_resol > nmax_resol) THEN
    CALL abort_trans('SETUP_TRANS:NDEF_RESOL > NMAX_RESOL')
  ENDIF
ENDIF

IF (PRESENT(kresol)) THEN
  kresol=ndef_resol
ENDIF

! Point at structures due to be initialized
CALL set_resol(ndef_resol)

IF(llp1) WRITE(nout,*) '=== DEFINING RESOLUTION ',ncur_resol



! Defaults for optional arguments


g%LREDUCED_GRID = .false.
g%LINEAR_GRID = .false.
d%LSPLIT = .false.
d%NAPSETS = 0

! NON-OPTIONAL ARGUMENTS
r%NSMAX = ksmax
r%NDGL  = kdgl
r%NDLON = 2*kdgl

IF (kdgl <= 0 .OR. mod(kdgl,2) /= 0) THEN
  CALL abort_trans ('SETUP_TRANS: KDGL IS NOT A POSITIVE, EVEN NUMBER')
ENDIF

! Optional arguments

ALLOCATE(g%NLOEN(r%NDGL))
IF(llp2)WRITE(nout,9) 'NLOEN   ',SIZE(g%NLOEN   ),shape(g%NLOEN   )
IF(PRESENT(kloen)) THEN
  DO jgl=1,r%NDGL
    IF(kloen(jgl) /= r%NDLON) THEN
      g%LREDUCED_GRID = .true.
      EXIT
    ENDIF
  ENDDO
ENDIF

IF (g%LREDUCED_GRID) THEN
  g%NLOEN(:) = kloen(1:r%NDGL)
ELSE
  g%NLOEN(:) = r%NDLON
ENDIF

IF(PRESENT(ldsplit)) THEN
  d%LSPLIT = ldsplit
ENDIF

IF(PRESENT(kapsets)) THEN
  d%NAPSETS = kapsets
ENDIF

IF(PRESENT(ktmax)) THEN
  r%NTMAX = ktmax
ELSE
  r%NTMAX = r%NSMAX
ENDIF
IF(r%NTMAX /= r%NSMAX) THEN
  !This SHOULD work but I don't know how to test it /MH
  CALL abort_trans('SETUP_TRANS:R%NTMAX /= R%NSMAX HAS NOT BEEN VALIDATED')
ENDIF
!Temporary?
IF(PRESENT(ldlinear_grid)) THEN
  g%LINEAR_GRID = ldlinear_grid
ELSEIF(r%NSMAX > (r%NDLON+3)/3) THEN
  g%LINEAR_GRID = .true.
ENDIF  

!     Setup resolution dependent structures
!     -------------------------------------

! Setup distribution independent dimensions
CALL setup_dims

! First part of setup of distributed environment
CALL sump_trans_preleg

! Compute Legandre polonomial and Gaussian Latitudes and Weights
CALL suleg

!CALL GSTATS(1802,0) MPL 2.12.08
! Compute arrays related to grid-point geometry
CALL setup_geom

! Second part of setup of distributed environment
CALL sump_trans

! Initialize Fast Fourier Transform package
CALL sufft
!CALL GSTATS(1802,1)  MPL 2.12.08


IF (lhook) CALL dr_hook('SETUP_TRANS',1,zhook_handle)
!     ------------------------------------------------------------------
9 FORMAT(1x,'ARRAY ',a10,' ALLOCATED ',8i8)

!endif INTERFACE

END SUBROUTINE setup_trans