C $Header: /u/gcmpack/MITgcm/model/src/calc_r_star.F,v 1.13 2007/10/29 18:15:29 jmc Exp $
C $Name: $
#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"
#ifdef ALLOW_EXCH2
# include "W2_OPTIONS.h"
#endif
CBOP
C !ROUTINE: CALC_R_STAR
C !INTERFACE:
SUBROUTINE CALC_R_STAR( etaFld, 2,2
I myTime, myIter, myThid )
C !DESCRIPTION: \bv
C *==========================================================*
C | SUBROUTINE CALC_R_STAR
C | o Calculate new column thickness & scaling factor for r*
C | according to the surface r-position (Non-Lin Free-Surf)
C *==========================================================*
C \ev
C !USES:
IMPLICIT NONE
C == Global variables
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "SURFACE.h"
C !INPUT/OUTPUT PARAMETERS:
C == Routine arguments ==
C myTime :: Current time in simulation
C myIter :: Current iteration number in simulation
C myThid :: Thread number for this instance of the routine.
C etaFld :: current eta field used to update the hFactor
_RL myTime
INTEGER myIter
INTEGER myThid
_RL etaFld(1-Olx:sNx+Olx,1-Oly:sNy+Oly,nSx,nSy)
#ifdef NONLIN_FRSURF
C !LOCAL VARIABLES:
C Local variables
C i,j,k,bi,bj :: loop counter
C numbWrite :: count the Number of warning written on STD-ERR file
C numbWrMax :: maximum Number of warning written on STD-ERR file
INTEGER i,j,k,bi,bj
INTEGER numbWrite, numbWrMax
INTEGER icntc1, icntc2, icntw, icnts
INTEGER iic, jjc, iic2, jjc2, iiw, jjw, iis, jjs
_RL tmpfldW, tmpfldS
c CHARACTER*(MAX_LEN_MBUF) suff
CEOP
#ifdef W2_FILL_NULL_REGIONS
INTEGER ii,jj
#endif
DATA numbWrite / 0 /
numbWrMax = Nx*Ny
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_ENTER
('CALC_R_STAR',myThid)
#endif
DO bj=myByLo(myThid), myByHi(myThid)
DO bi=myBxLo(myThid), myBxHi(myThid)
C- 1rst bi,bj loop :
C-- copy rStarFacX -> rStarExpX
DO j=1-Oly,sNy+Oly
DO i=1-Olx,sNx+Olx
rStarExpC(i,j,bi,bj) = rStarFacC(i,j,bi,bj)
rStarExpW(i,j,bi,bj) = rStarFacW(i,j,bi,bj)
rStarExpS(i,j,bi,bj) = rStarFacS(i,j,bi,bj)
ENDDO
ENDDO
C-- Compute the new column thikness :
DO j=0,sNy+1
DO i=0,sNx+1
IF (maskH(i,j,bi,bj).EQ.1. ) THEN
rStarFacC(i,j,bi,bj) =
& (etaFld(i,j,bi,bj)+Ro_surf(i,j,bi,bj)-R_low(i,j,bi,bj))
& *recip_Rcol(i,j,bi,bj)
ELSE
rStarFacC(i,j,bi,bj) = 1.
ENDIF
ENDDO
ENDDO
DO j=1,sNy
DO i=1,sNx+1
IF ( ksurfW(i,j,bi,bj).LE.Nr ) THEN
tmpfldW = MIN( Ro_surf(i-1,j,bi,bj), Ro_surf(i,j,bi,bj) )
& - MAX( R_low(i-1,j,bi,bj), R_low(i,j,bi,bj) )
rStarFacW(i,j,bi,bj) =
& ( 0.5 _d 0 *( etaFld(i-1,j,bi,bj)*rA(i-1,j,bi,bj)
& +etaFld(i,j,bi,bj)*rA(i,j,bi,bj)
& )*recip_rAw(i,j,bi,bj)
& +tmpfldW )/tmpfldW
ELSE
rStarFacW(i,j,bi,bj) = 1.
ENDIF
ENDDO
ENDDO
DO j=1,sNy+1
DO i=1,sNx
IF ( ksurfS(i,j,bi,bj).LE.Nr ) THEN
tmpfldS = MIN( Ro_surf(i,j-1,bi,bj), Ro_surf(i,j,bi,bj) )
& - MAX( R_low(i,j-1,bi,bj), R_low(i,j,bi,bj) )
rStarFacS(i,j,bi,bj) =
& ( 0.5 _d 0 *( etaFld(i,j-1,bi,bj)*rA(i,j-1,bi,bj)
& +etaFld(i,j,bi,bj)*rA(i,j,bi,bj)
& )*recip_rAs(i,j,bi,bj)
& +tmpfldS )/tmpfldS
ELSE
rStarFacS(i,j,bi,bj) = 1.
ENDIF
ENDDO
ENDDO
C- Needs to do something when r* ratio is too small ;
C for now, just stop
icntc1 = 0
icntc2 = 0
icntw = 0
icnts = 0
DO j=1,sNy+1
DO i=1,sNx+1
IF ( rStarFacC(i,j,bi,bj).LT.hFacInf ) THEN
icntc1 = icntc1 + 1
iic = i
jjc = j
ENDIF
IF ( rStarFacW(i,j,bi,bj).LT.hFacInf ) THEN
icntw = icntw + 1
iiw = i
jjw = j
ENDIF
IF ( rStarFacS(i,j,bi,bj).LT.hFacInf ) THEN
icnts = icnts + 1
iis = i
jjs = j
ENDIF
IF ( rStarFacC(i,j,bi,bj).GT.hFacSup ) THEN
icntc2 = icntc2 + 1
iic2 = i
jjc2 = j
ENDIF
ENDDO
ENDDO
IF ( icntc1+icnts+icntw .GT. 0 ) THEN
C- Print an error msg and then stop:
IF ( icntw .GT. 0 ) THEN
tmpfldW =
& MIN( Ro_surf(iiw-1,jjw,bi,bj),Ro_surf(iiw,jjw,bi,bj) )
& - MAX( R_low(iiw-1,jjw,bi,bj), R_low(iiw,jjw,bi,bj) )
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)')
& 'WARNING: r*FacW < hFacInf at',icntw,
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P3E14.6)')
& ' e.g. at i,j=',iiw,jjw,' ; rStarFac,H,eta =',
& rStarFacW(iiw,jjw,bi,bj), tmpfldW,
& etaFld(iiw-1,jjw,bi,bj), etaFld(iiw,jjw,bi,bj)
WRITE(errorMessageUnit,'(A)')
& 'STOP in CALC_R_STAR : too SMALL rStarFacW !'
ENDIF
IF ( icnts .GT. 0 ) THEN
tmpfldS =
& MIN( Ro_surf(iis,jjs-1,bi,bj),Ro_surf(iis,jjs,bi,bj) )
& - MAX( R_low(iis,jjs-1,bi,bj), R_low(iis,jjs,bi,bj) )
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)')
& 'WARNING: r*FacS < hFacInf at',icnts,
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P3E14.6)')
& ' e.g. at i,j=',iis,jjs,' ; rStarFac,H,eta =',
& rStarFacS(iis,jjs,bi,bj), tmpfldS,
& etaFld(iis,jjs-1,bi,bj), etaFld(iis,jjs,bi,bj)
WRITE(errorMessageUnit,'(A)')
& 'STOP in CALC_R_STAR : too SMALL rStarFacS !'
ENDIF
IF ( icntc1 .GT. 0 ) THEN
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)')
& 'WARNING: r*FacC < hFacInf at',icntc1,
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P2E14.6)')
& ' e.g. at i,j=',iic,jjc,' ; rStarFac,H,eta =',
& rStarFacC(iic,jjc,bi,bj),
& Ro_surf(iic,jjc,bi,bj)-R_low(iic,jjc,bi,bj),
& etaFld(iic,jjc,bi,bj)
WRITE(errorMessageUnit,'(A)')
& 'STOP in CALC_R_STAR : too SMALL rStarFacC !'
ENDIF
STOP 'ABNORMAL END: S/R CALC_R_STAR'
ENDIF
C-- Usefull warning when r*Fac becomes very large:
IF ( icntc2.GT.0 .AND. numbWrite.LE.numbWrMax ) THEN
numbWrite = numbWrite + 1
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)')
& 'WARNING: r*FacC > hFacSup at',icntc2,
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P2E14.6)')
& ' e.g. at i,j=',iic2,jjc2,' ; rStarFac,H,eta =',
& rStarFacC(iic2,jjc2,bi,bj),
& Ro_surf(iic2,jjc2,bi,bj)-R_low(iic2,jjc2,bi,bj),
& etaFld(iic2,jjc2,bi,bj)
ENDIF
C- end 1rst bi,bj loop.
ENDDO
ENDDO
_EXCH_XY_RL( rStarFacC, myThid )
CALL EXCH_UV_XY_RL(rStarFacW,rStarFacS,.FALSE.,myThid)
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
DO bj=myByLo(myThid), myByHi(myThid)
DO bi=myBxLo(myThid), myBxHi(myThid)
C- 2nd bi,bj loop :
#ifdef ALLOW_EXCH2
#ifdef W2_FILL_NULL_REGIONS
C- Note: rStarFacC was non-zero EVERYWHERE before exch, but exch2 put zeros
C in the corner regions of the tile (e.g.:[1-Olx:0,1-Oly:0])
C => need to add those lines (or to fix exch2):
DO j=1,Oly
DO i=1,Olx
ii = sNx+i
jj = sNy+j
IF (ksurfC(1-i,1-j,bi,bj).GT.Nr) rStarFacC(1-i,1-j,bi,bj)= 1.
IF (ksurfC(ii, 1-j,bi,bj).GT.Nr) rStarFacC(ii, 1-j,bi,bj)= 1.
IF (ksurfC(1-i,jj, bi,bj).GT.Nr) rStarFacC(1-i,jj, bi,bj)= 1.
IF (ksurfC(ii, jj, bi,bj).GT.Nr) rStarFacC(ii, jj, bi,bj)= 1.
IF (ksurfW(1-i,1-j,bi,bj).GT.Nr) rStarFacW(1-i,1-j,bi,bj)= 1.
IF (ksurfW(ii, 1-j,bi,bj).GT.Nr) rStarFacW(ii, 1-j,bi,bj)= 1.
IF (ksurfW(1-i,jj, bi,bj).GT.Nr) rStarFacW(1-i,jj, bi,bj)= 1.
IF (ksurfW(ii, jj, bi,bj).GT.Nr) rStarFacW(ii, jj, bi,bj)= 1.
IF (ksurfS(1-i,1-j,bi,bj).GT.Nr) rStarFacS(1-i,1-j,bi,bj)= 1.
IF (ksurfS(ii, 1-j,bi,bj).GT.Nr) rStarFacS(ii, 1-j,bi,bj)= 1.
IF (ksurfS(1-i,jj, bi,bj).GT.Nr) rStarFacS(1-i,jj, bi,bj)= 1.
IF (ksurfS(ii, jj, bi,bj).GT.Nr) rStarFacS(ii, jj, bi,bj)= 1.
ENDDO
ENDDO
#endif /* W2_FILL_NULL_REGIONS */
#endif /* ALLOW_EXCH2 */
DO j=1-Oly,sNy+Oly
DO i=1-Olx,sNx+Olx
rStarDhCDt(i,j,bi,bj)=(rStarFacC(i,j,bi,bj)
& -rStarExpC(i,j,bi,bj))/deltaTfreesurf
rStarDhWDt(i,j,bi,bj)=(rStarFacW(i,j,bi,bj)
& -rStarExpW(i,j,bi,bj))/deltaTfreesurf
rStarDhSDt(i,j,bi,bj)=(rStarFacS(i,j,bi,bj)
& -rStarExpS(i,j,bi,bj))/deltaTfreesurf
rStarExpC(i,j,bi,bj) = rStarFacC(i,j,bi,bj)
& / rStarExpC(i,j,bi,bj)
rStarExpW(i,j,bi,bj) = rStarFacW(i,j,bi,bj)
& / rStarExpW(i,j,bi,bj)
rStarExpS(i,j,bi,bj) = rStarFacS(i,j,bi,bj)
& / rStarExpS(i,j,bi,bj)
ENDDO
ENDDO
C- end 2nd bi,bj loop.
ENDDO
ENDDO
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_LEAVE('CALC_R_STAR',myThid)
#endif
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
#endif /* NONLIN_FRSURF */
RETURN
END