source: NEMO/branches/2018/dev_r10164_HPC09_ESIWACE_PREP_MERGE/src/OCE/BDY/bdytra.F90

Last change on this file was 10314, checked in by smasson, 2 years ago

dev_r10164_HPC09_ESIWACE_PREP_MERGE: action 2: add generic glob_min/max/sum and locmin/max, complete timing and report (including bdy and icb), see #2133

  • Property svn:keywords set to Id
File size: 7.0 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 timing         ! Timing
22
23   IMPLICIT NONE
24   PRIVATE
25
26   ! Local structure to rearrange tracers data
27   TYPE, PUBLIC ::   ztrabdy
28      REAL(wp), POINTER, DIMENSION(:,:) ::  tra
29   END TYPE
30
31   PUBLIC   bdy_tra      ! called in tranxt.F90
32   PUBLIC   bdy_tra_dmp  ! called in step.F90
33
34   !!----------------------------------------------------------------------
35   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
36   !! $Id$
37   !! Software governed by the CeCILL license (see ./LICENSE)
38   !!----------------------------------------------------------------------
39CONTAINS
40
41   SUBROUTINE bdy_tra( kt )
42      !!----------------------------------------------------------------------
43      !!                  ***  SUBROUTINE bdy_tra  ***
44      !!
45      !! ** Purpose : - Apply open boundary conditions for temperature and salinity
46      !!
47      !!----------------------------------------------------------------------
48      INTEGER, INTENT(in) ::   kt   ! Main time step counter
49      !
50      INTEGER                        :: ib_bdy, jn, igrd   ! Loop indeces
51      TYPE(ztrabdy), DIMENSION(jpts) :: zdta               ! Temporary data structure
52      !!----------------------------------------------------------------------
53      igrd = 1 
54
55      DO ib_bdy=1, nb_bdy
56         !
57         zdta(1)%tra => dta_bdy(ib_bdy)%tem
58         zdta(2)%tra => dta_bdy(ib_bdy)%sal
59         !
60         DO jn = 1, jpts
61            !
62            SELECT CASE( TRIM(cn_tra(ib_bdy)) )
63            CASE('none'        )   ;   CYCLE
64            CASE('frs'         )   ;   CALL bdy_frs ( idx_bdy(ib_bdy),                tsa(:,:,:,jn), zdta(jn)%tra )
65            CASE('specified'   )   ;   CALL bdy_spe ( idx_bdy(ib_bdy),                tsa(:,:,:,jn), zdta(jn)%tra )
66            CASE('neumann'     )   ;   CALL bdy_nmn ( idx_bdy(ib_bdy), igrd         , tsa(:,:,:,jn)               )
67            CASE('orlanski'    )   ;   CALL bdy_orl ( idx_bdy(ib_bdy), tsb(:,:,:,jn), tsa(:,:,:,jn), zdta(jn)%tra, ll_npo=.false. )
68            CASE('orlanski_npo')   ;   CALL bdy_orl ( idx_bdy(ib_bdy), tsb(:,:,:,jn), tsa(:,:,:,jn), zdta(jn)%tra, ll_npo=.true. )
69            CASE('runoff'      )   ;   CALL bdy_rnf ( idx_bdy(ib_bdy),                tsa(:,:,:,jn),               jn )
70            CASE DEFAULT           ;   CALL ctl_stop( 'bdy_tra : unrecognised option for open boundaries for T and S' )
71            END SELECT
72            ! Boundary points should be updated
73            CALL lbc_bdy_lnk( 'bdytra', tsa(:,:,:,jn), 'T', 1., ib_bdy )
74            !
75         END DO
76      END DO
77      !
78   END SUBROUTINE bdy_tra
79
80
81   SUBROUTINE bdy_rnf( idx, pta, jpa )
82      !!----------------------------------------------------------------------
83      !!                 ***  SUBROUTINE bdy_rnf  ***
84      !!                   
85      !! ** Purpose : Specialized routine to apply TRA runoff values at OBs:
86      !!                  - duplicate the neighbour value for the temperature
87      !!                  - specified to 0.1 PSU for the salinity
88      !!
89      !!----------------------------------------------------------------------
90      TYPE(OBC_INDEX),                     INTENT(in) ::   idx  ! OBC indices
91      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(inout) ::   pta  ! tracer trend
92      INTEGER,                             INTENT(in) ::   jpa  ! TRA index
93      !
94      REAL(wp) ::   zwgt           ! boundary weight
95      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
96      INTEGER  ::   ii, ij, ip, jp ! 2D addresses
97      !!----------------------------------------------------------------------
98      !
99      igrd = 1                       ! Everything is at T-points here
100      DO ib = 1, idx%nblenrim(igrd)
101         ii = idx%nbi(ib,igrd)
102         ij = idx%nbj(ib,igrd)
103         DO ik = 1, jpkm1
104            ip = bdytmask(ii+1,ij  ) - bdytmask(ii-1,ij  )
105            jp = bdytmask(ii  ,ij+1) - bdytmask(ii  ,ij-1)
106            if (jpa == jp_tem) pta(ii,ij,ik) = pta(ii+ip,ij+jp,ik) * tmask(ii,ij,ik)
107            if (jpa == jp_sal) pta(ii,ij,ik) =                 0.1 * tmask(ii,ij,ik)
108         END DO
109      END DO
110      !
111   END SUBROUTINE bdy_rnf
112
113
114   SUBROUTINE bdy_tra_dmp( kt )
115      !!----------------------------------------------------------------------
116      !!                 ***  SUBROUTINE bdy_tra_dmp  ***
117      !!                   
118      !! ** Purpose : Apply damping for tracers at open boundaries.
119      !!
120      !!----------------------------------------------------------------------
121      INTEGER, INTENT(in) ::   kt   !
122      !
123      REAL(wp) ::   zwgt           ! boundary weight
124      REAL(wp) ::   zta, zsa, ztime
125      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
126      INTEGER  ::   ii, ij         ! 2D addresses
127      INTEGER  ::   ib_bdy         ! Loop index
128      !!----------------------------------------------------------------------
129      !
130      IF( ln_timing )   CALL timing_start('bdy_tra_dmp')
131      !
132      DO ib_bdy = 1, nb_bdy
133         IF( ln_tra_dmp(ib_bdy) ) THEN
134            igrd = 1                       ! Everything is at T-points here
135            DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
136               ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
137               ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
138               zwgt = idx_bdy(ib_bdy)%nbd(ib,igrd)
139               DO ik = 1, jpkm1
140                  zta = zwgt * ( dta_bdy(ib_bdy)%tem(ib,ik) - tsb(ii,ij,ik,jp_tem) ) * tmask(ii,ij,ik)
141                  zsa = zwgt * ( dta_bdy(ib_bdy)%sal(ib,ik) - tsb(ii,ij,ik,jp_sal) ) * tmask(ii,ij,ik)
142                  tsa(ii,ij,ik,jp_tem) = tsa(ii,ij,ik,jp_tem) + zta
143                  tsa(ii,ij,ik,jp_sal) = tsa(ii,ij,ik,jp_sal) + zsa
144               END DO
145            END DO
146         ENDIF
147      END DO
148      !
149      IF( ln_timing )   CALL timing_stop('bdy_tra_dmp')
150      !
151   END SUBROUTINE bdy_tra_dmp
152 
153   !!======================================================================
154END MODULE bdytra
Note: See TracBrowser for help on using the repository browser.