source: branches/2012/dev_MERCATOR_2012_rev3555/NEMOGCM/NEMO/OPA_SRC/BDY/bdytra.F90 @ 3587

Last change on this file since 3587 was 3587, checked in by cbricaud, 8 years ago

add miising dummy subroutines

  • Property svn:keywords set to Id
File size: 12.7 KB
Line 
1MODULE bdytra
2   !!======================================================================
3   !!                       ***  MODULE  bdytra  ***
4   !! Ocean tracers:   Apply boundary conditions for tracers
5   !!======================================================================
6   !! History :  1.0  !  2005-01  (J. Chanut, A. Sellar)  Original code
7   !!            3.0  !  2008-04  (NEMO team)  add in the reference version
8   !!            3.4  !  2011     (D. Storkey) rewrite in preparation for OBC-BDY merge
9   !!----------------------------------------------------------------------
10#if defined key_bdy
11   !!----------------------------------------------------------------------
12   !!   'key_bdy'                     Unstructured Open Boundary Conditions
13   !!----------------------------------------------------------------------
14   !!   bdy_tra            : Apply open boundary conditions to T and S
15   !!   bdy_tra_frs        : Apply Flow Relaxation Scheme
16   !!----------------------------------------------------------------------
17   USE timing          ! Timing
18   USE oce             ! ocean dynamics and tracers variables
19   USE dom_oce         ! ocean space and time domain variables
20   USE bdy_oce         ! ocean open boundary conditions
21   USE bdydta, ONLY:   bf
22   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
23   USE in_out_manager  ! I/O manager
24
25
26   IMPLICIT NONE
27   PRIVATE
28
29   PUBLIC bdy_tra      ! routine called in tranxt.F90
30   PUBLIC bdy_tra_dmp  ! routine called in step.F90
31
32   !!----------------------------------------------------------------------
33   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
34   !! $Id$
35   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
36   !!----------------------------------------------------------------------
37CONTAINS
38
39   SUBROUTINE bdy_tra( kt )
40      !!----------------------------------------------------------------------
41      !!                  ***  SUBROUTINE bdy_tra  ***
42      !!
43      !! ** Purpose : - Apply open boundary conditions for temperature and salinity
44      !!
45      !!----------------------------------------------------------------------
46      INTEGER, INTENT( in ) :: kt     ! Main time step counter
47      !!
48      INTEGER               :: ib_bdy ! Loop index
49
50      DO ib_bdy=1, nb_bdy
51
52         SELECT CASE( nn_tra(ib_bdy) )
53         CASE(jp_none)
54            CYCLE
55         CASE(jp_frs)
56            CALL bdy_tra_frs( idx_bdy(ib_bdy), dta_bdy(ib_bdy), kt )
57         CASE(2)
58            CALL bdy_tra_spe( idx_bdy(ib_bdy), dta_bdy(ib_bdy), kt )
59         CASE(3)
60            CALL bdy_tra_nmn( idx_bdy(ib_bdy), dta_bdy(ib_bdy), kt )
61         CASE(4)
62            CALL bdy_tra_rnf( idx_bdy(ib_bdy), dta_bdy(ib_bdy), kt )
63         CASE DEFAULT
64            CALL ctl_stop( 'bdy_tra : unrecognised option for open boundaries for T and S' )
65         END SELECT
66      ENDDO
67      !
68      ! Boundary points should be updated
69      IF (nb_bdy>0) CALL lbc_lnk( tsa(:,:,:,jp_tem), 'T', 1. )
70      IF (nb_bdy>0) CALL lbc_lnk( tsa(:,:,:,jp_sal), 'T', 1. )
71
72   END SUBROUTINE bdy_tra
73
74   SUBROUTINE bdy_tra_frs( idx, dta, kt )
75      !!----------------------------------------------------------------------
76      !!                 ***  SUBROUTINE bdy_tra_frs  ***
77      !!                   
78      !! ** Purpose : Apply the Flow Relaxation Scheme for tracers at open boundaries.
79      !!
80      !! Reference : Engedahl H., 1995, Tellus, 365-382.
81      !!----------------------------------------------------------------------
82      INTEGER,         INTENT(in) ::   kt
83      TYPE(OBC_INDEX), INTENT(in) ::   idx  ! OBC indices
84      TYPE(OBC_DATA),  INTENT(in) ::   dta  ! OBC external data
85      !!
86      REAL(wp) ::   zwgt           ! boundary weight
87      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
88      INTEGER  ::   ii, ij         ! 2D addresses
89      !!----------------------------------------------------------------------
90      !
91      IF( nn_timing == 1 ) CALL timing_start('bdy_tra_frs')
92      !
93      igrd = 1                       ! Everything is at T-points here
94      DO ib = 1, idx%nblen(igrd)
95         DO ik = 1, jpkm1
96            ii = idx%nbi(ib,igrd)
97            ij = idx%nbj(ib,igrd)
98            zwgt = idx%nbw(ib,igrd)
99            tsa(ii,ij,ik,jp_tem) = ( tsa(ii,ij,ik,jp_tem) + zwgt * ( dta%tem(ib,ik) - tsa(ii,ij,ik,jp_tem) ) ) * tmask(ii,ij,ik)         
100            tsa(ii,ij,ik,jp_sal) = ( tsa(ii,ij,ik,jp_sal) + zwgt * ( dta%sal(ib,ik) - tsa(ii,ij,ik,jp_sal) ) ) * tmask(ii,ij,ik)
101         END DO
102      END DO 
103      !
104      IF( kt .eq. nit000 ) CLOSE( unit = 102 )
105      !
106      IF( nn_timing == 1 ) CALL timing_stop('bdy_tra_frs')
107      !
108   END SUBROUTINE bdy_tra_frs
109 
110   SUBROUTINE bdy_tra_spe( idx, dta, kt )
111      !!----------------------------------------------------------------------
112      !!                 ***  SUBROUTINE bdy_tra_frs  ***
113      !!                   
114      !! ** Purpose : Apply a specified value for tracers at open boundaries.
115      !!
116      !!----------------------------------------------------------------------
117      INTEGER,         INTENT(in) ::   kt
118      TYPE(OBC_INDEX), INTENT(in) ::   idx  ! OBC indices
119      TYPE(OBC_DATA),  INTENT(in) ::   dta  ! OBC external data
120      !!
121      REAL(wp) ::   zwgt           ! boundary weight
122      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
123      INTEGER  ::   ii, ij         ! 2D addresses
124      !!----------------------------------------------------------------------
125      !
126      IF( nn_timing == 1 ) CALL timing_start('bdy_tra_spe')
127      !
128      igrd = 1                       ! Everything is at T-points here
129      DO ib = 1, idx%nblenrim(igrd)
130         ii = idx%nbi(ib,igrd)
131         ij = idx%nbj(ib,igrd)
132         DO ik = 1, jpkm1
133            tsa(ii,ij,ik,jp_tem) = dta%tem(ib,ik) * tmask(ii,ij,ik)
134            tsa(ii,ij,ik,jp_sal) = dta%sal(ib,ik) * tmask(ii,ij,ik)
135         END DO
136      END DO
137      !
138      IF( kt .eq. nit000 ) CLOSE( unit = 102 )
139      !
140      IF( nn_timing == 1 ) CALL timing_stop('bdy_tra_spe')
141      !
142   END SUBROUTINE bdy_tra_spe
143
144   SUBROUTINE bdy_tra_nmn( idx, dta, kt )
145      !!----------------------------------------------------------------------
146      !!                 ***  SUBROUTINE bdy_tra_nmn  ***
147      !!                   
148      !! ** Purpose : Duplicate the value for tracers at open boundaries.
149      !!
150      !!----------------------------------------------------------------------
151      INTEGER,         INTENT(in) ::   kt
152      TYPE(OBC_INDEX), INTENT(in) ::   idx  ! OBC indices
153      TYPE(OBC_DATA),  INTENT(in) ::   dta  ! OBC external data
154      !!
155      REAL(wp) ::   zwgt           ! boundary weight
156      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
157      INTEGER  ::   ii, ij,zcoef, zcoef1,zcoef2, ip, jp   ! 2D addresses
158      !!----------------------------------------------------------------------
159      !
160      IF( nn_timing == 1 ) CALL timing_start('bdy_tra_nmn')
161      !
162      igrd = 1                       ! Everything is at T-points here
163      DO ib = 1, idx%nblenrim(igrd)
164         ii = idx%nbi(ib,igrd)
165         ij = idx%nbj(ib,igrd)
166         DO ik = 1, jpkm1
167            ! search the sense of the gradient
168            zcoef1 = bdytmask(ii-1,ij  ) +  bdytmask(ii+1,ij  )
169            zcoef2 = bdytmask(ii  ,ij-1) +  bdytmask(ii  ,ij+1)
170            IF ( zcoef1+zcoef2 == 0) THEN
171               ! corner
172               zcoef = tmask(ii-1,ij,ik) + tmask(ii+1,ij,ik) +  tmask(ii,ij-1,ik) +  tmask(ii,ij+1,ik)
173               tsa(ii,ij,ik,jp_tem) = tsa(ii-1,ij  ,ik,jp_tem) * tmask(ii-1,ij  ,ik) + &
174                 &                    tsa(ii+1,ij  ,ik,jp_tem) * tmask(ii+1,ij  ,ik) + &
175                 &                    tsa(ii  ,ij-1,ik,jp_tem) * tmask(ii  ,ij-1,ik) + &
176                 &                    tsa(ii  ,ij+1,ik,jp_tem) * tmask(ii  ,ij+1,ik)
177               tsa(ii,ij,ik,jp_tem) = ( tsa(ii,ij,ik,jp_tem) / MAX( 1, zcoef) ) * tmask(ii,ij,ik)
178               tsa(ii,ij,ik,jp_sal) = tsa(ii-1,ij  ,ik,jp_sal) * tmask(ii-1,ij  ,ik) + &
179                 &                    tsa(ii+1,ij  ,ik,jp_sal) * tmask(ii+1,ij  ,ik) + &
180                 &                    tsa(ii  ,ij-1,ik,jp_sal) * tmask(ii  ,ij-1,ik) + &
181                 &                    tsa(ii  ,ij+1,ik,jp_sal) * tmask(ii  ,ij+1,ik)
182               tsa(ii,ij,ik,jp_sal) = ( tsa(ii,ij,ik,jp_sal) / MAX( 1, zcoef) ) * tmask(ii,ij,ik)
183            ELSE
184               ip = bdytmask(ii+1,ij  ) - bdytmask(ii-1,ij  )
185               jp = bdytmask(ii  ,ij+1) - bdytmask(ii  ,ij-1)
186               tsa(ii,ij,ik,jp_tem) = tsa(ii+ip,ij+jp,ik,jp_tem) * tmask(ii+ip,ij+jp,ik)
187               tsa(ii,ij,ik,jp_sal) = tsa(ii+ip,ij+jp,ik,jp_sal) * tmask(ii+ip,ij+jp,ik)
188            ENDIF
189         END DO
190      END DO
191      !
192      IF( kt .eq. nit000 ) CLOSE( unit = 102 )
193      !
194      IF( nn_timing == 1 ) CALL timing_stop('bdy_tra_nmn')
195      !
196   END SUBROUTINE bdy_tra_nmn
197
198   SUBROUTINE bdy_tra_rnf( idx, dta, kt )
199      !!----------------------------------------------------------------------
200      !!                 ***  SUBROUTINE bdy_tra_rnf  ***
201      !!                   
202      !! ** Purpose : Apply the runoff values for tracers at open boundaries:
203      !!                  - specified to 0.1 PSU for the salinity
204      !!                  - duplicate the value for the temperature
205      !!
206      !!----------------------------------------------------------------------
207      INTEGER,         INTENT(in) ::   kt
208      TYPE(OBC_INDEX), INTENT(in) ::   idx  ! OBC indices
209      TYPE(OBC_DATA),  INTENT(in) ::   dta  ! OBC external data
210      !!
211      REAL(wp) ::   zwgt           ! boundary weight
212      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
213      INTEGER  ::   ii, ij, ip, jp ! 2D addresses
214      !!----------------------------------------------------------------------
215      !
216      IF( nn_timing == 1 ) CALL timing_start('bdy_tra_rnf')
217      !
218      igrd = 1                       ! Everything is at T-points here
219      DO ib = 1, idx%nblenrim(igrd)
220         ii = idx%nbi(ib,igrd)
221         ij = idx%nbj(ib,igrd)
222         DO ik = 1, jpkm1
223            ip = bdytmask(ii+1,ij  ) - bdytmask(ii-1,ij  )
224            jp = bdytmask(ii  ,ij+1) - bdytmask(ii  ,ij-1)
225            tsa(ii,ij,ik,jp_tem) = tsa(ii+ip,ij+jp,ik,jp_tem) * tmask(ii,ij,ik)
226            tsa(ii,ij,ik,jp_sal) =                        0.1 * tmask(ii,ij,ik)
227         END DO
228      END DO
229      !
230      IF( kt .eq. nit000 ) CLOSE( unit = 102 )
231      !
232      IF( nn_timing == 1 ) CALL timing_stop('bdy_tra_rnf')
233      !
234   END SUBROUTINE bdy_tra_rnf
235
236   SUBROUTINE bdy_tra_dmp( kt )
237      !!----------------------------------------------------------------------
238      !!                 ***  SUBROUTINE bdy_tra_dmp  ***
239      !!                   
240      !! ** Purpose : Apply damping for tracers at open boundaries.
241      !!
242      !!----------------------------------------------------------------------
243      INTEGER,         INTENT(in) ::   kt
244      !!
245      REAL(wp) ::   zwgt           ! boundary weight
246      REAL(wp) ::   zta, zsa, ztime
247      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
248      INTEGER  ::   ii, ij         ! 2D addresses
249      INTEGER  ::   ib_bdy         ! Loop index
250      !!----------------------------------------------------------------------
251      !
252      IF( nn_timing == 1 ) CALL timing_start('bdy_tra_dmp')
253      !
254      DO ib_bdy=1, nb_bdy
255         IF ( ln_tra_dmp(ib_bdy) ) THEN
256            igrd = 1                       ! Everything is at T-points here
257            DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
258               ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
259               ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
260               zwgt = idx_bdy(ib_bdy)%nbd(ib,igrd)
261               DO ik = 1, jpkm1
262                  zta = zwgt * ( dta_bdy(ib_bdy)%tem(ib,ik) - tsb(ii,ij,ik,jp_tem) ) * tmask(ii,ij,ik)
263                  zsa = zwgt * ( dta_bdy(ib_bdy)%sal(ib,ik) - tsb(ii,ij,ik,jp_sal) ) * tmask(ii,ij,ik)
264                  tsa(ii,ij,ik,jp_tem) = tsa(ii,ij,ik,jp_tem) + zta
265                  tsa(ii,ij,ik,jp_sal) = tsa(ii,ij,ik,jp_sal) + zsa
266               END DO
267            END DO
268         ENDIF
269      ENDDO
270      !
271      IF( nn_timing == 1 ) CALL timing_stop('bdy_tra_dmp')
272      !
273   END SUBROUTINE bdy_tra_dmp
274 
275#else
276   !!----------------------------------------------------------------------
277   !!   Dummy module                   NO Unstruct Open Boundary Conditions
278   !!----------------------------------------------------------------------
279CONTAINS
280   SUBROUTINE bdy_tra(kt)      ! Empty routine
281      WRITE(*,*) 'bdy_tra: You should not have seen this print! error?', kt
282   END SUBROUTINE bdy_tra
283
284   SUBROUTINE bdy_tra_dmp(kt)      ! Empty routine
285      WRITE(*,*) 'bdy_tra_dmp: You should not have seen this print! error?', kt
286   END SUBROUTINE bdy_tra_dmp
287
288#endif
289
290   !!======================================================================
291END MODULE bdytra
Note: See TracBrowser for help on using the repository browser.