pkg/generic_advdiff/gad_dst3_adv_x.F

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_dst3_adv_x.F,v 1.11 2006/12/05 22:21:50 jmc Exp $
C $Name:  $

#include "GAD_OPTIONS.h"

CBOP
C !ROUTINE: GAD_DST3_ADV_X

C !INTERFACE: ==========================================================
      SUBROUTINE GAD_DST3_ADV_X(
     I           bi,bj,k, calcCFL, deltaTloc,
     I           uTrans, uFld,
     I           maskLocW, tracer,
     O           uT,
     I           myThid )

C !DESCRIPTION:
C  Calculates the area integrated zonal flux due to advection of a
C  tracer using 3rd-order Direct Space and Time (DST-3) Advection Scheme

C !USES: ===============================================================
      IMPLICIT NONE

C     == GLobal variables ==
#include "SIZE.h"
#include "GRID.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GAD.h"

C     == Routine arguments ==
C !INPUT PARAMETERS: ===================================================
C  bi,bj             :: tile indices
C  k                 :: vertical level
C  calcCFL           :: =T: calculate CFL number ; =F: take uFld as CFL.
C  deltaTloc         :: local time-step (s)
C  uTrans            :: zonal volume transport
C  uFld              :: zonal flow / CFL number
C  tracer            :: tracer field
C  myThid            :: thread number
      INTEGER bi,bj,k
      LOGICAL calcCFL
      _RL deltaTloc
      _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL uFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RS maskLocW(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      INTEGER myThid

C !OUTPUT PARAMETERS: ==================================================
C  uT                :: zonal advective flux
      _RL uT    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)

C     == Local variables ==
C !LOCAL VARIABLES: ====================================================
C  i,j               :: loop indices
C  uCFL              :: Courant-Friedrich-Levy number
      INTEGER i,j
      _RL Rjm,Rj,Rjp,uCFL,d0,d1
#ifdef OLD_DST3_FORMULATION
      _RL psiP,psiM,thetaP,thetaM
      _RL smallNo
c     _RL Rjjm,Rjjp

      IF (inAdMode) THEN
       smallNo = 1.0D-20
      ELSE
       smallNo = 1.0D-20
      ENDIF
#endif

      DO j=1-Oly,sNy+Oly
       uT(1-Olx,j)=0.
       uT(2-Olx,j)=0.
       uT(sNx+Olx,j)=0.
       DO i=1-Olx+2,sNx+Olx-1
        Rjp=(tracer(i+1,j)-tracer( i ,j))*maskLocW(i+1,j)
        Rj =(tracer( i ,j)-tracer(i-1,j))*maskLocW( i ,j)
        Rjm=(tracer(i-1,j)-tracer(i-2,j))*maskLocW(i-1,j)

        uCFL = uFld(i,j)
        IF ( calcCFL ) uCFL = ABS( uFld(i,j)*deltaTloc
     &                  *recip_dxC(i,j,bi,bj)*recip_deepFacC(k) )
        d0=(2.-uCFL)*(1.-uCFL)*oneSixth
        d1=(1.-uCFL*uCFL)*oneSixth
#ifdef OLD_DST3_FORMULATION
        IF ( ABS(Rj).LT.smallNo .OR.
     &       ABS(Rjm).LT.smallNo ) THEN
         thetaP=0.
         psiP=0.
        ELSE
         thetaP=(Rjm+smallNo)/(smallNo+Rj)
         psiP=d0+d1*thetaP
        ENDIF
        IF ( ABS(Rj).LT.smallNo .OR.
     &       ABS(Rjp).LT.smallNo ) THEN
         thetaM=0.
         psiM=0.
        ELSE
         thetaM=(Rjp+smallNo)/(smallNo+Rj)
         psiM=d0+d1*thetaM
        ENDIF
        uT(i,j)=
     &   0.5*(uTrans(i,j)+ABS(uTrans(i,j)))
     &      *( Tracer(i-1,j) + psiP*Rj )
     &  +0.5*(uTrans(i,j)-ABS(uTrans(i,j)))
     &      *( Tracer( i ,j) - psiM*Rj )
#else /* OLD_DST3_FORMULATION */
        uT(i,j)=
     &   0.5*(uTrans(i,j)+ABS(uTrans(i,j)))
     &      *( Tracer(i-1,j) + (d0*Rj+d1*Rjm) )
     &  +0.5*(uTrans(i,j)-ABS(uTrans(i,j)))
     &      *( Tracer( i ,j) - (d0*Rj+d1*Rjp) )
#endif /* OLD_DST3_FORMULATION */

       ENDDO
      ENDDO

      RETURN
      END
1	jmc	1.12	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_dst3_adv_x.F,v 1.11 2006/12/05 22:21:50 jmc Exp $
2	adcroft	1.2	C $Name: $
3	adcroft	1.1
4			#include "GAD_OPTIONS.h"
5
6	jmc	1.10	CBOP
7			C !ROUTINE: GAD_DST3_ADV_X
8
9			C !INTERFACE: ==========================================================
10	jmc	1.8	SUBROUTINE GAD_DST3_ADV_X(
11	jmc	1.12	I bi,bj,k, calcCFL, deltaTloc,
12	jmc	1.8	I uTrans, uFld,
13	jmc	1.4	I maskLocW, tracer,
14	adcroft	1.1	O uT,
15			I myThid )
16	jmc	1.10
17			C !DESCRIPTION:
18			C Calculates the area integrated zonal flux due to advection of a
19			C tracer using 3rd-order Direct Space and Time (DST-3) Advection Scheme
20
21			C !USES: ===============================================================
22	adcroft	1.1	IMPLICIT NONE
23
24			C == GLobal variables ==
25			#include "SIZE.h"
26			#include "GRID.h"
27	heimbach	1.5	#include "EEPARAMS.h"
28			#include "PARAMS.h"
29	adcroft	1.1	#include "GAD.h"
30
31			C == Routine arguments ==
32	jmc	1.10	C !INPUT PARAMETERS: ===================================================
33			C bi,bj :: tile indices
34			C k :: vertical level
35	jmc	1.12	C calcCFL :: =T: calculate CFL number ; =F: take uFld as CFL.
36	jmc	1.10	C deltaTloc :: local time-step (s)
37			C uTrans :: zonal volume transport
38	jmc	1.12	C uFld :: zonal flow / CFL number
39	jmc	1.10	C tracer :: tracer field
40			C myThid :: thread number
41	adcroft	1.1	INTEGER bi,bj,k
42	jmc	1.12	LOGICAL calcCFL
43	heimbach	1.5	_RL deltaTloc
44	adcroft	1.1	_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
45	jmc	1.8	_RL uFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
46	jmc	1.4	_RS maskLocW(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
47	adcroft	1.1	_RL tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
48	jmc	1.10	INTEGER myThid
49
50			C !OUTPUT PARAMETERS: ==================================================
51			C uT :: zonal advective flux
52	adcroft	1.1	_RL uT (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
53
54			C == Local variables ==
55	jmc	1.10	C !LOCAL VARIABLES: ====================================================
56			C i,j :: loop indices
57	jmc	1.11	C uCFL :: Courant-Friedrich-Levy number
58	adcroft	1.1	INTEGER i,j
59	jmc	1.11	_RL Rjm,Rj,Rjp,uCFL,d0,d1
60	jmc	1.10	#ifdef OLD_DST3_FORMULATION
61	adcroft	1.2	_RL psiP,psiM,thetaP,thetaM
62	heimbach	1.5	_RL smallNo
63	jmc	1.6	c _RL Rjjm,Rjjp
64	heimbach	1.5
65			IF (inAdMode) THEN
66			smallNo = 1.0D-20
67			ELSE
68			smallNo = 1.0D-20
69			ENDIF
70	jmc	1.10	#endif
71	adcroft	1.1
72			DO j=1-Oly,sNy+Oly
73			uT(1-Olx,j)=0.
74			uT(2-Olx,j)=0.
75			uT(sNx+Olx,j)=0.
76			DO i=1-Olx+2,sNx+Olx-1
77	jmc	1.4	Rjp=(tracer(i+1,j)-tracer( i ,j))*maskLocW(i+1,j)
78			Rj =(tracer( i ,j)-tracer(i-1,j))*maskLocW( i ,j)
79			Rjm=(tracer(i-1,j)-tracer(i-2,j))*maskLocW(i-1,j)
80	adcroft	1.1
81	jmc	1.12	uCFL = uFld(i,j)
82			IF ( calcCFL ) uCFL = ABS( uFld(i,j)*deltaTloc
83	jmc	1.11	& recip_dxC(i,j,bi,bj)recip_deepFacC(k) )
84			d0=(2.-uCFL)(1.-uCFL)oneSixth
85			d1=(1.-uCFLuCFL)oneSixth
86	jmc	1.10	#ifdef OLD_DST3_FORMULATION
87	heimbach	1.5	IF ( ABS(Rj).LT.smallNo .OR.
88			& ABS(Rjm).LT.smallNo ) THEN
89			thetaP=0.
90			psiP=0.
91			ELSE
92			thetaP=(Rjm+smallNo)/(smallNo+Rj)
93			psiP=d0+d1*thetaP
94			ENDIF
95			IF ( ABS(Rj).LT.smallNo .OR.
96			& ABS(Rjp).LT.smallNo ) THEN
97			thetaM=0.
98			psiM=0.
99			ELSE
100			thetaM=(Rjp+smallNo)/(smallNo+Rj)
101			psiM=d0+d1*thetaM
102			ENDIF
103	adcroft	1.1	uT(i,j)=
104	jmc	1.10	& 0.5*(uTrans(i,j)+ABS(uTrans(i,j)))
105	adcroft	1.2	& ( Tracer(i-1,j) + psiPRj )
106	jmc	1.10	& +0.5*(uTrans(i,j)-ABS(uTrans(i,j)))
107	adcroft	1.2	& ( Tracer( i ,j) - psiMRj )
108	jmc	1.10	#else /* OLD_DST3_FORMULATION */
109			uT(i,j)=
110			& 0.5*(uTrans(i,j)+ABS(uTrans(i,j)))
111			& ( Tracer(i-1,j) + (d0Rj+d1*Rjm) )
112			& +0.5*(uTrans(i,j)-ABS(uTrans(i,j)))
113			& ( Tracer( i ,j) - (d0Rj+d1*Rjp) )
114			#endif /* OLD_DST3_FORMULATION */
115	adcroft	1.1
116			ENDDO
117			ENDDO
118
119			RETURN
120			END