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

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

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

revision 1.19 by heimbach, Thu Jun 19 15:00:45 2003 UTC revision 1.32 by jmc, Sun Jul 17 17:26:50 2005 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
 #ifdef ALLOW_OBCS  
 # include "OBCS_OPTIONS.h"  
 #endif  
6    
7  CBOP  CBOP
8  C     !ROUTINE: EXTERNAL_FORCING_U  C     !ROUTINE: EXTERNAL_FORCING_U
9  C     !INTERFACE:  C     !INTERFACE:
10        SUBROUTINE EXTERNAL_FORCING_U(        SUBROUTINE EXTERNAL_FORCING_U(
11       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
12       I           myCurrentTime,myThid)       I           myTime, myThid )
13  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
14  C     *==========================================================*  C     *==========================================================*
15  C     | S/R EXTERNAL_FORCING_U                                      C     | S/R EXTERNAL_FORCING_U
16  C     | o Contains problem specific forcing for zonal velocity.    C     | o Contains problem specific forcing for zonal velocity.
17  C     *==========================================================*  C     *==========================================================*
18  C     | Adds terms to gU for forcing by external sources            C     | Adds terms to gU for forcing by external sources
19  C     | e.g. wind stress, bottom friction etc..................    C     | e.g. wind stress, bottom friction etc ...
20  C     *==========================================================*  C     *==========================================================*
21  C     \ev  C     \ev
22    
# Line 34  C     == Global data == Line 32  C     == Global data ==
32    
33  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
34  C     == Routine arguments ==  C     == Routine arguments ==
35  C     iMin - Working range of tile for applying forcing.  C     iMin,iMax :: Working range of x-index for applying forcing.
36  C     iMax  C     jMin,jMax :: Working range of y-index for applying forcing.
37  C     jMin  C     bi,bj     :: Current tile indices
38  C     jMax  C     kLev      :: Current vertical level index
39  C     kLev  C     myTime    :: Current time in simulation
40    C     myThid    :: Thread Id number
41        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
42        _RL myCurrentTime        _RL myTime
43        INTEGER myThid        INTEGER myThid
44    
45  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
46  C     == Local variables ==  C     == Local variables ==
47  C     Loop counters  C     i,j       :: Loop counters
48        INTEGER I, J  C     kSurface  :: index of surface layer
49  C     number of surface interface layer        INTEGER i, j
50        INTEGER kSurface        INTEGER kSurface
51  CEOP  CEOP
52    
53        if ( buoyancyRelation .eq. 'OCEANICP' ) then        IF ( fluidIsAir ) THEN
54           kSurface = 0
55          ELSEIF ( usingPCoords ) THEN
56         kSurface = Nr         kSurface = Nr
57        else        ELSE
58         kSurface = 1         kSurface = 1
59        endif        ENDIF
60    
61  C--   Forcing term  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  C     Add windstress momentum impulse into the top-layer
75        IF ( kLev .EQ. kSurface ) THEN        IF ( kLev .EQ. kSurface ) THEN
76         DO j=jMin,jMax  c      DO j=1,sNy
77          DO i=iMin,iMax  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)           gU(i,j,kLev,bi,bj) = gU(i,j,kLev,bi,bj)
81       &   +foFacMom*surfaceTendencyU(i,j,bi,bj)       &   +foFacMom*surfaceForcingU(i,j,bi,bj)
82       &   *_maskW(i,j,kLev,bi,bj)       &   *recip_drF(kLev)*recip_hFacW(i,j,kLev,bi,bj)
83          ENDDO          ENDDO
84         ENDDO         ENDDO
85        ENDIF        ENDIF
86    
87  #if (defined (ALLOW_OBCS) && defined (ALLOW_OBCS_SPONGE))  #if (defined (ALLOW_TAU_EDDY))
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        IF (useOBCS) THEN
95         CALL OBCS_SPONGE_U(         CALL OBCS_SPONGE_U(
96       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
97       I           myCurrentTime,myThid)       I           myTime, myThid )
98        ENDIF        ENDIF
99  #endif  #endif
100    
101        RETURN        RETURN
102        END        END
103    
104    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
105  CBOP  CBOP
106  C     !ROUTINE: EXTERNAL_FORCING_V  C     !ROUTINE: EXTERNAL_FORCING_V
107  C     !INTERFACE:  C     !INTERFACE:
108        SUBROUTINE EXTERNAL_FORCING_V(        SUBROUTINE EXTERNAL_FORCING_V(
109       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
110       I           myCurrentTime,myThid)       I           myTime, myThid )
111  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
112  C     *==========================================================*  C     *==========================================================*
113  C     | S/R EXTERNAL_FORCING_V                                      C     | S/R EXTERNAL_FORCING_V
114  C     | o Contains problem specific forcing for merid velocity.    C     | o Contains problem specific forcing for merid velocity.
115  C     *==========================================================*  C     *==========================================================*
116  C     | Adds terms to gV for forcing by external sources            C     | Adds terms to gV for forcing by external sources
117  C     | e.g. wind stress, bottom friction etc..................    C     | e.g. wind stress, bottom friction etc ...
118  C     *==========================================================*  C     *==========================================================*
119  C     \ev  C     \ev
120    
# Line 107  C     == Global data == Line 130  C     == Global data ==
130    
131  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
132  C     == Routine arguments ==  C     == Routine arguments ==
133  C     iMin - Working range of tile for applying forcing.  C     iMin,iMax :: Working range of x-index for applying forcing.
134  C     iMax  C     jMin,jMax :: Working range of y-index for applying forcing.
135  C     jMin  C     bi,bj     :: Current tile indices
136  C     jMax  C     kLev      :: Current vertical level index
137  C     kLev  C     myTime    :: Current time in simulation
138    C     myThid    :: Thread Id number
139        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
140        _RL myCurrentTime        _RL myTime
141        INTEGER myThid        INTEGER myThid
142    
143  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
144  C     == Local variables ==  C     == Local variables ==
145  C     Loop counters  C     i,j       :: Loop counters
146        INTEGER I, J  C     kSurface  :: index of surface layer
147  C     number of surface interface layer        INTEGER i, j
148        INTEGER kSurface        INTEGER kSurface
149  CEOP  CEOP
150    
151        if ( buoyancyRelation .eq. 'OCEANICP' ) then        IF ( fluidIsAir ) THEN
152           kSurface = 0
153          ELSEIF ( usingPCoords ) THEN
154         kSurface = Nr         kSurface = Nr
155        else        ELSE
156         kSurface = 1         kSurface = 1
157        endif        ENDIF
158    
159  C--   Forcing term  C--   Forcing term
160    #ifdef ALLOW_AIM
161          IF ( useAIM ) CALL AIM_TENDENCY_APPLY_V(
162         &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
163         &                      myTime, myThid )
164    #endif /* ALLOW_AIM */
165    
166    #ifdef ALLOW_FIZHI
167          IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_V(
168         &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
169         &                      myTime, myThid )
170    #endif /* ALLOW_FIZHI */
171    
172  C     Add windstress momentum impulse into the top-layer  C     Add windstress momentum impulse into the top-layer
173        IF ( kLev .EQ. kSurface ) THEN        IF ( kLev .EQ. kSurface ) THEN
174         DO j=jMin,jMax         DO j=1,sNy+1
175          DO i=iMin,iMax  c       DO i=1,sNx
176    C-jmc: Without CD-scheme, this is OK ; but with CD-scheme, needs to cover [0:sNx+1]
177            DO i=0,sNx+1
178           gV(i,j,kLev,bi,bj) = gV(i,j,kLev,bi,bj)           gV(i,j,kLev,bi,bj) = gV(i,j,kLev,bi,bj)
179       &   +foFacMom*surfaceTendencyV(i,j,bi,bj)       &   +foFacMom*surfaceForcingV(i,j,bi,bj)
180       &   *_maskS(i,j,kLev,bi,bj)       &   *recip_drF(kLev)*recip_hFacS(i,j,kLev,bi,bj)
181          ENDDO          ENDDO
182         ENDDO         ENDDO
183        ENDIF        ENDIF
184    
185  #if (defined (ALLOW_OBCS) && defined (ALLOW_OBCS_SPONGE))  #if (defined (ALLOW_TAU_EDDY))
186           CALL TAUEDDY_EXTERNAL_FORCING_V(
187         I           iMin,iMax, jMin,jMax, bi,bj, kLev,
188         I           myTime, myThid )
189    #endif
190    
191    #ifdef ALLOW_OBCS
192        IF (useOBCS) THEN        IF (useOBCS) THEN
193         CALL OBCS_SPONGE_V(         CALL OBCS_SPONGE_V(
194       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
195       I           myCurrentTime,myThid)       I           myTime, myThid )
196        ENDIF        ENDIF
197  #endif  #endif
198    
199        RETURN        RETURN
200        END        END
201    
202    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
203  CBOP  CBOP
204  C     !ROUTINE: EXTERNAL_FORCING_T  C     !ROUTINE: EXTERNAL_FORCING_T
205  C     !INTERFACE:  C     !INTERFACE:
206        SUBROUTINE EXTERNAL_FORCING_T(        SUBROUTINE EXTERNAL_FORCING_T(
207       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
208       I           myCurrentTime,myThid)       I           myTime, myThid )
209  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
210  C     *==========================================================*  C     *==========================================================*
211  C     | S/R EXTERNAL_FORCING_T                                      C     | S/R EXTERNAL_FORCING_T
212  C     | o Contains problem specific forcing for temperature.        C     | o Contains problem specific forcing for temperature.
213  C     *==========================================================*  C     *==========================================================*
214  C     | Adds terms to gT for forcing by external sources            C     | Adds terms to gT for forcing by external sources
215  C     | e.g. heat flux, climatalogical relaxation..............    C     | e.g. heat flux, climatalogical relaxation, etc ...
216  C     *==========================================================*  C     *==========================================================*
217  C     \ev  C     \ev
218    
# Line 177  C     == Global data == Line 225  C     == Global data ==
225  #include "GRID.h"  #include "GRID.h"
226  #include "DYNVARS.h"  #include "DYNVARS.h"
227  #include "FFIELDS.h"  #include "FFIELDS.h"
 #ifdef SHORTWAVE_HEATING  
       integer two  
       _RL minusone  
       parameter (two=2,minusone=-1.)  
       _RL swfracb(two)  
 #endif  
228    
229  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
230  C     == Routine arguments ==  C     == Routine arguments ==
231  C     iMin - Working range of tile for applying forcing.  C     iMin,iMax :: Working range of x-index for applying forcing.
232  C     iMax  C     jMin,jMax :: Working range of y-index for applying forcing.
233  C     jMin  C     bi,bj     :: Current tile indices
234  C     jMax  C     kLev      :: Current vertical level index
235  C     kLev  C     myTime    :: Current time in simulation
236    C     myThid    :: Thread Id number
237        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
238        _RL myCurrentTime        _RL myTime
239        INTEGER myThid        INTEGER myThid
 CEndOfInterface  
240    
241  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
242  C     == Local variables ==  C     == Local variables ==
243  C     Loop counters  C     i,j       :: Loop counters
244        INTEGER I, J  C     kSurface  :: index of surface layer
245  C     number of surface interface layer        INTEGER i, j
246        INTEGER kSurface        INTEGER kSurface
247  CEOP  CEOP
248    #ifdef SHORTWAVE_HEATING
249          integer two
250          _RL minusone
251          parameter (two=2,minusone=-1.)
252          _RL swfracb(two)
253          INTEGER kp1
254    #endif
255    
256        if ( buoyancyRelation .eq. 'OCEANICP' ) then        IF ( fluidIsAir ) THEN
257           kSurface = 0
258          ELSEIF ( usingPCoords ) THEN
259         kSurface = Nr         kSurface = Nr
260        else        ELSE
261         kSurface = 1         kSurface = 1
262        endif        ENDIF
263    
264  C--   Forcing term  C--   Forcing term
265    #ifdef ALLOW_AIM
266          IF ( useAIM ) CALL AIM_TENDENCY_APPLY_T(
267         &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
268         &                      myTime, myThid )
269    #endif /* ALLOW_AIM */
270    
271    #ifdef ALLOW_FIZHI
272          IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_T(
273         &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
274         &                      myTime, myThid )
275    #endif /* ALLOW_FIZHI */
276    
277  C     Add heat in top-layer  C     Add heat in top-layer
278        IF ( kLev .EQ. kSurface ) THEN        IF ( kLev .EQ. kSurface ) THEN
279         DO j=jMin,jMax         DO j=1,sNy
280          DO i=iMin,iMax          DO i=1,sNx
281           gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)           gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
282       &     +maskC(i,j,kLev,bi,bj)*surfaceTendencyT(i,j,bi,bj)       &     +surfaceForcingT(i,j,bi,bj)
283         &     *recip_drF(kLev)*recip_hFacC(i,j,kLev,bi,bj)
284          ENDDO          ENDDO
285         ENDDO         ENDDO
286        ENDIF        ENDIF
287    
288  #ifdef SHORTWAVE_HEATING  #ifdef SHORTWAVE_HEATING
289  C Penetrating SW radiation  C Penetrating SW radiation
290        swfracb(1)=abs(rF(klev))  c     IF ( usePenetratingSW ) THEN
291        swfracb(2)=abs(rF(klev+1))         swfracb(1)=abs(rF(klev))
292        call SWFRAC(         swfracb(2)=abs(rF(klev+1))
293           CALL SWFRAC(
294       I     two,minusone,       I     two,minusone,
295       I     myCurrentTime,myThid,       I     myTime,myThid,
296       U     swfracb)       U     swfracb)
297        DO j=jMin,jMax         kp1 = klev+1
298         DO i=iMin,iMax         IF (klev.EQ.Nr) THEN
299          gT(i,j,klev,bi,bj) = gT(i,j,klev,bi,bj)          kp1 = klev
300       &   -maskC(i,j,klev,bi,bj)*Qsw(i,j,bi,bj)*(swfracb(1)-swfracb(2))          swfracb(2)=0. _d 0
301       &    *recip_Cp*recip_rhoConst*recip_drF(klev)         ENDIF
302           DO j=1,sNy
303            DO i=1,sNx
304             gT(i,j,klev,bi,bj) = gT(i,j,klev,bi,bj)
305         &   -Qsw(i,j,bi,bj)*(swfracb(1)*maskC(i,j,klev,bi,bj)
306         &                   -swfracb(2)*maskC(i,j,kp1, bi,bj))
307         &    *recip_Cp*recip_rhoConst
308         &    *recip_drF(klev)*recip_hFacC(i,j,kLev,bi,bj)
309            ENDDO
310         ENDDO         ENDDO
311        ENDDO  c     ENDIF
312  #endif  #endif
313    
314  #if (defined (ALLOW_OBCS) && defined (ALLOW_OBCS_SPONGE))  #ifdef ALLOW_OBCS
315        IF (useOBCS) THEN        IF (useOBCS) THEN
316         CALL OBCS_SPONGE_T(         CALL OBCS_SPONGE_T(
317       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
318       I           myCurrentTime,myThid)       I           myTime, myThid )
319        ENDIF        ENDIF
320  #endif  #endif
321    
322        RETURN        RETURN
323        END        END
324    
325    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
326  CBOP  CBOP
327  C     !ROUTINE: EXTERNAL_FORCING_S  C     !ROUTINE: EXTERNAL_FORCING_S
328  C     !INTERFACE:  C     !INTERFACE:
329        SUBROUTINE EXTERNAL_FORCING_S(        SUBROUTINE EXTERNAL_FORCING_S(
330       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
331       I           myCurrentTime,myThid)       I           myTime, myThid )
332    
333  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
334  C     *==========================================================*  C     *==========================================================*
335  C     | S/R EXTERNAL_FORCING_S                                      C     | S/R EXTERNAL_FORCING_S
336  C     | o Contains problem specific forcing for merid velocity.    C     | o Contains problem specific forcing for merid velocity.
337  C     *==========================================================*  C     *==========================================================*
338  C     | Adds terms to gS for forcing by external sources            C     | Adds terms to gS for forcing by external sources
339  C     | e.g. fresh-water flux, climatalogical relaxation.......    C     | e.g. fresh-water flux, climatalogical relaxation, etc ...
340  C     *==========================================================*  C     *==========================================================*
341  C     \ev  C     \ev
342    
# Line 277  C     == Global data == Line 352  C     == Global data ==
352    
353  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
354  C     == Routine arguments ==  C     == Routine arguments ==
355  C     iMin - Working range of tile for applying forcing.  C     iMin,iMax :: Working range of x-index for applying forcing.
356  C     iMax  C     jMin,jMax :: Working range of y-index for applying forcing.
357  C     jMin  C     bi,bj     :: Current tile indices
358  C     jMax  C     kLev      :: Current vertical level index
359  C     kLev  C     myTime    :: Current time in simulation
360    C     myThid    :: Thread Id number
361        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj        INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
362        _RL myCurrentTime        _RL myTime
363        INTEGER myThid        INTEGER myThid
364    
365  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
366  C     == Local variables ==  C     == Local variables ==
367  C     Loop counters  C     i,j       :: Loop counters
368        INTEGER I, J  C     kSurface  :: index of surface layer
369  C     number of surface interface layer        INTEGER i, j
370        INTEGER kSurface        INTEGER kSurface
371  CEOP  CEOP
372    
373        if ( buoyancyRelation .eq. 'OCEANICP' ) then        IF ( fluidIsAir ) THEN
374           kSurface = 0
375          ELSEIF ( usingPCoords ) THEN
376         kSurface = Nr         kSurface = Nr
377        else        ELSE
378         kSurface = 1         kSurface = 1
379        endif        ENDIF
   
380    
381  C--   Forcing term  C--   Forcing term
382    #ifdef ALLOW_AIM
383          IF ( useAIM ) CALL AIM_TENDENCY_APPLY_S(
384         &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
385         &                      myTime, myThid )
386    #endif /* ALLOW_AIM */
387    
388    #ifdef ALLOW_FIZHI
389          IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_S(
390         &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
391         &                      myTime, myThid )
392    #endif /* ALLOW_FIZHI */
393    
394  C     Add fresh-water in top-layer  C     Add fresh-water in top-layer
395        IF ( kLev .EQ. kSurface ) THEN        IF ( kLev .EQ. kSurface ) THEN
396         DO j=jMin,jMax         DO j=1,sNy
397          DO i=iMin,iMax          DO i=1,sNx
398           gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)           gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
399       &   +maskC(i,j,kLev,bi,bj)*surfaceTendencyS(i,j,bi,bj)       &     +surfaceForcingS(i,j,bi,bj)
400         &     *recip_drF(kLev)*recip_hFacC(i,j,kLev,bi,bj)
401          ENDDO          ENDDO
402         ENDDO         ENDDO
403        ENDIF        ENDIF
404    
405  #if (defined (ALLOW_OBCS) && defined (ALLOW_OBCS_SPONGE))  #ifdef ALLOW_OBCS
406        IF (useOBCS) THEN        IF (useOBCS) THEN
407         CALL OBCS_SPONGE_S(         CALL OBCS_SPONGE_S(
408       I           iMin, iMax, jMin, jMax,bi,bj,kLev,       I           iMin,iMax, jMin,jMax, bi,bj, kLev,
409       I           myCurrentTime,myThid)       I           myTime, myThid )
410        ENDIF        ENDIF
411  #endif  #endif
412    
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.32
  ViewVC Help
Powered by ViewVC 1.1.22