/[MITgcm]/MITgcm/model/src/external_forcing.F
ViewVC logotype

Contents of /MITgcm/model/src/external_forcing.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.54 - (show annotations) (download)
Sun Aug 24 21:46:19 2008 UTC (15 years, 8 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint62a, checkpoint62, checkpoint61f, checkpoint61n, checkpoint61q, checkpoint61e, checkpoint61g, checkpoint61d, checkpoint61c, checkpoint61o, checkpoint61l, checkpoint61m, checkpoint61j, checkpoint61k, checkpoint61h, checkpoint61i, checkpoint61v, checkpoint61w, checkpoint61t, checkpoint61u, checkpoint61r, checkpoint61s, checkpoint61p, checkpoint61z, checkpoint61x, checkpoint61y
Changes since 1.53: +61 -7 lines
add implied forcing corresponding to mass source/sink of fluid

1 C $Header: /u/gcmpack/MITgcm/model/src/external_forcing.F,v 1.53 2008/05/30 02:45:43 gforget Exp $
2 C $Name: $
3
4 #include "PACKAGES_CONFIG.h"
5 #include "CPP_OPTIONS.h"
6
7 CBOP
8 C !ROUTINE: EXTERNAL_FORCING_U
9 C !INTERFACE:
10 SUBROUTINE EXTERNAL_FORCING_U(
11 I iMin,iMax, jMin,jMax, bi,bj, kLev,
12 I myTime, myThid )
13 C !DESCRIPTION: \bv
14 C *==========================================================*
15 C | S/R EXTERNAL_FORCING_U
16 C | o Contains problem specific forcing for zonal velocity.
17 C *==========================================================*
18 C | Adds terms to gU for forcing by external sources
19 C | e.g. wind stress, bottom friction etc ...
20 C *==========================================================*
21 C \ev
22
23 C !USES:
24 IMPLICIT NONE
25 C == Global data ==
26 #include "SIZE.h"
27 #include "EEPARAMS.h"
28 #include "PARAMS.h"
29 #include "GRID.h"
30 #include "DYNVARS.h"
31 #include "FFIELDS.h"
32
33 C !INPUT/OUTPUT PARAMETERS:
34 C == Routine arguments ==
35 C iMin,iMax :: Working range of x-index for applying forcing.
36 C jMin,jMax :: Working range of y-index for applying forcing.
37 C bi,bj :: Current tile indices
38 C kLev :: Current vertical level index
39 C myTime :: Current time in simulation
40 C myThid :: Thread Id number
41 INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
42 _RL myTime
43 INTEGER myThid
44
45 C !LOCAL VARIABLES:
46 C == Local variables ==
47 C i,j :: Loop counters
48 C kSurface :: index of surface layer
49 INTEGER i, j
50 INTEGER kSurface
51 CEOP
52
53 IF ( fluidIsAir ) THEN
54 kSurface = 0
55 ELSEIF ( usingPCoords ) THEN
56 kSurface = Nr
57 ELSE
58 kSurface = 1
59 ENDIF
60
61 C-- Forcing term
62 #ifdef ALLOW_AIM
63 IF ( useAIM ) CALL AIM_TENDENCY_APPLY_U(
64 & iMin,iMax, jMin,jMax, bi,bj, kLev,
65 & myTime, myThid )
66 #endif /* ALLOW_AIM */
67
68 #ifdef ALLOW_FIZHI
69 IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_U(
70 & iMin,iMax, jMin,jMax, bi,bj, kLev,
71 & myTime, myThid )
72 #endif /* ALLOW_FIZHI */
73
74 C Add windstress momentum impulse into the top-layer
75 IF ( kLev .EQ. kSurface ) THEN
76 c DO j=1,sNy
77 C-jmc: Without CD-scheme, this is OK ; but with CD-scheme, needs to cover [0:sNy+1]
78 DO j=0,sNy+1
79 DO i=1,sNx+1
80 gU(i,j,kLev,bi,bj) = gU(i,j,kLev,bi,bj)
81 & +foFacMom*surfaceForcingU(i,j,bi,bj)
82 & *recip_drF(kLev)*_recip_hFacW(i,j,kLev,bi,bj)
83 ENDDO
84 ENDDO
85 ENDIF
86
87 #ifdef ALLOW_EDDYPSI
88 CALL TAUEDDY_EXTERNAL_FORCING_U(
89 I iMin,iMax, jMin,jMax, bi,bj, kLev,
90 I myTime, myThid )
91 #endif
92
93 #ifdef ALLOW_OBCS
94 IF (useOBCS) THEN
95 CALL OBCS_SPONGE_U(
96 I iMin,iMax, jMin,jMax, bi,bj, kLev,
97 I myTime, myThid )
98 ENDIF
99 #endif
100
101 #ifdef ALLOW_MYPACKAGE
102 IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_U(
103 & iMin,iMax, jMin,jMax, bi,bj, kLev,
104 & myTime, myThid )
105 #endif /* ALLOW_MYPACKAGE */
106
107 RETURN
108 END
109
110 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
111 CBOP
112 C !ROUTINE: EXTERNAL_FORCING_V
113 C !INTERFACE:
114 SUBROUTINE EXTERNAL_FORCING_V(
115 I iMin,iMax, jMin,jMax, bi,bj, kLev,
116 I myTime, myThid )
117 C !DESCRIPTION: \bv
118 C *==========================================================*
119 C | S/R EXTERNAL_FORCING_V
120 C | o Contains problem specific forcing for merid velocity.
121 C *==========================================================*
122 C | Adds terms to gV for forcing by external sources
123 C | e.g. wind stress, bottom friction etc ...
124 C *==========================================================*
125 C \ev
126
127 C !USES:
128 IMPLICIT NONE
129 C == Global data ==
130 #include "SIZE.h"
131 #include "EEPARAMS.h"
132 #include "PARAMS.h"
133 #include "GRID.h"
134 #include "DYNVARS.h"
135 #include "FFIELDS.h"
136
137 C !INPUT/OUTPUT PARAMETERS:
138 C == Routine arguments ==
139 C iMin,iMax :: Working range of x-index for applying forcing.
140 C jMin,jMax :: Working range of y-index for applying forcing.
141 C bi,bj :: Current tile indices
142 C kLev :: Current vertical level index
143 C myTime :: Current time in simulation
144 C myThid :: Thread Id number
145 INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
146 _RL myTime
147 INTEGER myThid
148
149 C !LOCAL VARIABLES:
150 C == Local variables ==
151 C i,j :: Loop counters
152 C kSurface :: index of surface layer
153 INTEGER i, j
154 INTEGER kSurface
155 CEOP
156
157 IF ( fluidIsAir ) THEN
158 kSurface = 0
159 ELSEIF ( usingPCoords ) THEN
160 kSurface = Nr
161 ELSE
162 kSurface = 1
163 ENDIF
164
165 C-- Forcing term
166 #ifdef ALLOW_AIM
167 IF ( useAIM ) CALL AIM_TENDENCY_APPLY_V(
168 & iMin,iMax, jMin,jMax, bi,bj, kLev,
169 & myTime, myThid )
170 #endif /* ALLOW_AIM */
171
172 #ifdef ALLOW_FIZHI
173 IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_V(
174 & iMin,iMax, jMin,jMax, bi,bj, kLev,
175 & myTime, myThid )
176 #endif /* ALLOW_FIZHI */
177
178 C Add windstress momentum impulse into the top-layer
179 IF ( kLev .EQ. kSurface ) THEN
180 DO j=1,sNy+1
181 c DO i=1,sNx
182 C-jmc: Without CD-scheme, this is OK ; but with CD-scheme, needs to cover [0:sNx+1]
183 DO i=0,sNx+1
184 gV(i,j,kLev,bi,bj) = gV(i,j,kLev,bi,bj)
185 & +foFacMom*surfaceForcingV(i,j,bi,bj)
186 & *recip_drF(kLev)*_recip_hFacS(i,j,kLev,bi,bj)
187 ENDDO
188 ENDDO
189 ENDIF
190
191 #ifdef ALLOW_EDDYPSI
192 CALL TAUEDDY_EXTERNAL_FORCING_V(
193 I iMin,iMax, jMin,jMax, bi,bj, kLev,
194 I myTime, myThid )
195 #endif
196
197 #ifdef ALLOW_OBCS
198 IF (useOBCS) THEN
199 CALL OBCS_SPONGE_V(
200 I iMin,iMax, jMin,jMax, bi,bj, kLev,
201 I myTime, myThid )
202 ENDIF
203 #endif
204
205 #ifdef ALLOW_MYPACKAGE
206 IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_V(
207 & iMin,iMax, jMin,jMax, bi,bj, kLev,
208 & myTime, myThid )
209 #endif /* ALLOW_MYPACKAGE */
210
211 RETURN
212 END
213
214 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
215 CBOP
216 C !ROUTINE: EXTERNAL_FORCING_T
217 C !INTERFACE:
218 SUBROUTINE EXTERNAL_FORCING_T(
219 I iMin,iMax, jMin,jMax, bi,bj, kLev,
220 I myTime, myThid )
221 C !DESCRIPTION: \bv
222 C *==========================================================*
223 C | S/R EXTERNAL_FORCING_T
224 C | o Contains problem specific forcing for temperature.
225 C *==========================================================*
226 C | Adds terms to gT for forcing by external sources
227 C | e.g. heat flux, climatalogical relaxation, etc ...
228 C *==========================================================*
229 C \ev
230
231 C !USES:
232 IMPLICIT NONE
233 C == Global data ==
234 #include "SIZE.h"
235 #include "EEPARAMS.h"
236 #include "PARAMS.h"
237 #include "GRID.h"
238 #include "DYNVARS.h"
239 #include "FFIELDS.h"
240 #include "SURFACE.h"
241
242 C !INPUT/OUTPUT PARAMETERS:
243 C == Routine arguments ==
244 C iMin,iMax :: Working range of x-index for applying forcing.
245 C jMin,jMax :: Working range of y-index for applying forcing.
246 C bi,bj :: Current tile indices
247 C kLev :: Current vertical level index
248 C myTime :: Current time in simulation
249 C myThid :: Thread Id number
250 INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
251 _RL myTime
252 INTEGER myThid
253
254 C !LOCAL VARIABLES:
255 C == Local variables ==
256 C i,j :: Loop counters
257 C kSurface :: index of surface layer
258 INTEGER i, j
259 INTEGER kSurface
260 CEOP
261 #ifdef SHORTWAVE_HEATING
262 integer two
263 _RL minusone
264 parameter (two=2,minusone=-1.)
265 _RL swfracb(two)
266 INTEGER kp1
267 #endif
268
269 IF ( fluidIsAir ) THEN
270 kSurface = 0
271 ELSEIF ( usingPCoords ) THEN
272 kSurface = Nr
273 ELSE
274 kSurface = 1
275 ENDIF
276
277 C-- Forcing term
278 #ifdef ALLOW_AIM
279 IF ( useAIM ) CALL AIM_TENDENCY_APPLY_T(
280 & iMin,iMax, jMin,jMax, bi,bj, kLev,
281 & myTime, myThid )
282 #endif /* ALLOW_AIM */
283
284 #ifdef ALLOW_FIZHI
285 IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_T(
286 & iMin,iMax, jMin,jMax, bi,bj, kLev,
287 & myTime, myThid )
288 #endif /* ALLOW_FIZHI */
289
290 #ifdef ALLOW_ADDFLUID
291 IF ( selectAddFluid.NE.0 .AND. temp_EvPrRn.NE.UNSET_RL ) THEN
292 C- for now, use same fluid properties as for E-P-R
293 IF ( ( selectAddFluid.GE.1 .AND. nonlinFreeSurf.GT.0 )
294 & .OR. convertFW2Salt.EQ.-1. _d 0 ) THEN
295 DO j=1,sNy
296 DO i=1,sNx
297 gT(i,j,kLev,bi,bj) = gT(i,j,kLev,bi,bj)
298 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
299 & *( temp_EvPrRn - theta(i,j,kLev,bi,bj) )
300 & *recip_rA(i,j,bi,bj)
301 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
302 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
303 ENDDO
304 ENDDO
305 ELSE
306 DO j=1,sNy
307 DO i=1,sNx
308 gT(i,j,kLev,bi,bj) = gT(i,j,kLev,bi,bj)
309 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
310 & *( temp_EvPrRn - tRef(kLev) )
311 & *recip_rA(i,j,bi,bj)
312 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
313 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
314 ENDDO
315 ENDDO
316 ENDIF
317 ENDIF
318 #endif /* ALLOW_ADDFLUID */
319
320 C Add heat in top-layer
321 IF ( kLev .EQ. kSurface ) THEN
322 DO j=1,sNy
323 DO i=1,sNx
324 gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
325 & +surfaceForcingT(i,j,bi,bj)
326 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
327 ENDDO
328 ENDDO
329 ENDIF
330
331 IF (linFSConserveTr) THEN
332 DO j=1,sNy
333 DO i=1,sNx
334 IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
335 gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
336 & +TsurfCor*recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
337 ENDIF
338 ENDDO
339 ENDDO
340 ENDIF
341
342 #ifdef ALLOW_SHELFICE
343 IF ( useShelfIce )
344 & CALL SHELFICE_FORCING_T(
345 I iMin,iMax, jMin,jMax, bi,bj, kLev,
346 I myTime, myThid )
347 #endif /* ALLOW_SHELFICE */
348
349 #ifdef SHORTWAVE_HEATING
350 C Penetrating SW radiation
351 c IF ( usePenetratingSW ) THEN
352 swfracb(1)=abs(rF(klev))
353 swfracb(2)=abs(rF(klev+1))
354 CALL SWFRAC(
355 I two, minusone,
356 U swfracb,
357 I myTime, 1, myThid )
358 kp1 = klev+1
359 IF (klev.EQ.Nr) THEN
360 kp1 = klev
361 swfracb(2)=0. _d 0
362 ENDIF
363 DO j=1,sNy
364 DO i=1,sNx
365 gT(i,j,klev,bi,bj) = gT(i,j,klev,bi,bj)
366 & -Qsw(i,j,bi,bj)*(swfracb(1)*maskC(i,j,klev,bi,bj)
367 & -swfracb(2)*maskC(i,j,kp1, bi,bj))
368 & *recip_Cp*mass2rUnit
369 & *recip_drF(klev)*_recip_hFacC(i,j,kLev,bi,bj)
370 ENDDO
371 ENDDO
372 c ENDIF
373 #endif
374
375 #ifdef ALLOW_RBCS
376 IF (useRBCS) THEN
377 CALL RBCS_ADD_TENDENCY(bi,bj,klev, 1,
378 & myTime, myThid )
379 ENDIF
380 #endif
381
382 #ifdef ALLOW_OBCS
383 IF (useOBCS) THEN
384 CALL OBCS_SPONGE_T(
385 I iMin,iMax, jMin,jMax, bi,bj, kLev,
386 I myTime, myThid )
387 ENDIF
388 #endif
389
390 #ifdef ALLOW_MYPACKAGE
391 IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_T(
392 & iMin,iMax, jMin,jMax, bi,bj, kLev,
393 & myTime, myThid )
394 #endif /* ALLOW_MYPACKAGE */
395
396 RETURN
397 END
398
399 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
400 CBOP
401 C !ROUTINE: EXTERNAL_FORCING_S
402 C !INTERFACE:
403 SUBROUTINE EXTERNAL_FORCING_S(
404 I iMin,iMax, jMin,jMax, bi,bj, kLev,
405 I myTime, myThid )
406
407 C !DESCRIPTION: \bv
408 C *==========================================================*
409 C | S/R EXTERNAL_FORCING_S
410 C | o Contains problem specific forcing for merid velocity.
411 C *==========================================================*
412 C | Adds terms to gS for forcing by external sources
413 C | e.g. fresh-water flux, climatalogical relaxation, etc ...
414 C *==========================================================*
415 C \ev
416
417 C !USES:
418 IMPLICIT NONE
419 C == Global data ==
420 #include "SIZE.h"
421 #include "EEPARAMS.h"
422 #include "PARAMS.h"
423 #include "GRID.h"
424 #include "DYNVARS.h"
425 #include "FFIELDS.h"
426 #include "SURFACE.h"
427
428 C !INPUT/OUTPUT PARAMETERS:
429 C == Routine arguments ==
430 C iMin,iMax :: Working range of x-index for applying forcing.
431 C jMin,jMax :: Working range of y-index for applying forcing.
432 C bi,bj :: Current tile indices
433 C kLev :: Current vertical level index
434 C myTime :: Current time in simulation
435 C myThid :: Thread Id number
436 INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
437 _RL myTime
438 INTEGER myThid
439
440 C !LOCAL VARIABLES:
441 C == Local variables ==
442 C i,j :: Loop counters
443 C kSurface :: index of surface layer
444 INTEGER i, j
445 INTEGER kSurface
446 CEOP
447
448 IF ( fluidIsAir ) THEN
449 kSurface = 0
450 ELSEIF ( usingPCoords ) THEN
451 kSurface = Nr
452 ELSE
453 kSurface = 1
454 ENDIF
455
456 C-- Forcing term
457 #ifdef ALLOW_AIM
458 IF ( useAIM ) CALL AIM_TENDENCY_APPLY_S(
459 & iMin,iMax, jMin,jMax, bi,bj, kLev,
460 & myTime, myThid )
461 #endif /* ALLOW_AIM */
462
463 #ifdef ALLOW_FIZHI
464 IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_S(
465 & iMin,iMax, jMin,jMax, bi,bj, kLev,
466 & myTime, myThid )
467 #endif /* ALLOW_FIZHI */
468
469 #ifdef ALLOW_ADDFLUID
470 IF ( selectAddFluid.NE.0 .AND. salt_EvPrRn.NE.UNSET_RL ) THEN
471 C- for now, use same fluid properties as for E-P-R
472 IF ( ( selectAddFluid.GE.1 .AND. nonlinFreeSurf.GT.0 )
473 & .OR. convertFW2Salt.EQ.-1. _d 0 ) THEN
474 DO j=1,sNy
475 DO i=1,sNx
476 gS(i,j,kLev,bi,bj) = gS(i,j,kLev,bi,bj)
477 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
478 & *( salt_EvPrRn - salt(i,j,kLev,bi,bj) )
479 & *recip_rA(i,j,bi,bj)
480 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
481 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
482 ENDDO
483 ENDDO
484 ELSE
485 DO j=1,sNy
486 DO i=1,sNx
487 gS(i,j,kLev,bi,bj) = gS(i,j,kLev,bi,bj)
488 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
489 & *( salt_EvPrRn - sRef(kLev) )
490 & *recip_rA(i,j,bi,bj)
491 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
492 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
493 ENDDO
494 ENDDO
495 ENDIF
496 ENDIF
497 #endif /* ALLOW_ADDFLUID */
498
499 C Add fresh-water in top-layer
500 IF ( kLev .EQ. kSurface ) THEN
501 DO j=1,sNy
502 DO i=1,sNx
503 gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
504 & +surfaceForcingS(i,j,bi,bj)
505 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
506 ENDDO
507 ENDDO
508 ENDIF
509
510 IF (linFSConserveTr) THEN
511 DO j=1,sNy
512 DO i=1,sNx
513 IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
514 gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
515 & +SsurfCor*recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
516 ENDIF
517 ENDDO
518 ENDDO
519 ENDIF
520
521 #ifdef ALLOW_SHELFICE
522 IF ( useShelfIce )
523 & CALL SHELFICE_FORCING_S(
524 I iMin,iMax, jMin,jMax, bi,bj, kLev,
525 I myTime, myThid )
526 #endif /* ALLOW_SHELFICE */
527
528 #ifdef ALLOW_SALT_PLUME
529 IF ( useSALT_PLUME )
530 & CALL SALT_PLUME_TENDENCY_APPLY_S(
531 I iMin,iMax, jMin,jMax, bi,bj, kLev,
532 I myTime, myThid )
533 #endif /* ALLOW_SALT_PLUME */
534
535 #ifdef ALLOW_RBCS
536 IF (useRBCS) THEN
537 CALL RBCS_ADD_TENDENCY(bi,bj,klev, 2,
538 & myTime, myThid )
539 ENDIF
540 #endif /* ALLOW_RBCS */
541
542 #ifdef ALLOW_OBCS
543 IF (useOBCS) THEN
544 CALL OBCS_SPONGE_S(
545 I iMin,iMax, jMin,jMax, bi,bj, kLev,
546 I myTime, myThid )
547 ENDIF
548 #endif /* ALLOW_OBCS */
549
550 #ifdef ALLOW_MYPACKAGE
551 IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_S(
552 & iMin,iMax, jMin,jMax, bi,bj, kLev,
553 & myTime, myThid )
554 #endif /* ALLOW_MYPACKAGE */
555
556 RETURN
557 END

  ViewVC Help
Powered by ViewVC 1.1.22