pkg/generic_advdiff/gad_fluxlimit_adv_y.F

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_fluxlimit_adv_y.F,v 1.11 2006/12/05 22:25:41 jmc Exp $
C $Name:  $

#include "GAD_OPTIONS.h"

CBOP
C !ROUTINE: GAD_FLUXLIMIT_ADV_Y

C !INTERFACE: ==========================================================
      SUBROUTINE GAD_FLUXLIMIT_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 tracer
C using second-order interpolation with a flux limiter:
C \begin{equation*}
C F^y_{adv} = V \overline{ \theta }^j
C - \frac{1}{2} \left(
C     [ 1 - \psi(C_r) ] |V|
C    + V \frac{v \Delta t}{\Delta y_c} \psi(C_r)
C              \right) \delta_j \theta
C \end{equation*}
C where the $\psi(C_r)$ is the limiter function and $C_r$ is
C the slope ratio.

C !USES: ===============================================================
      IMPLICIT NONE
#include "SIZE.h"
#include "GRID.h"

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  i,j               :: loop indices
C  Cr                :: slope ratio
C  Rjm,Rj,Rjp        :: differences at j-1,j,j+1
      INTEGER i,j
      _RL Cr,Rjm,Rj,Rjp
      _RL vCFL
C Statement function provides Limiter(Cr)
#include "GAD_FLUX_LIMITER.h"
CEOP

      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

        vCFL = vFld(i,j)
        IF ( calcCFL ) vCFL = ABS( vFld(i,j)*deltaTloc
     &                  *recip_dyC(i,j,bi,bj)*recip_deepFacC(k) )
        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)

        IF (Rj.NE.0.) THEN
         IF (vTrans(i,j).GT.0) THEN
           Cr=Rjm/Rj
         ELSE
           Cr=Rjp/Rj
         ENDIF
        ELSE
         IF (vTrans(i,j).GT.0) THEN
           Cr=Rjm*1.E20
         ELSE
           Cr=Rjp*1.E20
         ENDIF
        ENDIF
        Cr=Limiter(Cr)
        vT(i,j) =
     &   vTrans(i,j)*(Tracer(i,j)+Tracer(i,j-1))*0.5 _d 0
     &   -ABS(vTrans(i,j))*((1.-Cr)+vCFL*Cr)
     &                    *Rj*0.5 _d 0
       ENDDO
      ENDDO

      RETURN
      END
1	jmc	1.12	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_fluxlimit_adv_y.F,v 1.11 2006/12/05 22:25:41 jmc Exp $
2	jmc	1.2	C $Name: $
3	adcroft	1.1
4			#include "GAD_OPTIONS.h"
5
6	adcroft	1.3	CBOP
7			C !ROUTINE: GAD_FLUXLIMIT_ADV_Y
8
9			C !INTERFACE: ==========================================================
10	jmc	1.9	SUBROUTINE GAD_FLUXLIMIT_ADV_Y(
11	jmc	1.12	I bi,bj,k, calcCFL, deltaTloc,
12	jmc	1.9	I vTrans, vFld,
13	jmc	1.6	I maskLocS, tracer,
14	adcroft	1.1	O vT,
15			I myThid )
16	adcroft	1.3
17			C !DESCRIPTION:
18			C Calculates the area integrated meridional flux due to advection of a tracer
19			C using second-order interpolation with a flux limiter:
20			C \begin{equation*}
21			C F^y_{adv} = V \overline{ \theta }^j
22			C - \frac{1}{2} \left(
23			C [ 1 - \psi(C_r) ] \|V\|
24			C + V \frac{v \Delta t}{\Delta y_c} \psi(C_r)
25			C \right) \delta_j \theta
26			C \end{equation*}
27			C where the $\psi(C_r)$ is the limiter function and $C_r$ is
28			C the slope ratio.
29
30			C !USES: ===============================================================
31	adcroft	1.1	IMPLICIT NONE
32			#include "SIZE.h"
33			#include "GRID.h"
34
35	adcroft	1.3	C !INPUT PARAMETERS: ===================================================
36	edhill	1.5	C bi,bj :: tile indices
37			C k :: vertical level
38	jmc	1.12	C calcCFL :: =T: calculate CFL number ; =F: take vFld as CFL
39			C deltaTloc :: local time-step (s)
40	edhill	1.5	C vTrans :: meridional volume transport
41	jmc	1.12	C vFld :: meridional flow / CFL number
42	edhill	1.5	C tracer :: tracer field
43			C myThid :: thread number
44	adcroft	1.1	INTEGER bi,bj,k
45	jmc	1.12	LOGICAL calcCFL
46	heimbach	1.7	_RL deltaTloc
47	adcroft	1.1	_RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
48	jmc	1.9	_RL vFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
49	jmc	1.6	_RS maskLocS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
50	adcroft	1.1	_RL tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
51	adcroft	1.3	INTEGER myThid
52
53			C !OUTPUT PARAMETERS: ==================================================
54	edhill	1.5	C vT :: meridional advective flux
55	adcroft	1.1	_RL vT (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
56
57	adcroft	1.3	C !LOCAL VARIABLES: ====================================================
58	edhill	1.5	C i,j :: loop indices
59			C Cr :: slope ratio
60			C Rjm,Rj,Rjp :: differences at j-1,j,j+1
61	adcroft	1.1	INTEGER i,j
62			_RL Cr,Rjm,Rj,Rjp
63	jmc	1.12	_RL vCFL
64	adcroft	1.3	C Statement function provides Limiter(Cr)
65	adcroft	1.1	#include "GAD_FLUX_LIMITER.h"
66	adcroft	1.3	CEOP
67	adcroft	1.1
68			DO i=1-Olx,sNx+Olx
69			vT(i,1-Oly)=0.
70	jmc	1.2	vT(i,2-Oly)=0.
71			vT(i,sNy+Oly)=0.
72	adcroft	1.1	ENDDO
73	jmc	1.2	DO j=1-Oly+2,sNy+Oly-1
74	adcroft	1.1	DO i=1-Olx,sNx+Olx
75	jmc	1.4
76	jmc	1.12	vCFL = vFld(i,j)
77			IF ( calcCFL ) vCFL = ABS( vFld(i,j)*deltaTloc
78	jmc	1.11	& recip_dyC(i,j,bi,bj)recip_deepFacC(k) )
79	jmc	1.6	Rjp=(tracer(i,j+1)-tracer(i, j ))*maskLocS(i,j+1)
80			Rj =(tracer(i, j )-tracer(i,j-1))*maskLocS(i, j )
81			Rjm=(tracer(i,j-1)-tracer(i,j-2))*maskLocS(i,j-1)
82	jmc	1.4
83	adcroft	1.1	IF (Rj.NE.0.) THEN
84			IF (vTrans(i,j).GT.0) THEN
85			Cr=Rjm/Rj
86			ELSE
87			Cr=Rjp/Rj
88			ENDIF
89			ELSE
90			IF (vTrans(i,j).GT.0) THEN
91			Cr=Rjm*1.E20
92			ELSE
93			Cr=Rjp*1.E20
94			ENDIF
95			ENDIF
96			Cr=Limiter(Cr)
97	jmc	1.9	vT(i,j) =
98	adcroft	1.1	& vTrans(i,j)(Tracer(i,j)+Tracer(i,j-1))0.5 _d 0
99	jmc	1.11	& -ABS(vTrans(i,j))((1.-Cr)+vCFLCr)
100			& Rj0.5 _d 0
101	adcroft	1.1	ENDDO
102			ENDDO
103
104			RETURN
105			END