source: NEMO/trunk/src/OCE/BDY/bdytra.F90 @ 13226

Last change on this file since 13226 was 13226, checked in by orioltp, 3 months ago

Merging dev_r12512_HPC-04_mcastril_Mixed_Precision_implementation into the trunk

  • Property svn:keywords set to Id
File size: 9.2 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   !!            3.5  !  2012     (S. Mocavero, I. Epicoco) Optimization of BDY communications
10   !!            4.0  !  2016     (T. Lovato) Generalize OBC structure
11   !!----------------------------------------------------------------------
12   !!   bdy_tra       : Apply open boundary conditions & damping to T and S
13   !!----------------------------------------------------------------------
14   USE oce            ! ocean dynamics and tracers variables
15   USE dom_oce        ! ocean space and time domain variables
16   USE bdy_oce        ! ocean open boundary conditions
17   USE bdylib         ! for orlanski library routines
18   !
19   USE in_out_manager ! I/O manager
20   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
21   USE lib_mpp, ONLY: ctl_stop
22   USE timing         ! Timing
23
24   IMPLICIT NONE
25   PRIVATE
26
27   ! Local structure to rearrange tracers data
28   TYPE, PUBLIC ::   ztrabdy
29      REAL(wp), POINTER, DIMENSION(:,:) ::  tra
30   END TYPE
31
32   PUBLIC   bdy_tra      ! called in tranxt.F90
33   PUBLIC   bdy_tra_dmp  ! called in step.F90
34
35   !!----------------------------------------------------------------------
36   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
37   !! $Id$
38   !! Software governed by the CeCILL license (see ./LICENSE)
39   !!----------------------------------------------------------------------
40CONTAINS
41
42   SUBROUTINE bdy_tra( kt, Kbb, pts, Kaa )
43      !!----------------------------------------------------------------------
44      !!                  ***  SUBROUTINE bdy_tra  ***
45      !!
46      !! ** Purpose : - Apply open boundary conditions for temperature and salinity
47      !!
48      !!----------------------------------------------------------------------
49      INTEGER                                  , INTENT(in)    :: kt        ! Main time step counter
50      INTEGER                                  , INTENT(in)    :: Kbb, Kaa  ! time level indices
51      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts,jpt), INTENT(inout) :: pts       ! tracer fields
52      !
53      INTEGER                        :: ib_bdy, jn, igrd, ir   ! Loop indeces
54      TYPE(ztrabdy), DIMENSION(jpts) :: zdta                   ! Temporary data structure
55      LOGICAL                        :: llrim0                 ! indicate if rim 0 is treated
56      LOGICAL, DIMENSION(4)          :: llsend1, llrecv1       ! indicate how communications are to be carried out
57      !!----------------------------------------------------------------------
58      igrd = 1 
59      llsend1(:) = .false.  ;   llrecv1(:) = .false.
60      DO ir = 1, 0, -1   ! treat rim 1 before rim 0
61         IF( ir == 0 ) THEN   ;   llrim0 = .TRUE.
62         ELSE                 ;   llrim0 = .FALSE.
63         END IF
64         DO ib_bdy=1, nb_bdy
65            !
66            zdta(1)%tra => dta_bdy(ib_bdy)%tem
67            zdta(2)%tra => dta_bdy(ib_bdy)%sal
68            !
69            DO jn = 1, jpts
70               !
71               SELECT CASE( TRIM(cn_tra(ib_bdy)) )
72               CASE('none'        )   ;   CYCLE
73               CASE('frs'         )   ! treat the whole boundary at once
74                  IF( ir == 0 ) CALL bdy_frs ( idx_bdy(ib_bdy),                pts(:,:,:,jn,Kaa), zdta(jn)%tra )
75               CASE('specified'   )   ! treat the whole rim      at once
76                  IF( ir == 0 ) CALL bdy_spe ( idx_bdy(ib_bdy),                pts(:,:,:,jn,Kaa), zdta(jn)%tra )
77               CASE('neumann'     )   ;   CALL bdy_nmn ( idx_bdy(ib_bdy), igrd         , pts(:,:,:,jn,Kaa), llrim0 )   ! tsa masked
78               CASE('orlanski'    )   ;   CALL bdy_orl ( idx_bdy(ib_bdy), pts(:,:,:,jn,Kbb), pts(:,:,:,jn,Kaa), &
79                    & zdta(jn)%tra, llrim0, ll_npo=.false. )
80               CASE('orlanski_npo')   ;   CALL bdy_orl ( idx_bdy(ib_bdy), pts(:,:,:,jn,Kbb), pts(:,:,:,jn,Kaa), &
81                    & zdta(jn)%tra, llrim0, ll_npo=.true.  )
82               CASE('runoff'      )   ;   CALL bdy_rnf ( idx_bdy(ib_bdy),                pts(:,:,:,jn,Kaa), jn, llrim0 )
83               CASE DEFAULT           ;   CALL ctl_stop( 'bdy_tra : unrecognised option for open boundaries for T and S' )
84               END SELECT
85               !
86            END DO
87         END DO
88         !
89         IF( nn_hls > 1 .AND. ir == 1 ) CYCLE   ! at least 2 halos will be corrected -> no need to correct rim 1 before rim 0
90         IF( nn_hls == 1 ) THEN   ;   llsend1(:) = .false.   ;   llrecv1(:) = .false.   ;   END IF
91         DO ib_bdy=1, nb_bdy
92            SELECT CASE( TRIM(cn_tra(ib_bdy)) )
93            CASE('neumann','runoff')
94               llsend1(:) = llsend1(:) .OR. lsend_bdyint(ib_bdy,1,:,ir)   ! possibly every direction, T points
95               llrecv1(:) = llrecv1(:) .OR. lrecv_bdyint(ib_bdy,1,:,ir)   ! possibly every direction, T points
96            CASE('orlanski', 'orlanski_npo')
97               llsend1(:) = llsend1(:) .OR. lsend_bdy(ib_bdy,1,:,ir)   ! possibly every direction, T points
98               llrecv1(:) = llrecv1(:) .OR. lrecv_bdy(ib_bdy,1,:,ir)   ! possibly every direction, T points
99            END SELECT
100         END DO
101         IF( ANY(llsend1) .OR. ANY(llrecv1) ) THEN   ! if need to send/recv in at least one direction
102            CALL lbc_lnk( 'bdytra', pts(:,:,:,jn,Kaa), 'T',  1.0_wp, kfillmode=jpfillnothing ,lsend=llsend1, lrecv=llrecv1 )
103         END IF
104         !
105      END DO   ! ir
106      !
107   END SUBROUTINE bdy_tra
108
109
110   SUBROUTINE bdy_rnf( idx, pt, jpa, llrim0 )
111      !!----------------------------------------------------------------------
112      !!                 ***  SUBROUTINE bdy_rnf  ***
113      !!                   
114      !! ** Purpose : Specialized routine to apply TRA runoff values at OBs:
115      !!                  - duplicate the neighbour value for the temperature
116      !!                  - specified to 0.1 PSU for the salinity
117      !!
118      !!----------------------------------------------------------------------
119      TYPE(OBC_INDEX),                     INTENT(in) ::   idx      ! OBC indices
120      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(inout) ::   pt       ! tracer trend
121      INTEGER,                             INTENT(in) ::   jpa      ! TRA index
122      LOGICAL,                             INTENT(in) ::   llrim0   ! indicate if rim 0 is treated
123      !
124      INTEGER  ::   ib, ii, ij, igrd   ! dummy loop indices
125      !!----------------------------------------------------------------------
126      !
127      igrd = 1                       ! Everything is at T-points here
128      IF(      jpa == jp_tem ) THEN
129         CALL bdy_nmn( idx, igrd, pt, llrim0 )
130      ELSE IF( jpa == jp_sal ) THEN
131         IF( .NOT. llrim0 )   RETURN
132         DO ib = 1, idx%nblenrim(igrd)   ! if llrim0 then treat the whole rim
133            ii = idx%nbi(ib,igrd)
134            ij = idx%nbj(ib,igrd)
135            pt(ii,ij,1:jpkm1) = 0.1 * tmask(ii,ij,1:jpkm1)
136         END DO
137      END IF
138      !
139   END SUBROUTINE bdy_rnf
140
141
142   SUBROUTINE bdy_tra_dmp( kt, Kbb, pts, Krhs )
143      !!----------------------------------------------------------------------
144      !!                 ***  SUBROUTINE bdy_tra_dmp  ***
145      !!                   
146      !! ** Purpose : Apply damping for tracers at open boundaries.
147      !!
148      !!----------------------------------------------------------------------
149      INTEGER                                  , INTENT(in)    :: kt        ! time step
150      INTEGER                                  , INTENT(in)    :: Kbb, Krhs ! time level indices
151      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts,jpt), INTENT(inout) :: pts       ! active tracers and RHS of tracer equation
152      !
153      REAL(wp) ::   zwgt           ! boundary weight
154      REAL(wp) ::   zta, zsa, ztime
155      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
156      INTEGER  ::   ii, ij         ! 2D addresses
157      INTEGER  ::   ib_bdy         ! Loop index
158      !!----------------------------------------------------------------------
159      !
160      IF( ln_timing )   CALL timing_start('bdy_tra_dmp')
161      !
162      DO ib_bdy = 1, nb_bdy
163         IF( ln_tra_dmp(ib_bdy) ) THEN
164            igrd = 1                       ! Everything is at T-points here
165            DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
166               ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
167               ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
168               zwgt = idx_bdy(ib_bdy)%nbd(ib,igrd)
169               DO ik = 1, jpkm1
170                  zta = zwgt * ( dta_bdy(ib_bdy)%tem(ib,ik) - pts(ii,ij,ik,jp_tem,Kbb) ) * tmask(ii,ij,ik)
171                  zsa = zwgt * ( dta_bdy(ib_bdy)%sal(ib,ik) - pts(ii,ij,ik,jp_sal,Kbb) ) * tmask(ii,ij,ik)
172                  pts(ii,ij,ik,jp_tem,Krhs) = pts(ii,ij,ik,jp_tem,Krhs) + zta
173                  pts(ii,ij,ik,jp_sal,Krhs) = pts(ii,ij,ik,jp_sal,Krhs) + zsa
174               END DO
175            END DO
176         ENDIF
177      END DO
178      !
179      IF( ln_timing )   CALL timing_stop('bdy_tra_dmp')
180      !
181   END SUBROUTINE bdy_tra_dmp
182 
183   !!======================================================================
184END MODULE bdytra
Note: See TracBrowser for help on using the repository browser.