pkg/generic_advdiff/gad_dst3_adv_y.F

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_dst3_adv_y.F,v 1.12 2007/04/04 01:39:06 jmc Exp $
C $Name:  $

#include "GAD_OPTIONS.h"

CBOP
C !ROUTINE: GAD_DST3_ADV_Y

C !INTERFACE: ==========================================================
      SUBROUTINE GAD_DST3_ADV_Y(
     I           bi,bj,k, calcCFL, deltaTloc,
     I           vTrans, vFld,
     I           maskLocS, tracer,
     O           vT,
     I           myThid )
C !DESCRIPTION:
C  Calculates the area integrated Meridional 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"
#ifdef OLD_DST3_FORMULATION
#include "EEPARAMS.h"
#include "PARAMS.h"
#endif
#include "GRID.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 vFld as CFL
C  deltaTloc         :: local time-step (s)
C  vTrans            :: meridional volume transport
C  vFld              :: meridional flow / CFL number
C  tracer            :: tracer field
C  myThid            :: thread number
      INTEGER bi,bj,k
      LOGICAL calcCFL
      _RL deltaTloc
      _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL vFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RS maskLocS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      INTEGER myThid

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

C     == Local variables ==
C !LOCAL VARIABLES: ====================================================
C  i,j               :: loop indices
C  vCFL              :: Courant-Friedrich-Levy number
      INTEGER i,j
      _RL Rjm,Rj,Rjp,vCFL,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 i=1-Olx,sNx+Olx
       vT(i,1-Oly)=0.
       vT(i,2-Oly)=0.
       vT(i,sNy+Oly)=0.
      ENDDO
      DO j=1-Oly+2,sNy+Oly-1
       DO i=1-Olx,sNx+Olx
        Rjp=(tracer(i,j+1)-tracer(i, j ))*maskLocS(i,j+1)
        Rj =(tracer(i, j )-tracer(i,j-1))*maskLocS(i, j )
        Rjm=(tracer(i,j-1)-tracer(i,j-2))*maskLocS(i,j-1)

        vCFL = vFld(i,j)
        IF ( calcCFL ) vCFL = ABS( vFld(i,j)*deltaTloc
     &                  *recip_dyC(i,j,bi,bj)*recip_deepFacC(k) )
        d0=(2.-vCFL)*(1.-vCFL)*oneSixth
        d1=(1.-vCFL*vCFL)*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
        vT(i,j)=
     &   0.5*(vTrans(i,j)+ABS(vTrans(i,j)))
     &      *( Tracer(i,j-1) + psiP*Rj )
     &  +0.5*(vTrans(i,j)-ABS(vTrans(i,j)))
     &      *( Tracer(i, j ) - psiM*Rj )
#else /* OLD_DST3_FORMULATION */
        vT(i,j)=
     &   0.5*(vTrans(i,j)+ABS(vTrans(i,j)))
     &      *( Tracer(i,j-1) + (d0*Rj+d1*Rjm) )
     &  +0.5*(vTrans(i,j)-ABS(vTrans(i,j)))
     &      *( Tracer(i, j ) - (d0*Rj+d1*Rjp) )
#endif /* OLD_DST3_FORMULATION */

       ENDDO
      ENDDO

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