pkg/ptracers/ptracers_implicit.F

C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_implicit.F,v 1.9 2011/12/01 14:27:53 jmc Exp $
C $Name:  $

#include "PTRACERS_OPTIONS.h"

CBOP
C !ROUTINE: PTRACERS_IMPLICIT

C !INTERFACE: ==========================================================
      SUBROUTINE PTRACERS_IMPLICIT(
     U                              kappaRk,
     I                              recip_hFac,
     I                              bi, bj, myTime, myIter, myThid )

C !DESCRIPTION:
C     Calls the implicit vertical advection/diffusion routine
C     for each passive tracer.
C     And apply open boundary conditions for each passive tracer
C Note: would be better to apply OBC in a dedicated S/R ;
C     can be done here assuming no other contribution modify passive
C     tracer after implicit vertical diffus/advect is applied.

C !USES: ===============================================================
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#ifdef ALLOW_LONGSTEP
#include "LONGSTEP_PARAMS.h"
#include "LONGSTEP.h"
#endif
#include "PTRACERS_SIZE.h"
#include "PTRACERS_PARAMS.h"
#include "PTRACERS_START.h"
#include "PTRACERS_FIELDS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "GAD.h"
#include "DYNVARS.h"
#ifdef ALLOW_AUTODIFF_TAMC
# include "tamc.h"
# include "tamc_keys.h"
#endif

C !INPUT PARAMETERS: ===================================================
C  recip_hFac :: Inverse of cell open-depth factor
C  bi,bj      :: tile indices
C  myTime     :: time in simulation
C  myIter     :: iteration number in simulation
C  myThid     :: thread number
      _RS     recip_hFac(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
      INTEGER bi,bj
      _RL     myTime
      INTEGER myIter
      INTEGER myThid

C !OUTPUT PARAMETERS: ==================================================
C  KappaRk    :: vertical diffusion coefficient
      _RL     kappaRk(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)

#ifdef ALLOW_PTRACERS

C !LOCAL VARIABLES: ====================================================
C  iTracer :: tracer index
      INTEGER iTracer
      INTEGER iMin,iMax,jMin,jMax
      INTEGER GAD_TR
CEOP

      iMin=0
      iMax=sNx+1
      jMin=0
      jMax=sNy+1

C Loop over tracers
      DO iTracer=1,PTRACERS_numInUse
       IF ( PTRACERS_StepFwd(iTracer) ) THEN

#ifdef ALLOW_AUTODIFF_TAMC
          act0 = iTracer - 1
          max0 = PTRACERS_num
          act1 = bi - myBxLo(myThid)
          max1 = myBxHi(myThid) - myBxLo(myThid) + 1
          act2 = bj - myByLo(myThid)
          max2 = myByHi(myThid) - myByLo(myThid) + 1
          act3 = myThid - 1
          max3 = nTx*nTy
          act4 = ikey_dynamics - 1
          iptrkey = (act0 + 1)
     &                      + act1*max0
     &                      + act2*max0*max1
     &                      + act3*max0*max1*max2
     &                      + act4*max0*max1*max2*max3
#endif /* ALLOW_AUTODIFF_TAMC */

        GAD_TR = GAD_TR1 + iTracer - 1
        IF ( implicitDiffusion ) THEN
          CALL CALC_3D_DIFFUSIVITY(
     I         bi,bj,iMin,iMax,jMin,jMax,
     I         GAD_TR,
     I         PTRACERS_useGMRedi(iTracer),PTRACERS_useKPP(iTracer),
     O         kappaRk,
     I         myThid)
        ENDIF

#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE kappaRk(:,:,:) = comlev1_bibj_ptracers,
CADJ &     key=iptrkey, byte=isbyte
CADJ STORE gPtr(:,:,:,bi,bj,iTracer) = comlev1_bibj_ptracers,
CADJ &     key=iptrkey, byte=isbyte
#endif /* ALLOW_AUTODIFF_TAMC */

#ifdef INCLUDE_IMPLVERTADV_CODE
        IF ( PTRACERS_ImplVertAdv(iTracer) ) THEN

          CALL GAD_IMPLICIT_R(
     I         PTRACERS_ImplVertAdv(iTracer),
     I         PTRACERS_advScheme(iTracer), GAD_TR,
     I         PTRACERS_dTLev, kappaRk, recip_hFac,
#ifdef ALLOW_LONGSTEP
     I         LS_wVel,
#else
     I         wVel,
#endif
     I         pTracer(1-OLx,1-OLy,1,1,1,iTracer),
     U         gPtr(1-OLx,1-OLy,1,1,1,iTracer),
     I         bi, bj, myTime, myIter, myThid )

        ELSEIF ( implicitDiffusion ) THEN
#else /* INCLUDE_IMPLVERTADV_CODE */
        IF ( implicitDiffusion ) THEN
#endif /* INCLUDE_IMPLVERTADV_CODE */

          CALL IMPLDIFF(
     I         bi, bj, iMin, iMax, jMin, jMax,
     I         GAD_TR, kappaRk, recip_hFac,
     U         gPtr(1-OLx,1-OLy,1,1,1,iTracer),
     I         myThid )
        ENDIF

#ifdef ALLOW_OBCS
C--     Apply open boundary conditions
        IF ( useOBCS ) THEN
          CALL OBCS_APPLY_PTRACER(
     I         bi, bj, 0, iTracer,
     U         gPtr(1-OLx,1-OLy,1,bi,bj,iTracer),
     I         myThid )
        ENDIF
#endif /* ALLOW_OBCS */

C End of tracer loop
       ENDIF
      ENDDO

#endif /* ALLOW_PTRACERS */

      RETURN
      END
1	jmc	1.10	C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_implicit.F,v 1.9 2011/12/01 14:27:53 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#include "PTRACERS_OPTIONS.h"
5
6			CBOP
7			C !ROUTINE: PTRACERS_IMPLICIT
8
9			C !INTERFACE: ==========================================================
10	jmc	1.5	SUBROUTINE PTRACERS_IMPLICIT(
11	jmc	1.1	U kappaRk,
12	jmc	1.9	I recip_hFac,
13	jmc	1.1	I bi, bj, myTime, myIter, myThid )
14
15			C !DESCRIPTION:
16			C Calls the implicit vertical advection/diffusion routine
17			C for each passive tracer.
18	jmc	1.8	C And apply open boundary conditions for each passive tracer
19			C Note: would be better to apply OBC in a dedicated S/R ;
20			C can be done here assuming no other contribution modify passive
21			C tracer after implicit vertical diffus/advect is applied.
22	jmc	1.1
23			C !USES: ===============================================================
24			IMPLICIT NONE
25			#include "SIZE.h"
26			#include "EEPARAMS.h"
27	jahn	1.6	#ifdef ALLOW_LONGSTEP
28			#include "LONGSTEP_PARAMS.h"
29			#include "LONGSTEP.h"
30			#endif
31	jmc	1.1	#include "PTRACERS_SIZE.h"
32	jmc	1.5	#include "PTRACERS_PARAMS.h"
33	jmc	1.10	#include "PTRACERS_START.h"
34	jmc	1.5	#include "PTRACERS_FIELDS.h"
35	jmc	1.1	#include "PARAMS.h"
36			#include "GRID.h"
37			#include "GAD.h"
38			#include "DYNVARS.h"
39			#ifdef ALLOW_AUTODIFF_TAMC
40			# include "tamc.h"
41			# include "tamc_keys.h"
42			#endif
43
44			C !INPUT PARAMETERS: ===================================================
45	jmc	1.9	C recip_hFac :: Inverse of cell open-depth factor
46			C bi,bj :: tile indices
47			C myTime :: time in simulation
48			C myIter :: iteration number in simulation
49			C myThid :: thread number
50			_RS recip_hFac(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
51	jmc	1.1	INTEGER bi,bj
52			_RL myTime
53			INTEGER myIter
54			INTEGER myThid
55
56			C !OUTPUT PARAMETERS: ==================================================
57	jmc	1.9	C KappaRk :: vertical diffusion coefficient
58			_RL kappaRk(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
59	jmc	1.1
60			#ifdef ALLOW_PTRACERS
61
62			C !LOCAL VARIABLES: ====================================================
63			C iTracer :: tracer index
64			INTEGER iTracer
65			INTEGER iMin,iMax,jMin,jMax
66			INTEGER GAD_TR
67			CEOP
68
69			iMin=0
70			iMax=sNx+1
71			jMin=0
72			jMax=sNy+1
73
74			C Loop over tracers
75			DO iTracer=1,PTRACERS_numInUse
76	jmc	1.10	IF ( PTRACERS_StepFwd(iTracer) ) THEN
77	jmc	1.1
78			#ifdef ALLOW_AUTODIFF_TAMC
79			act0 = iTracer - 1
80			max0 = PTRACERS_num
81			act1 = bi - myBxLo(myThid)
82			max1 = myBxHi(myThid) - myBxLo(myThid) + 1
83			act2 = bj - myByLo(myThid)
84			max2 = myByHi(myThid) - myByLo(myThid) + 1
85			act3 = myThid - 1
86			max3 = nTx*nTy
87			act4 = ikey_dynamics - 1
88	jmc	1.5	iptrkey = (act0 + 1)
89	jmc	1.1	& + act1*max0
90			& + act2max0max1
91			& + act3max0max1*max2
92			& + act4max0max1max2max3
93			#endif /* ALLOW_AUTODIFF_TAMC */
94
95			GAD_TR = GAD_TR1 + iTracer - 1
96			IF ( implicitDiffusion ) THEN
97			CALL CALC_3D_DIFFUSIVITY(
98			I bi,bj,iMin,iMax,jMin,jMax,
99			I GAD_TR,
100			I PTRACERS_useGMRedi(iTracer),PTRACERS_useKPP(iTracer),
101			O kappaRk,
102			I myThid)
103			ENDIF
104
105			#ifdef ALLOW_AUTODIFF_TAMC
106	jmc	1.5	CADJ STORE kappaRk(:,:,:) = comlev1_bibj_ptracers,
107	heimbach	1.3	CADJ & key=iptrkey, byte=isbyte
108	jmc	1.5	CADJ STORE gPtr(:,:,:,bi,bj,iTracer) = comlev1_bibj_ptracers,
109	jmc	1.1	CADJ & key=iptrkey, byte=isbyte
110			#endif /* ALLOW_AUTODIFF_TAMC */
111
112			#ifdef INCLUDE_IMPLVERTADV_CODE
113	jmc	1.2	IF ( PTRACERS_ImplVertAdv(iTracer) ) THEN
114	jmc	1.1
115			CALL GAD_IMPLICIT_R(
116	jmc	1.5	I PTRACERS_ImplVertAdv(iTracer),
117	jmc	1.1	I PTRACERS_advScheme(iTracer), GAD_TR,
118	jmc	1.9	I PTRACERS_dTLev, kappaRk, recip_hFac,
119	jahn	1.6	#ifdef ALLOW_LONGSTEP
120			I LS_wVel,
121			#else
122			I wVel,
123			#endif
124	jmc	1.9	I pTracer(1-OLx,1-OLy,1,1,1,iTracer),
125			U gPtr(1-OLx,1-OLy,1,1,1,iTracer),
126	jmc	1.1	I bi, bj, myTime, myIter, myThid )
127
128			ELSEIF ( implicitDiffusion ) THEN
129			#else /* INCLUDE_IMPLVERTADV_CODE */
130			IF ( implicitDiffusion ) THEN
131			#endif /* INCLUDE_IMPLVERTADV_CODE */
132
133			CALL IMPLDIFF(
134			I bi, bj, iMin, iMax, jMin, jMax,
135	jmc	1.9	I GAD_TR, kappaRk, recip_hFac,
136			U gPtr(1-OLx,1-OLy,1,1,1,iTracer),
137	jmc	1.1	I myThid )
138	jmc	1.8	ENDIF
139	jmc	1.1
140	jmc	1.7	#ifdef ALLOW_OBCS
141	jmc	1.8	C-- Apply open boundary conditions
142	mlosch	1.4	IF ( useOBCS ) THEN
143	jmc	1.5	CALL OBCS_APPLY_PTRACER(
144	jmc	1.8	I bi, bj, 0, iTracer,
145	jmc	1.9	U gPtr(1-OLx,1-OLy,1,bi,bj,iTracer),
146	mlosch	1.4	I myThid )
147			ENDIF
148	jmc	1.7	#endif /* ALLOW_OBCS */
149	mlosch	1.4
150	jmc	1.1	C End of tracer loop
151	jmc	1.10	ENDIF
152	jmc	1.1	ENDDO
153
154			#endif /* ALLOW_PTRACERS */
155
156			RETURN
157			END