SUBROUTINE POLATEV3(IPOPT,KGDSI,KGDSO,MI,MO,KM,IBI,LI,UI,VI, & NO,RLAT,RLON,CROT,SROT,IBO,LO,UO,VO,IRET) !$$$ SUBPROGRAM DOCUMENTATION BLOCK ! ! $Revision: 71314 $ ! ! SUBPROGRAM: POLATEV3 INTERPOLATE VECTOR FIELDS (BUDGET) ! PRGMMR: IREDELL ORG: W/NMC23 DATE: 96-04-10 ! ! ABSTRACT: THIS SUBPROGRAM PERFORMS BUDGET INTERPOLATION ! FROM ANY GRID TO ANY GRID FOR VECTOR FIELDS. ! IT MAY BE RUN FOR A WHOLE (KGDSO(1)>=0) OR A SUBSECTION ! OF AN OUTPUT GRID (SUBTRACT KGDSO(1) FROM 255 AND ! PASS IN THE LAT/LONS OF EACH POINT). ! THE ALGORITHM SIMPLY COMPUTES (WEIGHTED) AVERAGES ! OF BILINEARLY INTERPOLATED 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). ! A SPECIAL INTERPOLATION IS DONE IF IPOPT(2)=-2. ! IN THIS CASE, THE BOXES STRETCH NEARLY ALL THE WAY TO ! EACH OF THE NEIGHBORING GRID POINTS AND THE WEIGHTS ! ARE THE ADJOINT OF THE BILINEAR INTERPOLATION WEIGHTS. ! THIS CASE GIVES QUASI-SECOND-ORDER BUDGET INTERPOLATION. ! 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 GRIDS ARE DEFINED BY THEIR GRID DESCRIPTION SECTIONS ! (PASSED IN INTEGER FORM AS DECODED BY SUBPROGRAM W3FI63). ! THE CURRENT CODE RECOGNIZES THE FOLLOWING PROJECTIONS: ! (KGDS(1)=000) EQUIDISTANT CYLINDRICAL ! (KGDS(1)=001) MERCATOR CYLINDRICAL ! (KGDS(1)=003) LAMBERT CONFORMAL CONICAL ! (KGDS(1)=004) GAUSSIAN CYLINDRICAL (SPECTRAL NATIVE) ! (KGDS(1)=005) POLAR STEREOGRAPHIC AZIMUTHAL ! (KGDS(1)=203) ROTATED EQUIDISTANT CYLINDRICAL (E-STAGGER) ! (KGDS(1)=205) ROTATED EQUIDISTANT CYLINDRICAL (B-STAGGER) ! WHERE KGDS COULD BE EITHER INPUT KGDSI OR OUTPUT KGDSO. ! THE INPUT AND OUTPUT VECTORS ARE ROTATED SO THAT THEY ARE ! EITHER RESOLVED RELATIVE TO THE DEFINED GRID ! IN THE DIRECTION OF INCREASING X AND Y COORDINATES ! OR RESOLVED RELATIVE TO EASTERLY AND NORTHERLY DIRECTIONS, ! AS DESIGNATED BY THEIR RESPECTIVE GRID DESCRIPTION SECTIONS. ! AS AN ADDED BONUS (IF KGDSO(1)>=0) THE NUMBER OF OUTPUT GRID ! POINTS AND THEIR LATITUDES AND LONGITUDES ARE ALSO RETURNED ! ALONG WITH THEIR VECTOR ROTATION PARAMETERS. ! 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 ! 1999-04-08 IREDELL SPLIT IJKGDS INTO TWO PIECES ! 1999-04-08 IREDELL ADDED BILINEAR OPTION IPOPT(2)=-2 ! 2001-06-18 IREDELL INCLUDE MINIMUM MASK PERCENTAGE OPTION ! 2002-01-17 IREDELL SAVE DATA FROM LAST CALL FOR OPTIMIZATION ! 2006-01-05 GAYNO ADDED OPTION TO TO DO SUBSECTION OF OUTPUT GRID. ! 2015-01-27 GAYNO REPLACE CALLS TO GDSWIZ WITH NEW MERGED ! ROUTINE GDSWZD. ! ! USAGE: CALL POLATEV3(IPOPT,KGDSI,KGDSO,MI,MO,KM,IBI,LI,UI,VI, ! & NO,RLAT,RLON,CROT,SROT,IBO,LO,UO,VO,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) ! KGDSI - INTEGER (200) INPUT GDS PARAMETERS AS DECODED BY W3FI63 ! KGDSO - INTEGER (200) OUTPUT GDS PARAMETERS ! 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) ! UI - REAL (MI,KM) INPUT U-COMPONENT FIELDS TO INTERPOLATE ! VI - REAL (MI,KM) INPUT V-COMPONENT FIELDS TO INTERPOLATE ! RLAT - REAL (MO) INPUT LATITUDES IN DEGREES (KGDSO(1)<0) ! RLON - REAL (MO) INPUT LONGITUDES IN DEGREES (KGDSO(1)<0) ! ! OUTPUT ARGUMENT LIST: ! NO - INTEGER NUMBER OF OUTPUT POINTS ! RLAT - REAL (MO) OUTPUT LATITUDES IN DEGREES (KGDSO(1)>0) ! RLON - REAL (MO) OUTPUT LONGITUDES IN DEGREES (KGDSO(1)>0) ! CROT - REAL (NO) VECTOR ROTATION COSINES ! SROT - REAL (NO) VECTOR ROTATION SINES ! (UGRID=CROT*UEARTH-SROT*VEARTH; ! VGRID=SROT*UEARTH+CROT*VEARTH) ! IBO - INTEGER (KM) OUTPUT BITMAP FLAGS ! LO - LOGICAL*1 (MO,KM) OUTPUT BITMAPS (ALWAYS OUTPUT) ! UO - REAL (MO,KM) OUTPUT U-COMPONENT FIELDS INTERPOLATED ! VO - REAL (MO,KM) OUTPUT V-COMPONENT FIELDS INTERPOLATED ! IRET - INTEGER RETURN CODE ! 0 SUCCESSFUL INTERPOLATION ! 2 UNRECOGNIZED INPUT GRID OR NO GRID OVERLAP ! 3 UNRECOGNIZED 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 ! (MOVECT) MOVE A VECTOR ALONG A GREAT CIRCLE ! POLFIXV MAKE MULTIPLE POLE VECTOR VALUES CONSISTENT ! ! ATTRIBUTES: ! LANGUAGE: FORTRAN 90 ! !$$$ ! USE GDSWZD_MOD ! IMPLICIT NONE ! INTEGER, INTENT(IN ):: IPOPT(20), IBI(KM) INTEGER, INTENT(IN ):: KM, MI, MO INTEGER, INTENT(IN ):: KGDSI(200) INTEGER, INTENT(INOUT):: KGDSO(200) INTEGER, INTENT( OUT):: IRET, NO, IBO(KM) ! LOGICAL*1, INTENT(IN ):: LI(MI,KM) LOGICAL*1, INTENT( OUT):: LO(MO,KM) ! REAL, INTENT(IN ):: UI(MI,KM),VI(MI,KM) REAL, INTENT(INOUT):: RLAT(MO),RLON(MO) REAL, INTENT( OUT):: UO(MO,KM),VO(MO,KM) REAL, INTENT( OUT):: CROT(MO),SROT(MO) ! REAL, PARAMETER :: FILL=-9999. ! INTEGER :: IJKGDS1, IJKGDSA(20) INTEGER :: I1,I2,J1,J2,IB,JB,LSW,MP INTEGER, SAVE :: MIX=-1,KGDSIX(200)=-1 INTEGER :: K,LB,N,NB,NB1,NB2,NB3,NB4,NV INTEGER :: N11(MO),N21(MO),N12(MO),N22(MO) ! REAL :: CM11,SM11,CM12,SM12 REAL :: CM21,SM21,CM22,SM22 REAL :: PMP,RB2 REAL :: C11(MO),C21(MO),C12(MO),C22(MO) REAL :: S11(MO),S21(MO),S12(MO),S22(MO) REAL :: W11(MO),W21(MO),W12(MO),W22(MO) REAL :: UB,VB,WB,UROT,VROT REAL :: U11,V11,U21,V21,U12,V12,U22,V22 REAL :: WI1,WJ1,WI2,WJ2 REAL :: WO(MO,KM),XI,YI REAL :: XPTS(MO),YPTS(MO) REAL :: XPTB(MO),YPTB(MO),RLOB(MO),RLAB(MO) REAL, ALLOCATABLE,SAVE :: CROI(:),SROI(:) REAL, ALLOCATABLE,SAVE :: XPTI(:),YPTI(:),RLOI(:),RLAI(:) ! ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ! COMPUTE NUMBER OF OUTPUT POINTS AND THEIR LATITUDES AND LONGITUDES. IRET=0 IF(KGDSO(1).GE.0) THEN CALL GDSWZD(KGDSO, 0,MO,FILL,XPTS,YPTS,RLON,RLAT,NO,CROT,SROT) IF(NO.EQ.0) IRET=3 ELSE KGDSO(1)=255+KGDSO(1) CALL GDSWZD(KGDSO,-1,MO,FILL,XPTS,YPTS,RLON,RLAT,NO,CROT,SROT) IF(NO.EQ.0) IRET=3 ENDIF IF(ANY(KGDSI.NE.KGDSIX)) THEN IF(MIX.NE.MI) THEN IF(MIX.GE.0) DEALLOCATE(XPTI,YPTI,RLOI,RLAI,CROI,SROI) ALLOCATE(XPTI(MI),YPTI(MI),RLOI(MI),RLAI(MI),CROI(MI),SROI(MI)) MIX=MI ENDIF CALL GDSWZD(KGDSI, 0,MI,FILL,XPTI,YPTI,RLOI,RLAI,NV,CROI,SROI) KGDSIX=KGDSI 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(2).EQ.-2) LSW=2 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 RB2=1./NB2 NB3=NB2*NB2 NB4=NB3 IF(LSW.EQ.2) THEN RB2=1./(NB1+1) NB4=(NB1+1)**4 ELSEIF(LSW.EQ.1) THEN NB4=IPOPT(2) DO IB=1,NB1 NB4=NB4+8*IB*IPOPT(2+IB) ENDDO ENDIF ELSE NB3=0 NB4=1 ENDIF DO K=1,KM DO N=1,NO UO(N,K)=0 VO(N,K)=0 WO(N,K)=0. ENDDO ENDDO ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ! LOOP OVER SAMPLE POINTS IN OUTPUT GRID BOX CALL IJKGDS0(KGDSI,IJKGDSA) DO NB=1,NB3 ! LOCATE INPUT POINTS AND COMPUTE THEIR WEIGHTS AND ROTATIONS JB=(NB-1)/NB2-NB1 IB=NB-(JB+NB1)*NB2-NB1-1 LB=MAX(ABS(IB),ABS(JB)) WB=1 IF(IPOPT(2).EQ.-2) THEN WB=(NB1+1-ABS(IB))*(NB1+1-ABS(JB)) ELSEIF(IPOPT(2).NE.-1) THEN WB=IPOPT(2+LB) ENDIF IF(WB.NE.0) THEN DO N=1,NO XPTB(N)=XPTS(N)+IB*RB2 YPTB(N)=YPTS(N)+JB*RB2 ENDDO CALL GDSWZD(KGDSO, 1,NO,FILL,XPTB,YPTB,RLOB,RLAB,NV) CALL GDSWZD(KGDSI,-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=XI I2=I1+1 WI2=XI-I1 WI1=1-WI2 J1=YI J2=J1+1 WJ2=YI-J1 WJ1=1-WJ2 N11(N)=IJKGDS1(I1,J1,IJKGDSA) N21(N)=IJKGDS1(I2,J1,IJKGDSA) N12(N)=IJKGDS1(I1,J2,IJKGDSA) N22(N)=IJKGDS1(I2,J2,IJKGDSA) IF(MIN(N11(N),N21(N),N12(N),N22(N)).GT.0) THEN W11(N)=WI1*WJ1 W21(N)=WI2*WJ1 W12(N)=WI1*WJ2 W22(N)=WI2*WJ2 CALL MOVECT(RLAI(N11(N)),RLOI(N11(N)),RLAT(N),RLON(N),CM11,SM11) CALL MOVECT(RLAI(N21(N)),RLOI(N21(N)),RLAT(N),RLON(N),CM21,SM21) CALL MOVECT(RLAI(N12(N)),RLOI(N12(N)),RLAT(N),RLON(N),CM12,SM12) CALL MOVECT(RLAI(N22(N)),RLOI(N22(N)),RLAT(N),RLON(N),CM22,SM22) C11(N)=CM11*CROI(N11(N))+SM11*SROI(N11(N)) S11(N)=SM11*CROI(N11(N))-CM11*SROI(N11(N)) C21(N)=CM21*CROI(N21(N))+SM21*SROI(N21(N)) S21(N)=SM21*CROI(N21(N))-CM21*SROI(N21(N)) C12(N)=CM12*CROI(N12(N))+SM12*SROI(N12(N)) S12(N)=SM12*CROI(N12(N))-CM12*SROI(N12(N)) C22(N)=CM22*CROI(N22(N))+SM22*SROI(N22(N)) S22(N)=SM22*CROI(N22(N))-CM22*SROI(N22(N)) ELSE N11(N)=0 N21(N)=0 N12(N)=0 N22(N)=0 ENDIF ELSE N11(N)=0 N21(N)=0 N12(N)=0 N22(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) THEN U11=C11(N)*UI(N11(N),K)-S11(N)*VI(N11(N),K) V11=S11(N)*UI(N11(N),K)+C11(N)*VI(N11(N),K) U21=C21(N)*UI(N21(N),K)-S21(N)*VI(N21(N),K) V21=S21(N)*UI(N21(N),K)+C21(N)*VI(N21(N),K) U12=C12(N)*UI(N12(N),K)-S12(N)*VI(N12(N),K) V12=S12(N)*UI(N12(N),K)+C12(N)*VI(N12(N),K) U22=C22(N)*UI(N22(N),K)-S22(N)*VI(N22(N),K) V22=S22(N)*UI(N22(N),K)+C22(N)*VI(N22(N),K) UB=W11(N)*U11+W21(N)*U21+W12(N)*U12+W22(N)*U22 VB=W11(N)*V11+W21(N)*V21+W12(N)*V12+W22(N)*V22 UO(N,K)=UO(N,K)+WB*UB VO(N,K)=VO(N,K)+WB*VB WO(N,K)=WO(N,K)+WB ELSE IF(LI(N11(N),K)) THEN U11=C11(N)*UI(N11(N),K)-S11(N)*VI(N11(N),K) V11=S11(N)*UI(N11(N),K)+C11(N)*VI(N11(N),K) UO(N,K)=UO(N,K)+WB*W11(N)*U11 VO(N,K)=VO(N,K)+WB*W11(N)*V11 WO(N,K)=WO(N,K)+WB*W11(N) ENDIF IF(LI(N21(N),K)) THEN U21=C21(N)*UI(N21(N),K)-S21(N)*VI(N21(N),K) V21=S21(N)*UI(N21(N),K)+C21(N)*VI(N21(N),K) UO(N,K)=UO(N,K)+WB*W21(N)*U21 VO(N,K)=VO(N,K)+WB*W21(N)*V21 WO(N,K)=WO(N,K)+WB*W21(N) ENDIF IF(LI(N12(N),K)) THEN U12=C12(N)*UI(N12(N),K)-S12(N)*VI(N12(N),K) V12=S12(N)*UI(N12(N),K)+C12(N)*VI(N12(N),K) UO(N,K)=UO(N,K)+WB*W12(N)*U12 VO(N,K)=VO(N,K)+WB*W12(N)*V12 WO(N,K)=WO(N,K)+WB*W12(N) ENDIF IF(LI(N22(N),K)) THEN U22=C22(N)*UI(N22(N),K)-S22(N)*VI(N22(N),K) V22=S22(N)*UI(N22(N),K)+C22(N)*VI(N22(N),K) UO(N,K)=UO(N,K)+WB*W22(N)*U22 VO(N,K)=VO(N,K)+WB*W22(N)*V22 WO(N,K)=WO(N,K)+WB*W22(N) ENDIF 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 UO(N,K)=UO(N,K)/WO(N,K) VO(N,K)=VO(N,K)/WO(N,K) UROT=CROT(N)*UO(N,K)-SROT(N)*VO(N,K) VROT=SROT(N)*UO(N,K)+CROT(N)*VO(N,K) UO(N,K)=UROT VO(N,K)=VROT ELSE IBO(K)=1 UO(N,K)=0. VO(N,K)=0. ENDIF ENDDO ENDDO IF(KGDSO(1).EQ.0) CALL POLFIXV(NO,MO,KM,RLAT,RLON,IBO,LO,UO,VO) ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END SUBROUTINE POLATEV3