/[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.57 - (show annotations) (download)
Mon Apr 26 20:37:02 2010 UTC (14 years ago) by dimitri
Branch: MAIN
CVS Tags: checkpoint62v, checkpoint62u, checkpoint62t, checkpoint62s, checkpoint62r, checkpoint62q, checkpoint62p, checkpoint62g, checkpoint62f, checkpoint62k, checkpoint62j, checkpoint62i, checkpoint62h, checkpoint62o, checkpoint62n, checkpoint62m, checkpoint62l, checkpoint62w, checkpoint62x
Changes since 1.56: +7 -9 lines
Adding parameters to specify temperature and salinity of addMass array
separately from temp_EvPrRn and salt_EvPrRn

1 C $Header: /u/gcmpack/MITgcm/model/src/external_forcing.F,v 1.56 2010/02/16 21:25:22 dimitri 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_addMass.NE.UNSET_RL ) THEN
292 IF ( ( selectAddFluid.GE.1 .AND. nonlinFreeSurf.GT.0 )
293 & .OR. convertFW2Salt.EQ.-1. _d 0 ) THEN
294 DO j=1,sNy
295 DO i=1,sNx
296 gT(i,j,kLev,bi,bj) = gT(i,j,kLev,bi,bj)
297 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
298 & *( temp_addMass - theta(i,j,kLev,bi,bj) )
299 & *recip_rA(i,j,bi,bj)
300 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
301 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
302 ENDDO
303 ENDDO
304 ELSE
305 DO j=1,sNy
306 DO i=1,sNx
307 gT(i,j,kLev,bi,bj) = gT(i,j,kLev,bi,bj)
308 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
309 & *( temp_addMass - tRef(kLev) )
310 & *recip_rA(i,j,bi,bj)
311 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
312 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
313 ENDDO
314 ENDDO
315 ENDIF
316 ENDIF
317 #endif /* ALLOW_ADDFLUID */
318
319 C Add heat in top-layer
320 IF ( kLev .EQ. kSurface ) THEN
321 DO j=1,sNy
322 DO i=1,sNx
323 gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
324 & +surfaceForcingT(i,j,bi,bj)
325 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
326 ENDDO
327 ENDDO
328 ENDIF
329
330 IF (linFSConserveTr) THEN
331 DO j=1,sNy
332 DO i=1,sNx
333 IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
334 gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
335 & +TsurfCor*recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
336 ENDIF
337 ENDDO
338 ENDDO
339 ENDIF
340
341 #ifdef ALLOW_SHELFICE
342 IF ( useShelfIce )
343 & CALL SHELFICE_FORCING_T(
344 I iMin,iMax, jMin,jMax, bi,bj, kLev,
345 I myTime, myThid )
346 #endif /* ALLOW_SHELFICE */
347
348 #ifdef ALLOW_ICEFRONT
349 IF ( useICEFRONT )
350 & CALL ICEFRONT_TENDENCY_APPLY_T(
351 & bi,bj, kLev, myTime, myThid )
352 #endif /* ALLOW_ICEFRONT */
353
354 #ifdef SHORTWAVE_HEATING
355 C Penetrating SW radiation
356 c IF ( usePenetratingSW ) THEN
357 swfracb(1)=abs(rF(klev))
358 swfracb(2)=abs(rF(klev+1))
359 CALL SWFRAC(
360 I two, minusone,
361 U swfracb,
362 I myTime, 1, myThid )
363 kp1 = klev+1
364 IF (klev.EQ.Nr) THEN
365 kp1 = klev
366 swfracb(2)=0. _d 0
367 ENDIF
368 DO j=1,sNy
369 DO i=1,sNx
370 gT(i,j,klev,bi,bj) = gT(i,j,klev,bi,bj)
371 & -Qsw(i,j,bi,bj)*(swfracb(1)*maskC(i,j,klev,bi,bj)
372 & -swfracb(2)*maskC(i,j,kp1, bi,bj))
373 & *recip_Cp*mass2rUnit
374 & *recip_drF(klev)*_recip_hFacC(i,j,kLev,bi,bj)
375 ENDDO
376 ENDDO
377 c ENDIF
378 #endif
379
380 #ifdef ALLOW_RBCS
381 IF (useRBCS) THEN
382 CALL RBCS_ADD_TENDENCY(bi,bj,klev, 1,
383 & myTime, myThid )
384 ENDIF
385 #endif
386
387 #ifdef ALLOW_OBCS
388 IF (useOBCS) THEN
389 CALL OBCS_SPONGE_T(
390 I iMin,iMax, jMin,jMax, bi,bj, kLev,
391 I myTime, myThid )
392 ENDIF
393 #endif
394
395 #ifdef ALLOW_MYPACKAGE
396 IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_T(
397 & iMin,iMax, jMin,jMax, bi,bj, kLev,
398 & myTime, myThid )
399 #endif /* ALLOW_MYPACKAGE */
400
401 RETURN
402 END
403
404 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
405 CBOP
406 C !ROUTINE: EXTERNAL_FORCING_S
407 C !INTERFACE:
408 SUBROUTINE EXTERNAL_FORCING_S(
409 I iMin,iMax, jMin,jMax, bi,bj, kLev,
410 I myTime, myThid )
411
412 C !DESCRIPTION: \bv
413 C *==========================================================*
414 C | S/R EXTERNAL_FORCING_S
415 C | o Contains problem specific forcing for merid velocity.
416 C *==========================================================*
417 C | Adds terms to gS for forcing by external sources
418 C | e.g. fresh-water flux, climatalogical relaxation, etc ...
419 C *==========================================================*
420 C \ev
421
422 C !USES:
423 IMPLICIT NONE
424 C == Global data ==
425 #include "SIZE.h"
426 #include "EEPARAMS.h"
427 #include "PARAMS.h"
428 #include "GRID.h"
429 #include "DYNVARS.h"
430 #include "FFIELDS.h"
431 #include "SURFACE.h"
432
433 C !INPUT/OUTPUT PARAMETERS:
434 C == Routine arguments ==
435 C iMin,iMax :: Working range of x-index for applying forcing.
436 C jMin,jMax :: Working range of y-index for applying forcing.
437 C bi,bj :: Current tile indices
438 C kLev :: Current vertical level index
439 C myTime :: Current time in simulation
440 C myThid :: Thread Id number
441 INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
442 _RL myTime
443 INTEGER myThid
444
445 C !LOCAL VARIABLES:
446 C == Local variables ==
447 C i,j :: Loop counters
448 C kSurface :: index of surface layer
449 INTEGER i, j
450 INTEGER kSurface
451 CEOP
452
453 IF ( fluidIsAir ) THEN
454 kSurface = 0
455 ELSEIF ( usingPCoords ) THEN
456 kSurface = Nr
457 ELSE
458 kSurface = 1
459 ENDIF
460
461 C-- Forcing term
462 #ifdef ALLOW_AIM
463 IF ( useAIM ) CALL AIM_TENDENCY_APPLY_S(
464 & iMin,iMax, jMin,jMax, bi,bj, kLev,
465 & myTime, myThid )
466 #endif /* ALLOW_AIM */
467
468 #ifdef ALLOW_FIZHI
469 IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_S(
470 & iMin,iMax, jMin,jMax, bi,bj, kLev,
471 & myTime, myThid )
472 #endif /* ALLOW_FIZHI */
473
474 #ifdef ALLOW_ADDFLUID
475 IF ( selectAddFluid.NE.0 .AND. salt_addMass.NE.UNSET_RL ) THEN
476 IF ( ( selectAddFluid.GE.1 .AND. nonlinFreeSurf.GT.0 )
477 & .OR. convertFW2Salt.EQ.-1. _d 0 ) THEN
478 DO j=1,sNy
479 DO i=1,sNx
480 gS(i,j,kLev,bi,bj) = gS(i,j,kLev,bi,bj)
481 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
482 & *( salt_addMass - salt(i,j,kLev,bi,bj) )
483 & *recip_rA(i,j,bi,bj)
484 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
485 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
486 ENDDO
487 ENDDO
488 ELSE
489 DO j=1,sNy
490 DO i=1,sNx
491 gS(i,j,kLev,bi,bj) = gS(i,j,kLev,bi,bj)
492 & + addMass(i,j,kLev,bi,bj)*mass2rUnit
493 & *( salt_addMass - sRef(kLev) )
494 & *recip_rA(i,j,bi,bj)
495 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
496 C & *recip_deepFac2C(kLev)*recip_rhoFacC(kLev)
497 ENDDO
498 ENDDO
499 ENDIF
500 ENDIF
501 #endif /* ALLOW_ADDFLUID */
502
503 C Add fresh-water in top-layer
504 IF ( kLev .EQ. kSurface ) THEN
505 DO j=1,sNy
506 DO i=1,sNx
507 gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
508 & +surfaceForcingS(i,j,bi,bj)
509 & *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
510 ENDDO
511 ENDDO
512 ENDIF
513
514 IF (linFSConserveTr) THEN
515 DO j=1,sNy
516 DO i=1,sNx
517 IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
518 gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
519 & +SsurfCor*recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
520 ENDIF
521 ENDDO
522 ENDDO
523 ENDIF
524
525 #ifdef ALLOW_SHELFICE
526 IF ( useShelfIce )
527 & CALL SHELFICE_FORCING_S(
528 I iMin,iMax, jMin,jMax, bi,bj, kLev,
529 I myTime, myThid )
530 #endif /* ALLOW_SHELFICE */
531
532 #ifdef ALLOW_ICEFRONT
533 IF ( useICEFRONT )
534 & CALL ICEFRONT_TENDENCY_APPLY_S(
535 & bi,bj, kLev, myTime, myThid )
536 #endif /* ALLOW_ICEFRONT */
537
538 #ifdef ALLOW_SALT_PLUME
539 IF ( useSALT_PLUME )
540 & CALL SALT_PLUME_TENDENCY_APPLY_S(
541 I iMin,iMax, jMin,jMax, bi,bj, kLev,
542 I myTime, myThid )
543 #endif /* ALLOW_SALT_PLUME */
544
545 #ifdef ALLOW_RBCS
546 IF (useRBCS) THEN
547 CALL RBCS_ADD_TENDENCY(bi,bj,klev, 2,
548 & myTime, myThid )
549 ENDIF
550 #endif /* ALLOW_RBCS */
551
552 #ifdef ALLOW_OBCS
553 IF (useOBCS) THEN
554 CALL OBCS_SPONGE_S(
555 I iMin,iMax, jMin,jMax, bi,bj, kLev,
556 I myTime, myThid )
557 ENDIF
558 #endif /* ALLOW_OBCS */
559
560 #ifdef ALLOW_MYPACKAGE
561 IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_S(
562 & iMin,iMax, jMin,jMax, bi,bj, kLev,
563 & myTime, myThid )
564 #endif /* ALLOW_MYPACKAGE */
565
566 RETURN
567 END

  ViewVC Help
Powered by ViewVC 1.1.22