model/src/grad_sigma.F

C $Header: /u/gcmpack/MITgcm/model/src/grad_sigma.F,v 1.4 2004/11/21 16:06:05 jmc Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: GRAD_SIGMA
C     !INTERFACE:
      SUBROUTINE GRAD_SIGMA(
     I             bi, bj, iMin, iMax, jMin, jMax, K,
     I             rhoK, sigKm1, sigKp1,
     O             sigmaX, sigmaY, sigmaR,
     I             myThid )
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE CALC_ISOSLOPES                                 
C     | o Calculate isoneutral gradients                          
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global variables ==
#include "SIZE.h"
#include "GRID.h"
#include "EEPARAMS.h"
#include "PARAMS.h"

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     rhoK       :: density at level k
C     sigKm1     :: upper level density computed at current pressure
C     sigKp1     :: lower level density computed at current pressure
C     sigmaX,Y,R :: iso-neutral gradient of density in 3 directions X,Y,R
      INTEGER bi,bj,iMin,iMax,jMin,jMax,K
      _RL rhoK(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL sigKm1(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL sigKp1(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL sigmaX(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
      _RL sigmaY(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
      _RL sigmaR(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     rhoLoc :: local copy of rhoK
      INTEGER i,j
      _RL rhoLoc(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
CEOP

C-    safer to work on a local copy of rhoK (before a partial update)
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        rhoLoc(i,j) = rhoK(i,j)
       ENDDO
      ENDDO

C-    Internal exchange for calculations in X
#ifndef ALLOW_AUTODIFF_TAMC
      IF ( useCubedSphereExchange ) THEN
        CALL FILL_CS_CORNER_TR_RL( .TRUE., rhoLoc, bi,bj, myThid )
      ENDIF
#endif
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx+1,sNx+Olx
        sigmaX(i,j,k)=_maskW(i,j,k,bi,bj)
     &        *_recip_dxC(i,j,bi,bj)
     &        *(rhoLoc(i,j)-rhoLoc(i-1,j))
       ENDDO
      ENDDO

C-    Internal exchange for calculations in Y
#ifndef ALLOW_AUTODIFF_TAMC
      IF ( useCubedSphereExchange ) THEN
        CALL FILL_CS_CORNER_TR_RL( .FALSE., rhoLoc, bi,bj, myThid )
      ENDIF
#endif
      DO j=1-Oly+1,sNy+Oly
       DO i=1-Olx,sNx+Olx
        sigmaY(i,j,k)=_maskS(i,j,k,bi,bj)
     &        *_recip_dyC(i,j,bi,bj)
     &        *(rhoLoc(i,j)-rhoLoc(i,j-1))
       ENDDO
      ENDDO

C- jmc: Patrick, will this work for TAF ?
      IF (K.EQ.1) THEN
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         sigmaR(i,j,k)=0.
        ENDDO
       ENDDO
      ELSE
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         sigmaR(i,j,k)= maskC(i,j,k,bi,bj)
     &                *recip_drC(k)*rkFac
     &                *(sigKm1(i,j)-sigKp1(i,j))
        ENDDO
       ENDDO
      ENDIF
C- jmc: leave the old code commented (in case ...)
c     DO j=1-Oly,sNy+Oly
c      DO i=1-Olx,sNx+Olx
c       IF (K.NE.1 .AND. hfacC(i,j,k,bi,bj).NE.0.) THEN
c        sigmaR(i,j,k)=recip_drC(k)*rkFac*(sigKm1(i,j)-sigKp1(i,j))
c       ELSE
c        sigmaR(i,j,k)=0.
c       ENDIF
c      ENDDO
c     ENDDO

      RETURN
      END
1	jmc	1.5	C $Header: /u/gcmpack/MITgcm/model/src/grad_sigma.F,v 1.4 2004/11/21 16:06:05 jmc Exp $
2	cnh	1.3	C $Name: $
3	adcroft	1.1
4			#include "CPP_OPTIONS.h"
5
6	cnh	1.3	CBOP
7			C !ROUTINE: GRAD_SIGMA
8			C !INTERFACE:
9	adcroft	1.1	SUBROUTINE GRAD_SIGMA(
10			I bi, bj, iMin, iMax, jMin, jMax, K,
11			I rhoK, sigKm1, sigKp1,
12			O sigmaX, sigmaY, sigmaR,
13			I myThid )
14	cnh	1.3	C !DESCRIPTION: \bv
15			C ==========================================================
16			C \| SUBROUTINE CALC_ISOSLOPES
17			C \| o Calculate isoneutral gradients
18			C ==========================================================
19			C \ev
20
21			C !USES:
22	adcroft	1.1	IMPLICIT NONE
23			C == Global variables ==
24			#include "SIZE.h"
25			#include "GRID.h"
26			#include "EEPARAMS.h"
27			#include "PARAMS.h"
28
29	cnh	1.3	C !INPUT/OUTPUT PARAMETERS:
30	adcroft	1.1	C == Routine arguments ==
31	jmc	1.4	C rhoK :: density at level k
32			C sigKm1 :: upper level density computed at current pressure
33			C sigKp1 :: lower level density computed at current pressure
34			C sigmaX,Y,R :: iso-neutral gradient of density in 3 directions X,Y,R
35	adcroft	1.1	INTEGER bi,bj,iMin,iMax,jMin,jMax,K
36			_RL rhoK(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
37			_RL sigKm1(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
38			_RL sigKp1(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
39			_RL sigmaX(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
40			_RL sigmaY(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
41			_RL sigmaR(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
42			INTEGER myThid
43
44	cnh	1.3	C !LOCAL VARIABLES:
45	adcroft	1.1	C == Local variables ==
46	jmc	1.4	C rhoLoc :: local copy of rhoK
47	adcroft	1.1	INTEGER i,j
48	jmc	1.4	_RL rhoLoc(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
49	cnh	1.3	CEOP
50	adcroft	1.1
51	jmc	1.4	C- safer to work on a local copy of rhoK (before a partial update)
52			DO j=1-Oly,sNy+Oly
53			DO i=1-Olx,sNx+Olx
54			rhoLoc(i,j) = rhoK(i,j)
55			ENDDO
56			ENDDO
57
58			C- Internal exchange for calculations in X
59	jmc	1.5	#ifndef ALLOW_AUTODIFF_TAMC
60	jmc	1.4	IF ( useCubedSphereExchange ) THEN
61			CALL FILL_CS_CORNER_TR_RL( .TRUE., rhoLoc, bi,bj, myThid )
62			ENDIF
63	jmc	1.5	#endif
64	adcroft	1.1	DO j=1-Oly,sNy+Oly
65			DO i=1-Olx+1,sNx+Olx
66			sigmaX(i,j,k)=_maskW(i,j,k,bi,bj)
67			& *_recip_dxC(i,j,bi,bj)
68	jmc	1.4	& *(rhoLoc(i,j)-rhoLoc(i-1,j))
69	adcroft	1.1	ENDDO
70			ENDDO
71
72	jmc	1.4	C- Internal exchange for calculations in Y
73	jmc	1.5	#ifndef ALLOW_AUTODIFF_TAMC
74	jmc	1.4	IF ( useCubedSphereExchange ) THEN
75			CALL FILL_CS_CORNER_TR_RL( .FALSE., rhoLoc, bi,bj, myThid )
76			ENDIF
77	jmc	1.5	#endif
78	adcroft	1.1	DO j=1-Oly+1,sNy+Oly
79			DO i=1-Olx,sNx+Olx
80			sigmaY(i,j,k)=_maskS(i,j,k,bi,bj)
81			& *_recip_dyC(i,j,bi,bj)
82	jmc	1.4	& *(rhoLoc(i,j)-rhoLoc(i,j-1))
83	adcroft	1.1	ENDDO
84			ENDDO
85
86	jmc	1.4	C- jmc: Patrick, will this work for TAF ?
87			IF (K.EQ.1) THEN
88			DO j=1-Oly,sNy+Oly
89			DO i=1-Olx,sNx+Olx
90	adcroft	1.1	sigmaR(i,j,k)=0.
91	jmc	1.4	ENDDO
92	adcroft	1.1	ENDDO
93	jmc	1.4	ELSE
94			DO j=1-Oly,sNy+Oly
95			DO i=1-Olx,sNx+Olx
96			sigmaR(i,j,k)= maskC(i,j,k,bi,bj)
97			& recip_drC(k)rkFac
98			& *(sigKm1(i,j)-sigKp1(i,j))
99			ENDDO
100			ENDDO
101			ENDIF
102			C- jmc: leave the old code commented (in case ...)
103			c DO j=1-Oly,sNy+Oly
104			c DO i=1-Olx,sNx+Olx
105			c IF (K.NE.1 .AND. hfacC(i,j,k,bi,bj).NE.0.) THEN
106			c sigmaR(i,j,k)=recip_drC(k)rkFac(sigKm1(i,j)-sigKp1(i,j))
107			c ELSE
108			c sigmaR(i,j,k)=0.
109			c ENDIF
110			c ENDDO
111			c ENDDO
112	adcroft	1.1
113			RETURN
114			END