SUBROUTINE POLATES6(IPOPT,IGDTNUMI,IGDTMPLI,IGDTLENI, & IGDTNUMO,IGDTMPLO,IGDTLENO, & MI,MO,KM,IBI,LI,GI, & NO,RLAT,RLON,IBO,LO,GO,IRET) !$$$ SUBPROGRAM DOCUMENTATION BLOCK ! ! $Revision: 74685 $ ! ! SUBPROGRAM: POLATES6 INTERPOLATE SCALAR FIELDS (BUDGET) ! PRGMMR: IREDELL ORG: W/NMC23 DATE: 96-04-10 ! ! ABSTRACT: THIS SUBPROGRAM PERFORMS BUDGET INTERPOLATION ! FROM ANY GRID TO ANY GRID FOR SCALAR FIELDS. ! THE ALGORITHM SIMPLY COMPUTES (WEIGHTED) AVERAGES ! OF NEIGHBOR POINTS ARRANGED IN A SQUARE BOX ! CENTERED AROUND EACH OUTPUT GRID POINT AND STRETCHING ! NEARLY HALFWAY TO EACH OF THE NEIGHBORING GRID POINTS. ! OPTIONS ALLOW CHOICES OF NUMBER OF POINTS IN EACH RADIUS ! FROM THE CENTER POINT (IPOPT(1)) WHICH DEFAULTS TO 2 ! (IF IPOPT(1)=-1) MEANING THAT 25 POINTS WILL BE AVERAGED; ! FURTHER OPTIONS ARE THE RESPECTIVE WEIGHTS FOR THE RADIUS ! POINTS STARTING AT THE CENTER POINT (IPOPT(2:2+IPOPT(1)) ! WHICH DEFAULTS TO ALL 1 (IF IPOPT(1)=-1 OR IPOPT(2)=-1). ! ANOTHER OPTION IS THE MINIMUM PERCENTAGE FOR MASK, ! I.E. PERCENT VALID INPUT DATA REQUIRED TO MAKE OUTPUT DATA, ! (IPOPT(3+IPOPT(1)) WHICH DEFAULTS TO 50 (IF -1). ! ONLY HORIZONTAL INTERPOLATION IS PERFORMED. ! THE CODE RECOGNIZES THE FOLLOWING PROJECTIONS, WHERE ! "IGDTNUMI/O" IS THE GRIB 2 GRID DEFINTION TEMPLATE NUMBER ! FOR THE INPUT AND OUTPUT GRIDS, RESPECTIVELY: ! (IGDTNUMI/O=00) EQUIDISTANT CYLINDRICAL ! (IGDTNUMI/O=01) ROTATED EQUIDISTANT CYLINDRICAL. "E" AND ! NON-"E" STAGGERED ! (IGDTNUMI/O=10) MERCATOR CYLINDRICAL ! (IGDTNUMI/O=20) POLAR STEREOGRAPHIC AZIMUTHAL ! (IGDTNUMI/O=30) LAMBERT CONFORMAL CONICAL ! (IGDTNUMI/O=40) GAUSSIAN CYLINDRICAL ! AS AN ADDED BONUS THE NUMBER OF OUTPUT GRID POINTS ! AND THEIR LATITUDES AND LONGITUDES ARE ALSO RETURNED. ! INPUT BITMAPS WILL BE INTERPOLATED TO OUTPUT BITMAPS. ! OUTPUT BITMAPS WILL ALSO BE CREATED WHEN THE OUTPUT GRID ! EXTENDS OUTSIDE OF THE DOMAIN OF THE INPUT GRID. ! THE OUTPUT FIELD IS SET TO 0 WHERE THE OUTPUT BITMAP IS OFF. ! ! PROGRAM HISTORY LOG: ! 96-04-10 IREDELL ! 96-10-04 IREDELL NEIGHBOR POINTS NOT BILINEAR INTERPOLATION ! 1999-04-08 IREDELL SPLIT IJKGDS INTO TWO PIECES ! 2001-06-18 IREDELL INCLUDE MINIMUM MASK PERCENTAGE OPTION ! 2015-01-27 GAYNO REPLACE CALLS TO GDSWIZ WITH NEW MERGED ! VERSION OF GDSWZD. ! 2015-07-13 GAYNO CONVERT TO GRIB 2. REPLACE GRIB 1 KGDS ARRAYS ! WITH GRIB 2 GRID DEFINITION TEMPLATE ARRAYS. ! ! USAGE: CALL POLATES6(IPOPT,IGDTNUMI,IGDTMPLI,IGDTLENI, & ! IGDTNUMO,IGDTMPLO,IGDTLENO, & ! MI,MO,KM,IBI,LI,GI, & ! NO,RLAT,RLON,IBO,LO,GO,IRET) ! ! INPUT ARGUMENT LIST: ! IPOPT - INTEGER (20) INTERPOLATION OPTIONS ! IPOPT(1) IS NUMBER OF RADIUS POINTS ! (DEFAULTS TO 2 IF IPOPT(1)=-1); ! IPOPT(2:2+IPOPT(1)) ARE RESPECTIVE WEIGHTS ! (DEFAULTS TO ALL 1 IF IPOPT(1)=-1 OR IPOPT(2)=-1). ! IPOPT(3+IPOPT(1)) IS MINIMUM PERCENTAGE FOR MASK ! (DEFAULTS TO 50 IF IPOPT(3+IPOPT(1)=-1) ! IGDTNUMI - INTEGER GRID DEFINITION TEMPLATE NUMBER - INPUT GRID. ! CORRESPONDS TO THE GFLD%IGDTNUM COMPONENT OF THE ! NCEP G2 LIBRARY GRIDMOD DATA STRUCTURE: ! 00 - EQUIDISTANT CYLINDRICAL ! 01 - ROTATED EQUIDISTANT CYLINDRICAL. "E" ! AND NON-"E" STAGGERED ! 10 - MERCATOR CYCLINDRICAL ! 20 - POLAR STEREOGRAPHIC AZIMUTHAL ! 30 - LAMBERT CONFORMAL CONICAL ! 40 - GAUSSIAN EQUIDISTANT CYCLINDRICAL ! IGDTMPLI - INTEGER (IGDTLENI) GRID DEFINITION TEMPLATE ARRAY - ! INPUT GRID. CORRESPONDS TO THE GFLD%IGDTMPL COMPONENT ! OF THE NCEP G2 LIBRARY GRIDMOD DATA STRUCTURE. ! (SECTION 3 INFO). SEE COMMENTS IN ROUTINE ! IPOLATES FOR COMPLETE DEFINITION. ! IGDTLENI - INTEGER NUMBER OF ELEMENTS OF THE GRID DEFINITION ! TEMPLATE ARRAY - INPUT GRID. CORRESPONDS TO THE GFLD%IGDTLEN ! COMPONENT OF THE NCEP G2 LIBRARY GRIDMOD DATA STRUCTURE. ! IGDTNUMO - INTEGER GRID DEFINITION TEMPLATE NUMBER - OUTPUT GRID. ! CORRESPONDS TO THE GFLD%IGDTNUM COMPONENT OF THE ! NCEP G2 LIBRARY GRIDMOD DATA STRUCTURE. ! SAME DEFINITION AS "IGDTNUMI". ! IGDTMPLO - INTEGER (IGDTLENO) GRID DEFINITION TEMPLATE ARRAY - ! OUTPUT GRID. CORRESPONDS TO THE GFLD%IGDTMPL COMPONENT ! OF THE NCEP G2 LIBRARY GRIDMOD DATA STRUCTURE. ! (SECTION 3 INFO). SEE COMMENTS IN ROUTINE ! IPOLATES FOR COMPLETE DEFINITION. ! IGDTLENO - INTEGER NUMBER OF ELEMENTS OF THE GRID DEFINITION ! TEMPLATE ARRAY - OUTPUT GRID. CORRESPONDS TO THE GFLD%IGDTLEN ! COMPONENT OF THE NCEP G2 LIBRARY GRIDMOD DATA STRUCTURE. ! MI - INTEGER SKIP NUMBER BETWEEN INPUT GRID FIELDS IF KM>1 ! OR DIMENSION OF INPUT GRID FIELDS IF KM=1 ! MO - INTEGER SKIP NUMBER BETWEEN OUTPUT GRID FIELDS IF KM>1 ! OR DIMENSION OF OUTPUT GRID FIELDS IF KM=1 ! KM - INTEGER NUMBER OF FIELDS TO INTERPOLATE ! IBI - INTEGER (KM) INPUT BITMAP FLAGS ! LI - LOGICAL*1 (MI,KM) INPUT BITMAPS (IF SOME IBI(K)=1) ! GI - REAL (MI,KM) INPUT FIELDS TO INTERPOLATE ! ! OUTPUT ARGUMENT LIST: ! NO - INTEGER NUMBER OF OUTPUT POINTS ! RLAT - REAL (MO) OUTPUT LATITUDES IN DEGREES ! RLON - REAL (MO) OUTPUT LONGITUDES IN DEGREES ! IBO - INTEGER (KM) OUTPUT BITMAP FLAGS ! LO - LOGICAL*1 (MO,KM) OUTPUT BITMAPS (ALWAYS OUTPUT) ! GO - REAL (MO,KM) OUTPUT FIELDS INTERPOLATED ! IRET - INTEGER RETURN CODE ! 0 SUCCESSFUL INTERPOLATION ! 2 UNRECOGNIZED INPUT GRID OR NO GRID OVERLAP ! 3 UNRECOGNIZED OUTPUT GRID ! 31 INVALID UNDEFINED OUTPUT GRID ! 32 INVALID BUDGET METHOD PARAMETERS ! ! SUBPROGRAMS CALLED: ! GDSWZD GRID DESCRIPTION SECTION WIZARD ! IJKGDS0 SET UP PARAMETERS FOR IJKGDS1 ! IJKGDS1 RETURN FIELD POSITION FOR A GIVEN GRID POINT ! POLFIXS MAKE MULTIPLE POLE SCALAR VALUES CONSISTENT ! ! ATTRIBUTES: ! LANGUAGE: FORTRAN 90 ! !$$$ USE GDSWZD_MOD ! IMPLICIT NONE ! INTEGER, INTENT(IN ) :: IGDTNUMI, IGDTLENI INTEGER, INTENT(IN ) :: IGDTMPLI(IGDTLENI) INTEGER, INTENT(IN ) :: IGDTNUMO, IGDTLENO INTEGER, INTENT(IN ) :: IGDTMPLO(IGDTLENO) INTEGER, INTENT(IN ) :: IBI(KM), IPOPT(20), KM, MI, MO INTEGER, INTENT( OUT) :: IBO(KM), IRET, NO ! LOGICAL*1, INTENT(IN ) :: LI(MI,KM) LOGICAL*1, INTENT( OUT) :: LO(MO,KM) ! REAL, INTENT(IN ) :: GI(MI,KM) REAL, INTENT( OUT) :: GO(MO,KM), RLAT(MO), RLON(MO) ! REAL, PARAMETER :: FILL=-9999. ! INTEGER :: IB, I1, IJKGDS1, IJKGDSA(20) INTEGER :: JB, J1, K, LB, LSW, MP, N INTEGER :: N11(MO), NB, NB1, NB2, NB3, NB4, NV ! REAL :: PMP,RLOB(MO),RLAB(MO) REAL :: WB, WO(MO,KM), XI, YI REAL :: XPTB(MO),YPTB(MO),XPTS(MO),YPTS(MO) ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ! COMPUTE NUMBER OF OUTPUT POINTS AND THEIR LATITUDES AND LONGITUDES. IRET=0 IF(IGDTNUMO.GE.0) THEN CALL GDSWZD(IGDTNUMO,IGDTMPLO,IGDTLENO, 0,MO,FILL,XPTS,YPTS,RLON,RLAT,NO) IF(NO.EQ.0) IRET=3 ELSE IRET=31 ENDIF ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ! SET PARAMETERS NB1=IPOPT(1) IF(NB1.EQ.-1) NB1=2 IF(IRET.EQ.0.AND.NB1.LT.0) IRET=32 LSW=1 IF(IPOPT(1).EQ.-1.OR.IPOPT(2).EQ.-1) LSW=0 IF(IRET.EQ.0.AND.LSW.EQ.1.AND.NB1.GT.15) IRET=32 MP=IPOPT(3+IPOPT(1)) IF(MP.EQ.-1.OR.MP.EQ.0) MP=50 IF(MP.LT.0.OR.MP.GT.100) IRET=32 PMP=MP*0.01 IF(IRET.EQ.0) THEN NB2=2*NB1+1 NB3=NB2*NB2 NB4=NB3 IF(LSW.EQ.1) THEN NB4=IPOPT(2) DO IB=1,NB1 NB4=NB4+8*IB*IPOPT(2+IB) ENDDO ENDIF ELSE NB2=0 NB3=0 NB4=0 ENDIF DO K=1,KM DO N=1,NO GO(N,K)=0. WO(N,K)=0. ENDDO ENDDO ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ! LOOP OVER SAMPLE POINTS IN OUTPUT GRID BOX CALL IJKGDS0(IGDTNUMI,IGDTMPLI,IGDTLENI,IJKGDSA) DO NB=1,NB3 ! LOCATE INPUT POINTS AND COMPUTE THEIR WEIGHTS JB=(NB-1)/NB2-NB1 IB=NB-(JB+NB1)*NB2-NB1-1 LB=MAX(ABS(IB),ABS(JB)) WB=1 IF(LSW.EQ.1) WB=IPOPT(2+LB) IF(WB.NE.0) THEN DO N=1,NO XPTB(N)=XPTS(N)+IB/REAL(NB2) YPTB(N)=YPTS(N)+JB/REAL(NB2) ENDDO CALL GDSWZD(IGDTNUMO,IGDTMPLO,IGDTLENO, 1,NO,FILL,XPTB,YPTB,RLOB,RLAB,NV) CALL GDSWZD(IGDTNUMI,IGDTMPLI,IGDTLENI,-1,NO,FILL,XPTB,YPTB,RLOB,RLAB,NV) IF(IRET.EQ.0.AND.NV.EQ.0.AND.LB.EQ.0) IRET=2 DO N=1,NO XI=XPTB(N) YI=YPTB(N) IF(XI.NE.FILL.AND.YI.NE.FILL) THEN I1=NINT(XI) J1=NINT(YI) N11(N)=IJKGDS1(I1,J1,IJKGDSA) ELSE N11(N)=0 ENDIF ENDDO ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ! INTERPOLATE WITH OR WITHOUT BITMAPS DO K=1,KM DO N=1,NO IF(N11(N).GT.0) THEN IF(IBI(K).EQ.0.OR.LI(N11(N),K)) THEN GO(N,K)=GO(N,K)+WB*GI(N11(N),K) WO(N,K)=WO(N,K)+WB ENDIF ENDIF ENDDO ENDDO ENDIF ENDDO ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ! COMPUTE OUTPUT BITMAPS AND FIELDS DO K=1,KM IBO(K)=IBI(K) DO N=1,NO LO(N,K)=WO(N,K).GE.PMP*NB4 IF(LO(N,K)) THEN GO(N,K)=GO(N,K)/WO(N,K) ELSE IBO(K)=1 GO(N,K)=0. ENDIF ENDDO ENDDO IF(IGDTNUMO.EQ.0) CALL POLFIXS(NO,MO,KM,RLAT,IBO,LO,GO) ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END SUBROUTINE POLATES6