model/src/calc_3d_diffusivity.F

C $Header: /u/gcmpack/MITgcm/model/src/calc_3d_diffusivity.F,v 1.4 2005/11/04 01:19:24 jmc Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: CALC_3D_DIFFUSIVITY
C     !INTERFACE: 
      SUBROUTINE CALC_3D_DIFFUSIVITY( 
     I        bi,bj,iMin,iMax,jMin,jMax,
     I        trIdentity, trUseGMRedi, trUseKPP,
     O        KappaRTr,
     I        myThid)

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE CALC_3D_DIFFUSIVITY
C     | o Calculate net (3D) vertical diffusivity for 1 tracer
C     *==========================================================*
C     | Combines spatially varying diffusion coefficients from
C     | KPP and/or GM and/or convective stability test.
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == GLobal variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "DYNVARS.h"
#include "GRID.h"
#ifdef ALLOW_GENERIC_ADVDIFF
#include "GAD.h"
#endif
#ifdef ALLOW_PTRACERS
#include "PTRACERS_SIZE.h"
#include "PTRACERS.h"
#endif

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     bi, bj     :: tile indices
C     iMin,iMax  :: Range of points for which calculation is performed.
C     jMin,jMax  :: Range of points for which calculation is performed.
C     trIdentity :: tracer identifier
C     trUseGMRedi:: this tracer use GM-Redi
C     trUseKPP   :: this tracer use KPP
C     myThid     :: Instance number for this innvocation of CALC_3D_DIFFUSIVITY
C     KappaRTr   :: Net diffusivity for this tracer (trIdentity)
      INTEGER bi,bj,iMin,iMax,jMin,jMax
      INTEGER trIdentity
      LOGICAL trUseGMRedi, trUseKPP
      _RL KappaRTr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
      INTEGER myThid

#ifdef ALLOW_GENERIC_ADVDIFF
C     !LOCAL VARIABLES:
C     == Local variables ==
C     i, j, k    :: Loop counters
C     iTr        :: passive tracer index
C     msgBuf     :: message buffer
      INTEGER i,j,k
      _RL KbryanLewis79
      CHARACTER*(MAX_LEN_MBUF) msgBuf
#ifdef ALLOW_PTRACERS
      INTEGER iTr
#endif
CEOP

      IF ( trIdentity.EQ.GAD_TEMPERATURE) THEN

       DO k = 1,Nr
        KbryanLewis79=diffKrBL79surf+(diffKrBL79deep-diffKrBL79surf)
     &  *( atan( -( rF(k)-diffKrBL79Ho )/diffKrBL79scl )/PI+0.5 _d 0)
        DO j = 1-Oly,sNy+Oly
         DO i = 1-Olx,sNx+Olx
          KappaRTr(i,j,k) =
     &         IVDConvCount(i,j,k,bi,bj)*ivdc_kappa
#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
     &       + diffKr(i,j,k,bi,bj)
#else
     &       + diffKr3dT(i,j,k,bi,bj)
#endif
     &       + KbryanLewis79
         ENDDO
        ENDDO
       ENDDO

      ELSEIF ( trIdentity.EQ.GAD_SALINITY) THEN

       DO k = 1,Nr
        KbryanLewis79=diffKrBL79surf+(diffKrBL79deep-diffKrBL79surf)
     &  *( atan( -( rF(k)-diffKrBL79Ho )/diffKrBL79scl )/PI+0.5 _d 0)
        DO j = 1-Oly, sNy+Oly
         DO i = 1-Olx, sNx+Olx
          KappaRTr(i,j,k) =
     &         IVDConvCount(i,j,k,bi,bj)*ivdc_kappa
#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
     &       + diffKr(i,j,k,bi,bj)
#else
     &       + diffKr3dS(i,j,k,bi,bj)
#endif
     &       + KbryanLewis79
         ENDDO
        ENDDO
       ENDDO

#ifdef ALLOW_PTRACERS
      ELSEIF ( trIdentity.GE.GAD_TR1
     &   .AND. trIdentity.LT.GAD_TR1+PTRACERS_numInUse) THEN

       iTr = trIdentity - GAD_TR1 + 1
       DO k = 1,Nr
        KbryanLewis79=diffKrBL79surf+(diffKrBL79deep-diffKrBL79surf)
     &  *( atan( -( rF(k)-diffKrBL79Ho )/diffKrBL79scl )/PI+0.5 _d 0)
        DO j = 1-Oly, sNy+Oly
         DO i = 1-Olx, sNx+Olx
          KappaRTr(i,j,k) =
     &         IVDConvCount(i,j,k,bi,bj)*ivdc_kappa
#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
     &       + diffKr(i,j,k,bi,bj)
#else
     &       + PTRACERS_diffKrNr(k,iTr)
#endif
     &       + KbryanLewis79
         ENDDO
        ENDDO
       ENDDO
#endif /* ALLOW_PTRACERS */

      ELSE
        WRITE(msgBuf,'(A,I4)')
     &      ' CALC_3D_DIFFUSIVITY: Invalid tracer Id: ',trIdentity
        CALL PRINT_ERROR(msgBuf, myThid)
        STOP 'ABNORMAL END: S/R CALC_3D_DIFFUSIVITY'
      ENDIF

C--   Add physical pacakge contributions:

#ifdef ALLOW_GMREDI
      IF (trUseGMRedi) THEN 
         CALL GMREDI_CALC_DIFF(
     I        bi,bj,iMin,iMax,jMin,jMax,0,Nr,
     U        KappaRTr,
     I        myThid)
      ENDIF
#endif

#ifdef ALLOW_KPP
      IF (trUseKPP) THEN
       IF (trIdentity.EQ.GAD_TEMPERATURE) THEN
         CALL KPP_CALC_DIFF_T(
     I        bi,bj,iMin,iMax,jMin,jMax,0,Nr,
     U        KappaRTr,
     I        myThid)
       ELSE
         CALL KPP_CALC_DIFF_S(
     I        bi,bj,iMin,iMax,jMin,jMax,0,Nr,
     U        KappaRTr,
     I        myThid)
       ENDIF
      ENDIF
#endif

#ifdef ALLOW_PP81
      IF (usePP81) THEN
         CALL PP81_CALC_DIFF(
     I        bi,bj,iMin,iMax,jMin,jMax,0,Nr,
     U        KappaRTr,
     I        myThid)
      ENDIF
#endif

#ifdef ALLOW_MY82
      IF (useMY82) THEN
         CALL MY82_CALC_DIFF(
     I        bi,bj,iMin,iMax,jMin,jMax,0,Nr,
     U        KappaRTr,
     I        myThid)
      ENDIF
#endif
      
#ifdef ALLOW_GGL90
      IF (useGGL90) THEN
         CALL GGL90_CALC_DIFF(
     I        bi,bj,iMin,iMax,jMin,jMax,0,Nr,
     O        KappaRTr,
     I        myThid)
      ENDIF
#endif
      
C-    Apply mask to vertical diffusivity 
C jmc: don't have the impression that masking is needed 
C      but could be removed later if it's the case.
c     DO j = 1-Oly, sNy+Oly
c      DO i = 1-Olx, sNx+Olx
c       KappaRTr(i,j,k) = maskUp(i,j)*KappaRTr(i,j,k)
c      ENDDO
c     ENDDO

#endif /* ALLOW_GENERIC_ADVDIFF */

      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/model/src/calc_3d_diffusivity.F,v 1.4 2005/11/04 01:19:24 jmc Exp $
2	C $Name: $
3
4	#include "PACKAGES_CONFIG.h"
5	#include "CPP_OPTIONS.h"
6
7	CBOP
8	C !ROUTINE: CALC_3D_DIFFUSIVITY
9	C !INTERFACE:
10	SUBROUTINE CALC_3D_DIFFUSIVITY(
11	I bi,bj,iMin,iMax,jMin,jMax,
12	I trIdentity, trUseGMRedi, trUseKPP,
13	O KappaRTr,
14	I myThid)
15
16	C !DESCRIPTION: \bv
17	C ==========================================================
18	C \| SUBROUTINE CALC_3D_DIFFUSIVITY
19	C \| o Calculate net (3D) vertical diffusivity for 1 tracer
20	C ==========================================================
21	C \| Combines spatially varying diffusion coefficients from
22	C \| KPP and/or GM and/or convective stability test.
23	C ==========================================================
24	C \ev
25
26	C !USES:
27	IMPLICIT NONE
28	C == GLobal variables ==
29	#include "SIZE.h"
30	#include "EEPARAMS.h"
31	#include "PARAMS.h"
32	#include "DYNVARS.h"
33	#include "GRID.h"
34	#ifdef ALLOW_GENERIC_ADVDIFF
35	#include "GAD.h"
36	#endif
37	#ifdef ALLOW_PTRACERS
38	#include "PTRACERS_SIZE.h"
39	#include "PTRACERS.h"
40	#endif
41
42	C !INPUT/OUTPUT PARAMETERS:
43	C == Routine arguments ==
44	C bi, bj :: tile indices
45	C iMin,iMax :: Range of points for which calculation is performed.
46	C jMin,jMax :: Range of points for which calculation is performed.
47	C trIdentity :: tracer identifier
48	C trUseGMRedi:: this tracer use GM-Redi
49	C trUseKPP :: this tracer use KPP
50	C myThid :: Instance number for this innvocation of CALC_3D_DIFFUSIVITY
51	C KappaRTr :: Net diffusivity for this tracer (trIdentity)
52	INTEGER bi,bj,iMin,iMax,jMin,jMax
53	INTEGER trIdentity
54	LOGICAL trUseGMRedi, trUseKPP
55	_RL KappaRTr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
56	INTEGER myThid
57
58	#ifdef ALLOW_GENERIC_ADVDIFF
59	C !LOCAL VARIABLES:
60	C == Local variables ==
61	C i, j, k :: Loop counters
62	C iTr :: passive tracer index
63	C msgBuf :: message buffer
64	INTEGER i,j,k
65	_RL KbryanLewis79
66	CHARACTER*(MAX_LEN_MBUF) msgBuf
67	#ifdef ALLOW_PTRACERS
68	INTEGER iTr
69	#endif
70	CEOP
71
72	IF ( trIdentity.EQ.GAD_TEMPERATURE) THEN
73
74	DO k = 1,Nr
75	KbryanLewis79=diffKrBL79surf+(diffKrBL79deep-diffKrBL79surf)
76	& *( atan( -( rF(k)-diffKrBL79Ho )/diffKrBL79scl )/PI+0.5 _d 0)
77	DO j = 1-Oly,sNy+Oly
78	DO i = 1-Olx,sNx+Olx
79	KappaRTr(i,j,k) =
80	& IVDConvCount(i,j,k,bi,bj)*ivdc_kappa
81	#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
82	& + diffKr(i,j,k,bi,bj)
83	#else
84	& + diffKr3dT(i,j,k,bi,bj)
85	#endif
86	& + KbryanLewis79
87	ENDDO
88	ENDDO
89	ENDDO
90
91	ELSEIF ( trIdentity.EQ.GAD_SALINITY) THEN
92
93	DO k = 1,Nr
94	KbryanLewis79=diffKrBL79surf+(diffKrBL79deep-diffKrBL79surf)
95	& *( atan( -( rF(k)-diffKrBL79Ho )/diffKrBL79scl )/PI+0.5 _d 0)
96	DO j = 1-Oly, sNy+Oly
97	DO i = 1-Olx, sNx+Olx
98	KappaRTr(i,j,k) =
99	& IVDConvCount(i,j,k,bi,bj)*ivdc_kappa
100	#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
101	& + diffKr(i,j,k,bi,bj)
102	#else
103	& + diffKr3dS(i,j,k,bi,bj)
104	#endif
105	& + KbryanLewis79
106	ENDDO
107	ENDDO
108	ENDDO
109
110	#ifdef ALLOW_PTRACERS
111	ELSEIF ( trIdentity.GE.GAD_TR1
112	& .AND. trIdentity.LT.GAD_TR1+PTRACERS_numInUse) THEN
113
114	iTr = trIdentity - GAD_TR1 + 1
115	DO k = 1,Nr
116	KbryanLewis79=diffKrBL79surf+(diffKrBL79deep-diffKrBL79surf)
117	& *( atan( -( rF(k)-diffKrBL79Ho )/diffKrBL79scl )/PI+0.5 _d 0)
118	DO j = 1-Oly, sNy+Oly
119	DO i = 1-Olx, sNx+Olx
120	KappaRTr(i,j,k) =
121	& IVDConvCount(i,j,k,bi,bj)*ivdc_kappa
122	#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
123	& + diffKr(i,j,k,bi,bj)
124	#else
125	& + PTRACERS_diffKrNr(k,iTr)
126	#endif
127	& + KbryanLewis79
128	ENDDO
129	ENDDO
130	ENDDO
131	#endif /* ALLOW_PTRACERS */
132
133	ELSE
134	WRITE(msgBuf,'(A,I4)')
135	& ' CALC_3D_DIFFUSIVITY: Invalid tracer Id: ',trIdentity
136	CALL PRINT_ERROR(msgBuf, myThid)
137	STOP 'ABNORMAL END: S/R CALC_3D_DIFFUSIVITY'
138	ENDIF
139
140	C-- Add physical pacakge contributions:
141
142	#ifdef ALLOW_GMREDI
143	IF (trUseGMRedi) THEN
144	CALL GMREDI_CALC_DIFF(
145	I bi,bj,iMin,iMax,jMin,jMax,0,Nr,
146	U KappaRTr,
147	I myThid)
148	ENDIF
149	#endif
150
151	#ifdef ALLOW_KPP
152	IF (trUseKPP) THEN
153	IF (trIdentity.EQ.GAD_TEMPERATURE) THEN
154	CALL KPP_CALC_DIFF_T(
155	I bi,bj,iMin,iMax,jMin,jMax,0,Nr,
156	U KappaRTr,
157	I myThid)
158	ELSE
159	CALL KPP_CALC_DIFF_S(
160	I bi,bj,iMin,iMax,jMin,jMax,0,Nr,
161	U KappaRTr,
162	I myThid)
163	ENDIF
164	ENDIF
165	#endif
166
167	#ifdef ALLOW_PP81
168	IF (usePP81) THEN
169	CALL PP81_CALC_DIFF(
170	I bi,bj,iMin,iMax,jMin,jMax,0,Nr,
171	U KappaRTr,
172	I myThid)
173	ENDIF
174	#endif
175
176	#ifdef ALLOW_MY82
177	IF (useMY82) THEN
178	CALL MY82_CALC_DIFF(
179	I bi,bj,iMin,iMax,jMin,jMax,0,Nr,
180	U KappaRTr,
181	I myThid)
182	ENDIF
183	#endif
184
185	#ifdef ALLOW_GGL90
186	IF (useGGL90) THEN
187	CALL GGL90_CALC_DIFF(
188	I bi,bj,iMin,iMax,jMin,jMax,0,Nr,
189	O KappaRTr,
190	I myThid)
191	ENDIF
192	#endif
193
194	C- Apply mask to vertical diffusivity
195	C jmc: don't have the impression that masking is needed
196	C but could be removed later if it's the case.
197	c DO j = 1-Oly, sNy+Oly
198	c DO i = 1-Olx, sNx+Olx
199	c KappaRTr(i,j,k) = maskUp(i,j)*KappaRTr(i,j,k)
200	c ENDDO
201	c ENDDO
202
203	#endif /* ALLOW_GENERIC_ADVDIFF */
204
205	RETURN
206	END