1 |
C $Header: /u/gcmpack/MITgcm/pkg/shap_filt/shap_filt_tracer_s4.F,v 1.5 2004/12/04 00:19:12 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "SHAP_FILT_OPTIONS.h" |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: SHAP_FILT_TRACER_S4 |
8 |
C !INTERFACE: |
9 |
SUBROUTINE SHAP_FILT_TRACER_S4( |
10 |
U field, tmpFld, |
11 |
I nShapTr, kSize, myTime, myThid ) |
12 |
C !DESCRIPTION: \bv |
13 |
C *==========================================================* |
14 |
C | S/R SHAP_FILT_TRACER_S4 |
15 |
C | o Applies Shapiro filter to tracer field (cell center). |
16 |
C | o use filtering function "S4" = [1 - d_xx^n][1- d_yy^n] |
17 |
C | with no grid spacing (computational Filter) |
18 |
C *==========================================================* |
19 |
C \ev |
20 |
|
21 |
C !USES: |
22 |
IMPLICIT NONE |
23 |
|
24 |
C == Global variables === |
25 |
#include "SIZE.h" |
26 |
#include "EEPARAMS.h" |
27 |
#include "PARAMS.h" |
28 |
#include "GRID.h" |
29 |
#include "SHAP_FILT.h" |
30 |
|
31 |
C !INPUT/OUTPUT PARAMETERS: |
32 |
C == Routine arguments |
33 |
C field :: cell-centered 2D field on which filter applies |
34 |
C tmpFld :: working temporary array |
35 |
C nShapTr :: (total) power of the filter for this tracer |
36 |
C kSize :: length of 3rd Dim : either =1 (2D field) or =Nr (3D field) |
37 |
C myTime :: Current time in simulation |
38 |
C myThid :: Thread number for this instance of SHAP_FILT_TRACER_S4 |
39 |
INTEGER nShapTr, kSize |
40 |
_RL field(1-OLx:sNx+OLx,1-OLy:sNy+OLy,kSize,nSx,nSy) |
41 |
_RL tmpFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,kSize,nSx,nSy) |
42 |
_RL myTime |
43 |
INTEGER myThid |
44 |
|
45 |
#ifdef ALLOW_SHAP_FILT |
46 |
|
47 |
C !LOCAL VARIABLES: |
48 |
C == Local variables == |
49 |
INTEGER bi,bj,K,I,J,N |
50 |
_RL tmpGrd(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
51 |
CEOP |
52 |
|
53 |
IF (nShapTr.gt.0) THEN |
54 |
|
55 |
DO bj=myByLo(myThid),myByHi(myThid) |
56 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
57 |
DO K=1,kSize |
58 |
DO J=1-OLy,sNy+Oly |
59 |
DO I=1-Olx,sNx+Olx |
60 |
tmpFld(i,j,k,bi,bj)=field(i,j,k,bi,bj) |
61 |
ENDDO |
62 |
ENDDO |
63 |
ENDDO |
64 |
ENDDO |
65 |
ENDDO |
66 |
|
67 |
|
68 |
C d_xx^n tmpFld |
69 |
|
70 |
DO N=1,nShapTr |
71 |
|
72 |
IF (kSize.EQ.Nr) THEN |
73 |
_EXCH_XYZ_RL( tmpFld, myThid ) |
74 |
ELSE |
75 |
_EXCH_XY_RL( tmpFld, myThid ) |
76 |
ENDIF |
77 |
|
78 |
DO bj=myByLo(myThid),myByHi(myThid) |
79 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
80 |
DO K=1,kSize |
81 |
|
82 |
DO J=1,sNy |
83 |
DO I=1,sNx |
84 |
tmpGrd(i,j) = -0.25*( |
85 |
& ( tmpFld(i+1,j,k,bi,bj)-tmpFld( i ,j,k,bi,bj) ) |
86 |
& *_maskW(i+1,j,k,bi,bj) |
87 |
& -( tmpFld( i ,j,k,bi,bj)-tmpFld(i-1,j,k,bi,bj) ) |
88 |
& *_maskW(i,j,k,bi,bj) ) |
89 |
ENDDO |
90 |
ENDDO |
91 |
|
92 |
DO J=1,sNy |
93 |
DO I=1,sNx |
94 |
tmpFld(i,j,k,bi,bj) = tmpGrd(i,j) |
95 |
ENDDO |
96 |
ENDDO |
97 |
|
98 |
ENDDO |
99 |
ENDDO |
100 |
ENDDO |
101 |
|
102 |
ENDDO |
103 |
|
104 |
C F <- [1 - d_xx^n *deltaT/tau].F |
105 |
DO bj=myByLo(myThid),myByHi(myThid) |
106 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
107 |
DO K=1,kSize |
108 |
DO J=1,sNy |
109 |
DO I=1,sNx |
110 |
field(i,j,k,bi,bj)=field(i,j,k,bi,bj) |
111 |
& -tmpFld(i,j,k,bi,bj)*dTtracerLev(1)/Shap_Trtau |
112 |
tmpFld(i,j,k,bi,bj)=field(i,j,k,bi,bj) |
113 |
ENDDO |
114 |
ENDDO |
115 |
ENDDO |
116 |
ENDDO |
117 |
ENDDO |
118 |
|
119 |
|
120 |
C d_yy^n tmpFld |
121 |
|
122 |
DO N=1,nShapTr |
123 |
|
124 |
IF (kSize.EQ.1) THEN |
125 |
_EXCH_XY_RL( tmpFld, myThid ) |
126 |
ELSE |
127 |
_EXCH_XYZ_RL( tmpFld, myThid ) |
128 |
ENDIF |
129 |
|
130 |
DO bj=myByLo(myThid),myByHi(myThid) |
131 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
132 |
DO K=1,kSize |
133 |
|
134 |
DO J=1,sNy |
135 |
DO I=1,sNx |
136 |
tmpGrd(i,j) = -0.25*( |
137 |
& ( tmpFld(i,j+1,k,bi,bj)-tmpFld(i, j ,k,bi,bj) ) |
138 |
& *_maskS(i,j+1,k,bi,bj) |
139 |
& -( tmpFld(i, j ,k,bi,bj)-tmpFld(i,j-1,k,bi,bj) ) |
140 |
& *_maskS(i,j,k,bi,bj) ) |
141 |
ENDDO |
142 |
ENDDO |
143 |
|
144 |
DO J=1,sNy |
145 |
DO I=1,sNx |
146 |
tmpFld(i,j,k,bi,bj) = tmpGrd(i,j) |
147 |
ENDDO |
148 |
ENDDO |
149 |
|
150 |
ENDDO |
151 |
ENDDO |
152 |
ENDDO |
153 |
|
154 |
ENDDO |
155 |
|
156 |
C F <- [1 - d_yy^n *deltaT/tau].F |
157 |
DO bj=myByLo(myThid),myByHi(myThid) |
158 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
159 |
DO K=1,kSize |
160 |
DO J=1,sNy |
161 |
DO I=1,sNx |
162 |
field(i,j,k,bi,bj)=field(i,j,k,bi,bj) |
163 |
& -tmpFld(i,j,k,bi,bj)*dTtracerLev(1)/Shap_Trtau |
164 |
ENDDO |
165 |
ENDDO |
166 |
ENDDO |
167 |
ENDDO |
168 |
ENDDO |
169 |
|
170 |
IF (kSize.EQ.Nr) THEN |
171 |
_EXCH_XYZ_RL( field, myThid ) |
172 |
ELSEIF (kSize.EQ.1) THEN |
173 |
_EXCH_XY_RL( field, myThid ) |
174 |
ELSE |
175 |
STOP 'S/R SHAP_FILT_TRACER_S4: kSize is wrong' |
176 |
ENDIF |
177 |
|
178 |
ENDIF |
179 |
#endif /* ALLOW_SHAP_FILT */ |
180 |
|
181 |
RETURN |
182 |
END |