C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagnostics_fill_field.F,v 1.8 2017/07/23 00:35:53 jmc Exp $ C $Name: $ #include "DIAG_OPTIONS.h" C-- File diagnostics_fill_field.F: C-- Contents: C-- o DIAGNOSTICS_FILL_FIELD C-- o DIAGNOSTICS_HF_CUMUL C-- o DIAGNOSTICS_CUMULATE C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| CBOP C !ROUTINE: DIAGNOSTICS_FILL_FIELD C !INTERFACE: SUBROUTINE DIAGNOSTICS_FILL_FIELD( I inpFldRL, fracFldRL, inpFldRS, fracFldRS, I scaleFact, power, arrType, nLevFrac, I ndId, ipointer, kLev, nLevs, I bibjFlg, biArg, bjArg, myThid ) C !DESCRIPTION: C*********************************************************************** C Increment the diagnostics array with a 2D/3D field C using a scaling factor & square option (power=2), C and with the option to use a fraction-weight (assumed C to be the counter-mate of the current diagnostics) C*********************************************************************** C !USES: IMPLICIT NONE C == Global variables === #include "EEPARAMS.h" #include "SIZE.h" #include "DIAGNOSTICS_SIZE.h" #include "DIAGNOSTICS.h" C !INPUT PARAMETERS: C*********************************************************************** C Arguments Description C ---------------------- C inpFldRL :: Field to increment diagnostics array (arrType=0,1) C fracFldRL :: fraction used for weighted average diagnostics (arrType=0,2) C inpFldRS :: Field to increment diagnostics array (arrType=2,3) C fracFldRS :: fraction used for weighted average diagnostics (arrType=1,3) C scaleFact :: scaling factor C power :: option to fill-in with the field square (power=2) C arrType :: select which array & fraction (RL/RS) to process: C 0: both RL ; 1: inpRL & fracRS ; 2: inpRS,fracRL ; 3: both RS C nLevFrac :: >0: number of levels of the fraction field ; =0: no fraction C :: used ; =-1: use thickness factor "hFac" C ndId :: Diagnostics Id number (in available diag list) of diag to process C ipointer :: Pointer to the slot in qdiag to fill C kLev :: Integer flag for vertical levels: C > 0 (any integer): WHICH single level to increment in qdiag. C 0,-1 to increment "nLevs" levels in qdiag, C 0 : fill-in in the same order as the input array C -1: fill-in in reverse order. C nLevs :: indicates Number of levels of the input field array C (whether to fill-in all the levels (kLev<1) or just one (kLev>0)) C bibjFlg :: Integer flag to indicate instructions for bi bj loop C 0 indicates that the bi-bj loop must be done here C 1 indicates that the bi-bj loop is done OUTSIDE C 2 indicates that the bi-bj loop is done OUTSIDE C AND that we have been sent a local array (with overlap regions) C 3 indicates that the bi-bj loop is done OUTSIDE C AND that we have been sent a local array C AND that the array has no overlap region (interior only) C NOTE - bibjFlg can be NEGATIVE to indicate not to increment counter C biArg :: X-direction tile number - used for bibjFlg=1-3 C bjArg :: Y-direction tile number - used for bibjFlg=1-3 C myThid :: my thread Id number C*********************************************************************** C NOTE: User beware! If a local (1 tile only) array C is sent here, bibjFlg MUST NOT be set to 0 C or there will be out of bounds problems! C*********************************************************************** _RL inpFldRL(*) _RL fracFldRL(*) _RS inpFldRS(*) _RS fracFldRS(*) _RL scaleFact INTEGER power INTEGER arrType INTEGER nLevFrac INTEGER ndId, ipointer INTEGER kLev, nLevs, bibjFlg, biArg, bjArg INTEGER myThid CEOP C !LOCAL VARIABLES: C =============== C useFract :: flag to increment (or not) with fraction-weighted inpFld C thickFac :: if > 0, to increment with thickness-weighted inpFld LOGICAL useFract INTEGER sizF, thickFac INTEGER sizI1,sizI2,sizJ1,sizJ2 INTEGER sizTx,sizTy INTEGER iRun, jRun, k, bi, bj INTEGER kFirst, kLast INTEGER kd, kd0, ksgn, km, kStore CHARACTER*8 parms1 CHARACTER*(MAX_LEN_MBUF) msgBuf C If-sequence to see if we are a valid and an active diagnostic c IF ( ndId.NE.0 .AND. ipointer.NE.0 ) THEN IF ( bibjFlg.GE.0 .AND. ABS(kLev).LE.1 ) THEN C Increment the counter for the diagnostic IF ( bibjFlg.EQ.0 ) THEN DO bj=myByLo(myThid), myByHi(myThid) DO bi=myBxLo(myThid), myBxHi(myThid) ndiag(ipointer,bi,bj) = ndiag(ipointer,bi,bj) + 1 ENDDO ENDDO ELSE bi = MIN(biArg,nSx) bj = MIN(bjArg,nSy) ndiag(ipointer,bi,bj) = ndiag(ipointer,bi,bj) + 1 ENDIF ENDIF C- select range for 1rst & 2nd indices to accumulate C depending on variable location on C-grid, thickFac = 0 parms1 = gdiag(ndId)(1:8) IF ( parms1(2:2).EQ.'M' ) THEN iRun = sNx jRun = sNy thickFac = 1 ELSEIF ( parms1(2:2).EQ.'U' ) THEN iRun = sNx+1 jRun = sNy thickFac = 2 ELSEIF ( parms1(2:2).EQ.'V' ) THEN iRun = sNx jRun = sNy+1 thickFac = 3 ELSEIF ( parms1(2:2).EQ.'Z' ) THEN iRun = sNx+1 jRun = sNy+1 ELSE iRun = sNx jRun = sNy ENDIF C- Dimension of the input array: IF (ABS(bibjFlg).EQ.3) THEN sizI1 = 1 sizI2 = sNx sizJ1 = 1 sizJ2 = sNy iRun = sNx jRun = sNy ELSE sizI1 = 1-OLx sizI2 = sNx+OLx sizJ1 = 1-OLy sizJ2 = sNy+OLy ENDIF IF (ABS(bibjFlg).GE.2) THEN sizTx = 1 sizTy = 1 ELSE sizTx = nSx sizTy = nSy ENDIF C- Which part of inpFld to add : k = 3rd index, C and do the loop >> do k=kFirst,kLast << IF (kLev.LE.0) THEN kFirst = 1 kLast = nLevs ELSEIF ( nLevs.EQ.1 ) THEN kFirst = 1 kLast = 1 ELSEIF ( kLev.LE.nLevs ) THEN kFirst = kLev kLast = kLev ELSE STOP 'ABNORMAL END in DIAGNOSTICS_FILL_FIELD: kLev > nLevs >0' ENDIF C- Which part of qdiag to update: kd = 3rd index, C and do the loop >> do k=kFirst,kLast ; kd = kd0 + k*ksgn << IF ( kLev.EQ.-1 ) THEN ksgn = -1 kd0 = ipointer + nLevs ELSEIF ( kLev.EQ.0 ) THEN ksgn = 1 kd0 = ipointer - 1 ELSE ksgn = 0 kd0 = ipointer + kLev - 1 ENDIF C- Set thickness and fraction-weight option : IF ( nLevFrac.GE.0 ) thickFac = 0 useFract = nLevFrac.GT.0 IF ( useFract ) THEN sizF = nLevFrac ELSE sizF = 1 ENDIF C- Check for consistency with Nb of levels reserved in storage array kStore = kd0 + MAX(ksgn*kFirst,ksgn*kLast) - ipointer + 1 IF ( kStore.GT.kdiag(ndId) ) THEN _BEGIN_MASTER(myThid) WRITE(msgBuf,'(2A,I4,A)') 'DIAGNOSTICS_FILL_FIELD: ', & 'exceed Nb of levels(=',kdiag(ndId),' ) reserved ' CALL PRINT_ERROR( msgBuf , myThid ) WRITE(msgBuf,'(2A,I6,2A)') 'DIAGNOSTICS_FILL_FIELD: ', & 'for Diagnostics #', ndId, ' : ', cdiag(ndId) CALL PRINT_ERROR( msgBuf , myThid ) WRITE(msgBuf,'(2A,2I4,I3)') 'calling DIAGNOSTICS_FILL_FIELD ', I 'with kLev,nLevs,bibjFlg=', kLev,nLevs,bibjFlg CALL PRINT_ERROR( msgBuf , myThid ) WRITE(msgBuf,'(2A,I6,A)') 'DIAGNOSTICS_FILL_FIELD: ', I '==> trying to store up to ', kStore, ' levels' CALL PRINT_ERROR( msgBuf , myThid ) STOP 'ABNORMAL END: S/R DIAGNOSTICS_FILL_FIELD' _END_MASTER(myThid) ENDIF IF ( bibjFlg.EQ.0 ) THEN DO bj=myByLo(myThid), myByHi(myThid) DO bi=myBxLo(myThid), myBxHi(myThid) DO k = kFirst,kLast kd = kd0 + ksgn*k IF ( thickFac.EQ.0 ) THEN CALL DIAGNOSTICS_CUMULATE( U qdiag(1-OLx,1-OLy,kd,bi,bj), I inpFldRL, fracFldRL, inpFldRS, fracFldRS, I scaleFact, power, arrType, useFract, sizF, I sizI1,sizI2,sizJ1,sizJ2,nLevs,sizTx,sizTy, I iRun, jRun, k, bi, bj, I myThid ) ELSE km = kd - ipointer + 1 CALL DIAGNOSTICS_HF_CUMUL( U qdiag(1-OLx,1-OLy,kd,bi,bj), I inpFldRL, inpFldRS, I scaleFact, power, arrType, thickFac, I sizI1,sizI2,sizJ1,sizJ2,nLevs,sizTx,sizTy, I iRun, jRun, k, km, I bi, bj, myThid ) ENDIF ENDDO ENDDO ENDDO ELSE bi = MIN(biArg,sizTx) bj = MIN(bjArg,sizTy) DO k = kFirst,kLast kd = kd0 + ksgn*k IF ( thickFac.EQ.0 ) THEN CALL DIAGNOSTICS_CUMULATE( U qdiag(1-OLx,1-OLy,kd,biArg,bjArg), I inpFldRL, fracFldRL, inpFldRS, fracFldRS, I scaleFact, power, arrType, useFract, sizF, I sizI1,sizI2,sizJ1,sizJ2,nLevs,sizTx,sizTy, I iRun, jRun, k, bi, bj, I myThid ) ELSE km = kd - ipointer + 1 CALL DIAGNOSTICS_HF_CUMUL( U qdiag(1-OLx,1-OLy,kd,biArg,bjArg), I inpFldRL, inpFldRS, I scaleFact, power, arrType, thickFac, I sizI1,sizI2,sizJ1,sizJ2,nLevs,sizTx,sizTy, I iRun, jRun, k, km, I biArg, bjArg, myThid ) ENDIF ENDDO ENDIF C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| c ELSE c IF (myThid.EQ.1) WRITE(6,1000) cdiag(ndId) c ENDIF c1000 format(' ',' Warning: Trying to write to diagnostic ',a8, c & ' But it is not a valid (or active) name ') RETURN END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| CBOP C !ROUTINE: DIAGNOSTICS_HF_CUMUL C !INTERFACE: SUBROUTINE DIAGNOSTICS_HF_CUMUL( U cumFld, I inpFldRL, inpFldRS, I scaleFact, power, arrType, thickFac, I sizI1,sizI2,sizJ1,sizJ2,sizK,sizTx,sizTy, I iRun, jRun, k, km, I bi, bj, myThid ) C !DESCRIPTION: C Update array cumFld C by adding content of input field array inpFld C weighted by thickness factor "hFac" C over the range [1:iRun],[1:jRun] C !USES: IMPLICIT NONE #include "EEPARAMS.h" #include "SIZE.h" #include "GRID.h" C !INPUT/OUTPUT PARAMETERS: C == Routine Arguments == C cumFld :: cumulative array (updated) C inpFldRL :: input field array to add to cumFld (arrType=0,1) C inpFldRS :: input field array to add to cumFld (arrType=2,3) C scaleFact :: scaling factor C power :: option to fill-in with the field square (power=2) C arrType :: select which array & fraction (RL/RS) to process: C 0: both RL ; 1: inpRL & fracRS ; 2: inpRS,fracRL ; 3: both RS C thickFac :: which hFac array to use: 1,2,3 = hFacC,W,S C sizI1,sizI2 :: size of inpFld array: 1rst index range (min,max) C sizJ1,sizJ2 :: size of inpFld array: 2nd index range (min,max) C sizK :: size of inpFld array: 3rd dimension C sizTx,sizTy :: size of inpFld array: tile dimensions C iRun,jRun :: range of 1rst & 2nd index C k :: level of inpFld array to add to cumFld array C km :: level of hFac array to use as weight for inpFld C bi, bj :: indices of tile to process (cumulate in qdiag) C myThid :: my Thread Id number _RL cumFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy) INTEGER sizI1,sizI2,sizJ1,sizJ2 INTEGER sizK,sizTx,sizTy _RL inpFldRL(sizI1:sizI2,sizJ1:sizJ2,sizK,sizTx,sizTy) _RS inpFldRS(sizI1:sizI2,sizJ1:sizJ2,sizK,sizTx,sizTy) _RL scaleFact INTEGER power INTEGER arrType, thickFac INTEGER iRun, jRun, k, km, bi, bj INTEGER myThid CEOP C !LOCAL VARIABLES: C i, j :: loop indices C ti, tj :: tile indices of inpFld to process INTEGER i, j INTEGER ti, tj _RL tmpFld(sNx+1,sNy+1) C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| ti = MIN(bi,sizTx) tj = MIN(bj,sizTy) IF ( arrType.EQ.0 .OR. arrType.EQ.1 ) THEN DO j = 1,jRun DO i = 1,iRun tmpFld(i,j) = scaleFact*inpFldRL(i,j,k,ti,tj) ENDDO ENDDO ELSEIF ( arrType.EQ.2 .OR. arrType.EQ.3 ) THEN DO j = 1,jRun DO i = 1,iRun tmpFld(i,j) = scaleFact*inpFldRS(i,j,k,ti,tj) ENDDO ENDDO ELSE STOP 'DIAGNOSTICS_HF_CUMUL: invalid arrType' ENDIF IF ( power.EQ.2 ) THEN DO j = 1,jRun DO i = 1,iRun tmpFld(i,j) = tmpFld(i,j)*tmpFld(i,j) ENDDO ENDDO ENDIF IF ( thickFac.EQ.1 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFld(i,j)*hFacC(i,j,km,bi,bj) ENDDO ENDDO ELSEIF ( thickFac.EQ.2 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFld(i,j)*hFacW(i,j,km,bi,bj) ENDDO ENDDO ELSEIF ( thickFac.EQ.3 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFld(i,j)*hFacS(i,j,km,bi,bj) ENDDO ENDDO ELSE DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) + tmpFld(i,j) ENDDO ENDDO ENDIF RETURN END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| CBOP C !ROUTINE: DIAGNOSTICS_CUMULATE C !INTERFACE: SUBROUTINE DIAGNOSTICS_CUMULATE( U cumFld, I inpFldRL, frcFldRL, inpFldRS, frcFldRS, I scaleFact, power, arrType, useFract, sizF, I sizI1,sizI2,sizJ1,sizJ2,sizK,sizTx,sizTy, I iRun, jRun, k, bi, bj, I myThid ) C !DESCRIPTION: C Update array cumFld C by adding content of input field array inpFld C over the range [1:iRun],[1:jRun] C !USES: IMPLICIT NONE #include "EEPARAMS.h" #include "SIZE.h" C !INPUT/OUTPUT PARAMETERS: C == Routine Arguments == C cumFld :: cumulative array (updated) C inpFldRL :: input field array to add to cumFld (arrType=0,1) C frcFldRL :: fraction used for weighted-average diagnostics (arrType=0,2) C inpFldRS :: input field array to add to cumFld (arrType=2,3) C frcFldRS :: fraction used for weighted-average diagnostics (arrType=1,3) C scaleFact :: scaling factor C power :: option to fill-in with the field square (power=2) C arrType :: select which array & fraction (RL/RS) to process: C 0: both RL ; 1: inpRL & fracRS ; 2: inpRS,fracRL ; 3: both RS C useFract :: if True, use fraction-weight C sizF :: size of frcFld array: 3rd dimension C sizI1,sizI2 :: size of inpFld array: 1rst index range (min,max) C sizJ1,sizJ2 :: size of inpFld array: 2nd index range (min,max) C sizK :: size of inpFld array: 3rd dimension C sizTx,sizTy :: size of inpFld array: tile dimensions C iRun,jRun :: range of 1rst & 2nd index C k,bi,bj :: level and tile indices of inpFld array to add to cumFld array C myThid :: my Thread Id number _RL cumFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy) INTEGER sizI1,sizI2,sizJ1,sizJ2 INTEGER sizF,sizK,sizTx,sizTy _RL inpFldRL(sizI1:sizI2,sizJ1:sizJ2,sizK,sizTx,sizTy) _RL frcFldRL(sizI1:sizI2,sizJ1:sizJ2,sizF,sizTx,sizTy) _RS inpFldRS(sizI1:sizI2,sizJ1:sizJ2,sizK,sizTx,sizTy) _RS frcFldRS(sizI1:sizI2,sizJ1:sizJ2,sizF,sizTx,sizTy) _RL scaleFact INTEGER power INTEGER arrType LOGICAL useFract INTEGER iRun, jRun, k, bi, bj INTEGER myThid CEOP C !LOCAL VARIABLES: C i,j :: loop indices INTEGER i, j, l _RL tmpFact C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| tmpFact = scaleFact IF ( power.EQ.2 ) tmpFact = scaleFact*scaleFact IF ( useFract .AND. power.EQ.2 ) THEN l = MIN(k,sizF) IF ( arrType.EQ.0 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRL(i,j,k,bi,bj) & *inpFldRL(i,j,k,bi,bj) & *frcFldRL(i,j,l,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.1 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRL(i,j,k,bi,bj) & *inpFldRL(i,j,k,bi,bj) & *frcFldRS(i,j,l,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.2 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRS(i,j,k,bi,bj) & *inpFldRS(i,j,k,bi,bj) & *frcFldRL(i,j,l,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.3 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRS(i,j,k,bi,bj) & *inpFldRS(i,j,k,bi,bj) & *frcFldRS(i,j,l,bi,bj) ENDDO ENDDO ELSE STOP 'DIAGNOSTICS_CUMULATE: invalid arrType' ENDIF ELSEIF ( useFract ) THEN l = MIN(k,sizF) IF ( arrType.EQ.0 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRL(i,j,k,bi,bj) & *frcFldRL(i,j,l,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.1 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRL(i,j,k,bi,bj) & *frcFldRS(i,j,l,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.2 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRS(i,j,k,bi,bj) & *frcFldRL(i,j,l,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.3 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRS(i,j,k,bi,bj) & *frcFldRS(i,j,l,bi,bj) ENDDO ENDDO ELSE STOP 'DIAGNOSTICS_CUMULATE: invalid arrType' ENDIF ELSEIF ( power.EQ.2 ) THEN IF ( arrType.EQ.0 .OR. arrType.EQ.1 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRL(i,j,k,bi,bj) & *inpFldRL(i,j,k,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.2 .OR. arrType.EQ.3 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRS(i,j,k,bi,bj) & *inpFldRS(i,j,k,bi,bj) ENDDO ENDDO ELSE STOP 'DIAGNOSTICS_CUMULATE: invalid arrType' ENDIF ELSE IF ( arrType.EQ.0 .OR. arrType.EQ.1 ) THEN DO j = 1,jRun DO i = 1,iRun C- jmc: try with fixed ranges, that are known at compiling stage C (might produce a better cash optimisation ?) c DO j = 1,sNy c DO i = 1,sNx cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRL(i,j,k,bi,bj) ENDDO ENDDO ELSEIF ( arrType.EQ.2 .OR. arrType.EQ.3 ) THEN DO j = 1,jRun DO i = 1,iRun cumFld(i,j) = cumFld(i,j) & + tmpFact*inpFldRS(i,j,k,bi,bj) ENDDO ENDDO ELSE STOP 'DIAGNOSTICS_CUMULATE: invalid arrType' ENDIF ENDIF RETURN END