model/src/calc_grad_phi_hyd.F

C $Header: /u/gcmpack/MITgcm/model/src/calc_grad_phi_hyd.F,v 1.6 2003/08/04 13:20:13 jmc Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: CALC_GRAD_PHI_HYD
C     !INTERFACE:
      SUBROUTINE CALC_GRAD_PHI_HYD( 
     I                       k, bi, bj, iMin,iMax, jMin,jMax,
     I                       phiHydC, alphRho, tFld, sFld,
     O                       dPhiHydX, dPhiHydY,
     I                       myTime, myIter, myThid)
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | S/R CALC_GRAD_PHI_HYD                                    
C     | o Calculate the gradient of Hydrostatic potential anomaly 
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"
#include "DYNVARS.h"

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine Arguments ==
C     bi,bj      :: tile index            
C     iMin,iMax,jMin,jMax :: Loop counters
C     phiHydC    :: Hydrostatic Potential anomaly 
C                  (atmos: =Geopotential ; ocean-z: =Pressure/rho)
C     alphRho    :: Density (z-coord) or specific volume (p-coord)
C     tFld       :: Potential temp.
C     sFld       :: Salinity 
C     dPhiHydX,Y :: Gradient (X & Y directions) of Hyd. Potential
C     myTime :: Current time
C     myIter :: Current iteration number
C     myThid :: Instance number for this call of the routine.
      INTEGER k, bi,bj, iMin,iMax, jMin,jMax
c     _RL phiHyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
      _RL phiHydC(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL alphRho(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL tFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL sFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL myTime
      INTEGER myIter, myThid

#ifdef INCLUDE_PHIHYD_CALCULATION_CODE

C     !LOCAL VARIABLES:
C     == Local variables ==
C     i,j :: Loop counters
      INTEGER i,j
      _RL varLoc(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
#ifdef NONLIN_FRSURF
      _RL factorZ, factorP, conv_theta2T
      _RL factPI
      CHARACTER*(MAX_LEN_MBUF) msgBuf
#endif
CEOP

#ifdef NONLIN_FRSURF
      IF (select_rStar.GE.2 .AND. nonlinFreeSurf.GE.4 ) THEN
C-    Integral of b.dr = rStarFac * Integral of b.dr* :
C      and will add later (select_rStar=2) the contribution of 
C      the slope of the r* coordinate.
       IF ( buoyancyRelation .EQ. 'ATMOSPHERIC' ) THEN
C-     Consistent with Phi'= Integr[ theta'.dPi ] :
        DO j=jMin-1,jMax
         DO i=iMin-1,iMax
          varLoc(i,j) = phiHydC(i,j)*rStarFacC(i,j,bi,bj)**atm_kappa
     &                + phi0surf(i,j,bi,bj)
         ENDDO
        ENDDO
       ELSE
        DO j=jMin-1,jMax
         DO i=iMin-1,iMax
          varLoc(i,j) = phiHydC(i,j)*rStarFacC(i,j,bi,bj)
     &                + phi0surf(i,j,bi,bj)
         ENDDO
        ENDDO
       ENDIF
      ELSEIF (select_rStar.GE.1 .AND. nonlinFreeSurf.GE.4 ) THEN
C-    Integral of b.dr but scaled to correspond to a fixed r-level (=r*)
C      no contribution of the slope of the r* coordinate (select_rStar=1)
       IF ( buoyancyRelation .EQ. 'ATMOSPHERIC' ) THEN
C-     Consistent with Phi'= Integr[ theta'.dPi ] :
        DO j=jMin-1,jMax
         DO i=iMin-1,iMax
          IF (Ro_surf(i,j,bi,bj).EQ.rC(k)) THEN
           factPI=atm_Cp*( ((etaH(i,j,bi,bj)+rC(k))/atm_Po)**atm_kappa  
     &                    -(                 rC(k) /atm_Po)**atm_kappa 
     &                  )
           varLoc(i,j) = factPI*alphRho(i,j)
          ELSEIF (Ro_surf(i,j,bi,bj).NE.0. _d 0) THEN
           factPI = (rC(k)/Ro_surf(i,j,bi,bj))**atm_kappa
           varLoc(i,j) = phiHydC(i,j)
     &                  *(rStarFacC(i,j,bi,bj)**atm_kappa - factPI)
     &                  /(1. _d 0 -factPI)
     &                 + phi0surf(i,j,bi,bj)
          ENDIF
         ENDDO
        ENDDO
       ELSE
        DO j=jMin-1,jMax
         DO i=iMin-1,iMax
          IF (Ro_surf(i,j,bi,bj).EQ.rC(k)) THEN
           WRITE(msgBuf,'(3A)') 'CALC_GRAD_PHI_HYD: ',
     &      'Problem when Ro_surf=rC',
     &      ' with select_rStar,integr_GeoPot=1,4'
           CALL PRINT_ERROR( msgBuf , myThid)
           STOP 'CALC_GRAD_PHI_HYD: Pb in r* options implementation'
          ELSE
           varLoc(i,j) = phiHydC(i,j)
     &                  *(etaH(i,j,bi,bj)+Ro_surf(i,j,bi,bj)-rC(k))
     &                  /                (Ro_surf(i,j,bi,bj)-rC(k))
     &                 + phi0surf(i,j,bi,bj)
          ENDIF
         ENDDO
        ENDDO
       ENDIF
      ELSE
#else /* NONLIN_FRSURF */
      IF (.TRUE.) THEN
#endif /* NONLIN_FRSURF */
       DO j=jMin-1,jMax
        DO i=iMin-1,iMax
         varLoc(i,j) = phiHydC(i,j)+phi0surf(i,j,bi,bj)
        ENDDO
       ENDDO
      ENDIF

C--   Zonal & Meridional gradient of potential anomaly
      DO j=jMin,jMax
       DO i=iMin,iMax
        dPhiHydX(i,j) = _recip_dxC(i,j,bi,bj)
     &                *( varLoc(i,j)-varLoc(i-1,j) )
        dPhiHydY(i,j) = _recip_dyC(i,j,bi,bj)
     &                *( varLoc(i,j)-varLoc(i,j-1) )
       ENDDO
      ENDDO

#ifdef NONLIN_FRSURF
      IF (select_rStar.GE.2 .AND. nonlinFreeSurf.GE.1 ) THEN
       IF ( buoyancyRelation .EQ. 'OCEANIC' ) THEN
C--    z* coordinate slope term: rho'/rho0 * Grad_r(g.z)
        factorZ = gravity*recip_rhoConst*0.5 _d 0
        DO j=jMin-1,jMax
         DO i=iMin-1,iMax
          varLoc(i,j) = etaH(i,j,bi,bj)
     &                *(1. _d 0 + rC(k)*recip_Rcol(i,j,bi,bj))
         ENDDO
        ENDDO
        DO j=jMin,jMax
         DO i=iMin,iMax
          dPhiHydX(i,j) = dPhiHydX(i,j)
     &     +factorZ*(alphRho(i-1,j)+alphRho(i,j))
     &             *(varLoc(i,j)-varLoc(i-1,j))
     &             *recip_dxC(i,j,bi,bj)
          dPhiHydY(i,j) = dPhiHydY(i,j)
     &     +factorZ*(alphRho(i,j-1)+alphRho(i,j))
     &             *(varLoc(i,j)-varLoc(i,j-1))
     &             *recip_dyC(i,j,bi,bj)   
         ENDDO
        ENDDO
       ELSEIF (buoyancyRelation .EQ. 'OCEANICP' ) THEN
C--    p* coordinate slope term: alpha' * Grad_r( p )
        factorP = 0.5 _d 0
        DO j=jMin,jMax
         DO i=iMin,iMax
          dPhiHydX(i,j) = dPhiHydX(i,j)
     &     +factorP*(alphRho(i-1,j)+alphRho(i,j))
     &             *(rStarFacC(i,j,bi,bj)-rStarFacC(i-1,j,bi,bj))
     &             *rC(k)*recip_dxC(i,j,bi,bj)   
          dPhiHydY(i,j) = dPhiHydY(i,j)
     &     +factorP*(alphRho(i,j-1)+alphRho(i,j))
     &             *(rStarFacC(i,j,bi,bj)-rStarFacC(i,j-1,bi,bj))
     &             *rC(k)*recip_dyC(i,j,bi,bj)   
         ENDDO
        ENDDO
       ELSEIF ( buoyancyRelation .EQ. 'ATMOSPHERIC' ) THEN
C--    p* coordinate slope term: alpha' * Grad_r( p )
        conv_theta2T = (rC(k)/atm_Po)**atm_kappa
        factorP = (atm_Rd/rC(k))*conv_theta2T*0.5 _d 0
        DO j=jMin,jMax
         DO i=iMin,iMax
          dPhiHydX(i,j) = dPhiHydX(i,j)
     &     +factorP*(alphRho(i-1,j)+alphRho(i,j))
     &             *(rStarFacC(i,j,bi,bj)-rStarFacC(i-1,j,bi,bj))
     &             *rC(k)*recip_dxC(i,j,bi,bj)   
          dPhiHydY(i,j) = dPhiHydY(i,j)
     &     +factorP*(alphRho(i,j-1)+alphRho(i,j))
     &             *(rStarFacC(i,j,bi,bj)-rStarFacC(i,j-1,bi,bj))
     &             *rC(k)*recip_dyC(i,j,bi,bj)   
         ENDDO
        ENDDO
       ENDIF
      ENDIF
#endif /* NONLIN_FRSURF */

#endif /* INCLUDE_PHIHYD_CALCULATION_CODE */

      RETURN
      END
1	jmc	1.7	C $Header: /u/gcmpack/MITgcm/model/src/calc_grad_phi_hyd.F,v 1.6 2003/08/04 13:20:13 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#include "CPP_OPTIONS.h"
5
6			CBOP
7			C !ROUTINE: CALC_GRAD_PHI_HYD
8			C !INTERFACE:
9			SUBROUTINE CALC_GRAD_PHI_HYD(
10			I k, bi, bj, iMin,iMax, jMin,jMax,
11	jmc	1.3	I phiHydC, alphRho, tFld, sFld,
12	jmc	1.1	O dPhiHydX, dPhiHydY,
13			I myTime, myIter, myThid)
14			C !DESCRIPTION: \bv
15			C ==========================================================
16			C \| S/R CALC_GRAD_PHI_HYD
17			C \| o Calculate the gradient of Hydrostatic potential anomaly
18			C ==========================================================
19			C \ev
20
21			C !USES:
22			IMPLICIT NONE
23			C == Global variables ==
24			#include "SIZE.h"
25			#include "EEPARAMS.h"
26			#include "PARAMS.h"
27			#include "GRID.h"
28			#include "SURFACE.h"
29	jmc	1.3	#include "DYNVARS.h"
30	jmc	1.1
31			C !INPUT/OUTPUT PARAMETERS:
32			C == Routine Arguments ==
33			C bi,bj :: tile index
34			C iMin,iMax,jMin,jMax :: Loop counters
35	jmc	1.3	C phiHydC :: Hydrostatic Potential anomaly
36	jmc	1.1	C (atmos: =Geopotential ; ocean-z: =Pressure/rho)
37			C alphRho :: Density (z-coord) or specific volume (p-coord)
38			C tFld :: Potential temp.
39			C sFld :: Salinity
40			C dPhiHydX,Y :: Gradient (X & Y directions) of Hyd. Potential
41			C myTime :: Current time
42			C myIter :: Current iteration number
43			C myThid :: Instance number for this call of the routine.
44			INTEGER k, bi,bj, iMin,iMax, jMin,jMax
45	jmc	1.3	c _RL phiHyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
46			_RL phiHydC(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
47	jmc	1.1	_RL alphRho(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
48			_RL tFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
49			_RL sFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
50			_RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
51			_RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
52			_RL myTime
53			INTEGER myIter, myThid
54
55			#ifdef INCLUDE_PHIHYD_CALCULATION_CODE
56
57			C !LOCAL VARIABLES:
58			C == Local variables ==
59			C i,j :: Loop counters
60			INTEGER i,j
61			_RL varLoc(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
62	jmc	1.7	#ifdef NONLIN_FRSURF
63	jmc	1.3	_RL factorZ, factorP, conv_theta2T
64	jmc	1.5	_RL factPI
65			CHARACTER*(MAX_LEN_MBUF) msgBuf
66	jmc	1.7	#endif
67	jmc	1.1	CEOP
68
69	jmc	1.3	#ifdef NONLIN_FRSURF
70	jmc	1.5	IF (select_rStar.GE.2 .AND. nonlinFreeSurf.GE.4 ) THEN
71			C- Integral of b.dr = rStarFac * Integral of b.dr* :
72			C and will add later (select_rStar=2) the contribution of
73			C the slope of the r* coordinate.
74			IF ( buoyancyRelation .EQ. 'ATMOSPHERIC' ) THEN
75			C- Consistent with Phi'= Integr[ theta'.dPi ] :
76			DO j=jMin-1,jMax
77			DO i=iMin-1,iMax
78			varLoc(i,j) = phiHydC(i,j)rStarFacC(i,j,bi,bj)*atm_kappa
79			& + phi0surf(i,j,bi,bj)
80			ENDDO
81			ENDDO
82			ELSE
83			DO j=jMin-1,jMax
84			DO i=iMin-1,iMax
85			varLoc(i,j) = phiHydC(i,j)*rStarFacC(i,j,bi,bj)
86			& + phi0surf(i,j,bi,bj)
87			ENDDO
88			ENDDO
89			ENDIF
90			ELSEIF (select_rStar.GE.1 .AND. nonlinFreeSurf.GE.4 ) THEN
91			C- Integral of b.dr but scaled to correspond to a fixed r-level (=r*)
92			C no contribution of the slope of the r* coordinate (select_rStar=1)
93			IF ( buoyancyRelation .EQ. 'ATMOSPHERIC' ) THEN
94			C- Consistent with Phi'= Integr[ theta'.dPi ] :
95			DO j=jMin-1,jMax
96			DO i=iMin-1,iMax
97			IF (Ro_surf(i,j,bi,bj).EQ.rC(k)) THEN
98			factPI=atm_Cp( ((etaH(i,j,bi,bj)+rC(k))/atm_Po)*atm_kappa
99			& -( rC(k) /atm_Po)**atm_kappa
100			& )
101			varLoc(i,j) = factPI*alphRho(i,j)
102			ELSEIF (Ro_surf(i,j,bi,bj).NE.0. _d 0) THEN
103			factPI = (rC(k)/Ro_surf(i,j,bi,bj))**atm_kappa
104			varLoc(i,j) = phiHydC(i,j)
105			& (rStarFacC(i,j,bi,bj)*atm_kappa - factPI)
106			& /(1. _d 0 -factPI)
107			& + phi0surf(i,j,bi,bj)
108			ENDIF
109			ENDDO
110			ENDDO
111			ELSE
112			DO j=jMin-1,jMax
113			DO i=iMin-1,iMax
114			IF (Ro_surf(i,j,bi,bj).EQ.rC(k)) THEN
115	jmc	1.6	WRITE(msgBuf,'(3A)') 'CALC_GRAD_PHI_HYD: ',
116			& 'Problem when Ro_surf=rC',
117			& ' with select_rStar,integr_GeoPot=1,4'
118	jmc	1.5	CALL PRINT_ERROR( msgBuf , myThid)
119			STOP 'CALC_GRAD_PHI_HYD: Pb in r* options implementation'
120			ELSE
121			varLoc(i,j) = phiHydC(i,j)
122			& *(etaH(i,j,bi,bj)+Ro_surf(i,j,bi,bj)-rC(k))
123			& / (Ro_surf(i,j,bi,bj)-rC(k))
124			& + phi0surf(i,j,bi,bj)
125			ENDIF
126			ENDDO
127	jmc	1.3	ENDDO
128	jmc	1.5	ENDIF
129	jmc	1.3	ELSE
130			#else /* NONLIN_FRSURF */
131			IF (.TRUE.) THEN
132			#endif /* NONLIN_FRSURF */
133			DO j=jMin-1,jMax
134			DO i=iMin-1,iMax
135			varLoc(i,j) = phiHydC(i,j)+phi0surf(i,j,bi,bj)
136			ENDDO
137			ENDDO
138			ENDIF
139	jmc	1.1
140	jmc	1.3	C-- Zonal & Meridional gradient of potential anomaly
141	jmc	1.1	DO j=jMin,jMax
142			DO i=iMin,iMax
143			dPhiHydX(i,j) = _recip_dxC(i,j,bi,bj)
144			& *( varLoc(i,j)-varLoc(i-1,j) )
145			dPhiHydY(i,j) = _recip_dyC(i,j,bi,bj)
146			& *( varLoc(i,j)-varLoc(i,j-1) )
147			ENDDO
148			ENDDO
149	jmc	1.3
150			#ifdef NONLIN_FRSURF
151			IF (select_rStar.GE.2 .AND. nonlinFreeSurf.GE.1 ) THEN
152			IF ( buoyancyRelation .EQ. 'OCEANIC' ) THEN
153			C-- z* coordinate slope term: rho'/rho0 * Grad_r(g.z)
154			factorZ = gravityrecip_rhoConst0.5 _d 0
155			DO j=jMin-1,jMax
156			DO i=iMin-1,iMax
157			varLoc(i,j) = etaH(i,j,bi,bj)
158			& (1. _d 0 + rC(k)recip_Rcol(i,j,bi,bj))
159			ENDDO
160			ENDDO
161			DO j=jMin,jMax
162			DO i=iMin,iMax
163			dPhiHydX(i,j) = dPhiHydX(i,j)
164			& +factorZ*(alphRho(i-1,j)+alphRho(i,j))
165			& *(varLoc(i,j)-varLoc(i-1,j))
166			& *recip_dxC(i,j,bi,bj)
167			dPhiHydY(i,j) = dPhiHydY(i,j)
168			& +factorZ*(alphRho(i,j-1)+alphRho(i,j))
169			& *(varLoc(i,j)-varLoc(i,j-1))
170			& *recip_dyC(i,j,bi,bj)
171			ENDDO
172			ENDDO
173			ELSEIF (buoyancyRelation .EQ. 'OCEANICP' ) THEN
174			C-- p* coordinate slope term: alpha' * Grad_r( p )
175			factorP = 0.5 _d 0
176			DO j=jMin,jMax
177			DO i=iMin,iMax
178			dPhiHydX(i,j) = dPhiHydX(i,j)
179			& +factorP*(alphRho(i-1,j)+alphRho(i,j))
180			& *(rStarFacC(i,j,bi,bj)-rStarFacC(i-1,j,bi,bj))
181			& rC(k)recip_dxC(i,j,bi,bj)
182			dPhiHydY(i,j) = dPhiHydY(i,j)
183			& +factorP*(alphRho(i,j-1)+alphRho(i,j))
184			& *(rStarFacC(i,j,bi,bj)-rStarFacC(i,j-1,bi,bj))
185			& rC(k)recip_dyC(i,j,bi,bj)
186			ENDDO
187			ENDDO
188			ELSEIF ( buoyancyRelation .EQ. 'ATMOSPHERIC' ) THEN
189			C-- p* coordinate slope term: alpha' * Grad_r( p )
190			conv_theta2T = (rC(k)/atm_Po)**atm_kappa
191			factorP = (atm_Rd/rC(k))conv_theta2T0.5 _d 0
192			DO j=jMin,jMax
193			DO i=iMin,iMax
194			dPhiHydX(i,j) = dPhiHydX(i,j)
195	jmc	1.5	& +factorP*(alphRho(i-1,j)+alphRho(i,j))
196	jmc	1.3	& *(rStarFacC(i,j,bi,bj)-rStarFacC(i-1,j,bi,bj))
197			& rC(k)recip_dxC(i,j,bi,bj)
198			dPhiHydY(i,j) = dPhiHydY(i,j)
199	jmc	1.5	& +factorP*(alphRho(i,j-1)+alphRho(i,j))
200	jmc	1.3	& *(rStarFacC(i,j,bi,bj)-rStarFacC(i,j-1,bi,bj))
201			& rC(k)recip_dyC(i,j,bi,bj)
202			ENDDO
203			ENDDO
204			ENDIF
205			ENDIF
206			#endif /* NONLIN_FRSURF */
207	jmc	1.1
208			#endif /* INCLUDE_PHIHYD_CALCULATION_CODE */
209
210			RETURN
211			END