New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
trcbdy.F90 in branches/2016/dev_CMCC_2016/NEMOGCM/NEMO/TOP_SRC – NEMO

source: branches/2016/dev_CMCC_2016/NEMOGCM/NEMO/TOP_SRC/trcbdy.F90 @ 7299

Last change on this file since 7299 was 7299, checked in by lovato, 8 years ago

Merge with CMCC changes from dev_r6522_SIMPLIF_3 - ticket #1729 & #1783
File size: 6.2 KB
Line 
1MODULE trcbdy
2   !!======================================================================
3   !!                       ***  MODULE  bdytrc  ***
4   !! Ocean tracers:   Apply boundary conditions for tracers in TOP component
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   !!            3.6  !  2015     (T. Lovato) Adapt BDY for tracers in TOP component
11   !!            4.0  !  2016     (T. Lovato) Generalize OBC structure
12   !!----------------------------------------------------------------------
13#if defined key_top
14   !!----------------------------------------------------------------------
15   !!   trc_bdy       : Apply open boundary conditions & damping to tracers
16   !!----------------------------------------------------------------------
17   USE timing                       ! Timing
18   USE oce_trc                      ! ocean dynamics and tracers variables
19   USE par_trc
20   USE trc                          ! ocean space and time domain variables
21   USE bdylib                       ! for orlanski library routines
22   USE lbclnk                       ! ocean lateral boundary conditions (or mpp link)
23   USE in_out_manager               ! I/O manager
24   USE bdy_oce, only: idx_bdy       ! ocean open boundary conditions
25
26   IMPLICIT NONE
27   PRIVATE
28
29   PUBLIC trc_bdy      ! routine called in trcnxt.F90
30   PUBLIC trc_bdy_dmp  ! routine called in trcstp.F90
31
32   !!----------------------------------------------------------------------
33   !! NEMO/OPA 4.0 , NEMO Consortium (2016)
34   !! $Id$
35   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
36   !!----------------------------------------------------------------------
37CONTAINS
38
39   SUBROUTINE trc_bdy( kt )
40      !!----------------------------------------------------------------------
41      !!                  ***  SUBROUTINE trc_bdy  ***
42      !!
43      !! ** Purpose : - Apply open boundary conditions for TOP tracers
44      !!
45      !!----------------------------------------------------------------------
46      INTEGER, INTENT( in ) :: kt     ! Main time step counter
47      !!
48      INTEGER                           :: ib_bdy, jn ! Loop indeces
49      REAL(wp), POINTER, DIMENSION(:,:) ::  ztrc
50      REAL(wp), POINTER                 ::  zfac
51      !!----------------------------------------------------------------------
52      !
53      IF( nn_timing == 1 ) CALL timing_start('trc_bdy')
54      !
55      DO ib_bdy=1, nb_bdy
56         DO jn = 1, jptra
57            !
58            ztrc => trcdta_bdy(jn,ib_bdy)%trc 
59            zfac => trcdta_bdy(jn,ib_bdy)%rn_fac
60            !
61            SELECT CASE( TRIM(trcdta_bdy(jn,ib_bdy)%cn_obc) )
62            CASE('none'        )   ;   CYCLE
63            CASE('frs'         )   ;   CALL bdy_frs( idx_bdy(ib_bdy),                tra(:,:,:,jn), ztrc*zfac )
64            CASE('specified'   )   ;   CALL bdy_spe( idx_bdy(ib_bdy),                tra(:,:,:,jn), ztrc*zfac )
65            CASE('neumann'     )   ;   CALL bdy_nmn( idx_bdy(ib_bdy),                tra(:,:,:,jn) )
66            CASE('orlanski'    )   ;   CALL bdy_orl( idx_bdy(ib_bdy), trb(:,:,:,jn), tra(:,:,:,jn), ztrc*zfac, ll_npo=.false. )
67            CASE('orlanski_npo')   ;   CALL bdy_orl( idx_bdy(ib_bdy), trb(:,:,:,jn), tra(:,:,:,jn), ztrc*zfac, ll_npo=.true. )
68            CASE DEFAULT           ;   CALL ctl_stop( 'trc_bdy : unrecognised option for open boundaries for passive tracers' )
69            END SELECT
70            ! Boundary points should be updated
71            CALL lbc_bdy_lnk( tra(:,:,:,jn), 'T', 1., ib_bdy )
72            !
73         END DO
74      END DO
75      !
76      IF( nn_timing == 1 ) CALL timing_stop('trc_bdy')
77
78   END SUBROUTINE trc_bdy
79
80   SUBROUTINE trc_bdy_dmp( kt )
81      !!----------------------------------------------------------------------
82      !!                 ***  SUBROUTINE trc_bdy_dmp  ***
83      !!                   
84      !! ** Purpose : Apply damping for tracers at open boundaries.
85      !!             It currently applies the damping to all tracers!!!
86      !!
87      !!----------------------------------------------------------------------
88      INTEGER,         INTENT(in) ::   kt
89      !!
90      INTEGER  ::   jn             ! Tracer index
91      REAL(wp) ::   zwgt           ! boundary weight
92      REAL(wp) ::   zta, zsa, ztime
93      INTEGER  ::   ib, ik, igrd   ! dummy loop indices
94      INTEGER  ::   ii, ij         ! 2D addresses
95      INTEGER  ::   ib_bdy         ! Loop index
96      !!----------------------------------------------------------------------
97      !
98      IF( nn_timing == 1 ) CALL timing_start('trc_bdy_dmp')
99      !
100      DO jn = 1, jptra
101         DO ib_bdy=1, nb_bdy
102            IF ( trcdta_bdy(jn, ib_bdy)%dmp ) THEN
103               igrd = 1                       ! Everything is at T-points here
104               DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
105                  ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
106                  ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
107                  zwgt = idx_bdy(ib_bdy)%nbd(ib,igrd)
108                  DO ik = 1, jpkm1
109                     zta = zwgt * ( trcdta_bdy(jn, ib_bdy)%trc(ib,ik) - trb(ii,ij,ik,jn) ) * tmask(ii,ij,ik)
110                     tra(ii,ij,ik,jn) = tra(ii,ij,ik,jn) + zta
111                  END DO
112               END DO
113            ENDIF
114         ENDDO
115      ENDDO
116      !
117      IF( nn_timing == 1 ) CALL timing_stop('trc_bdy_dmp')
118      !
119   END SUBROUTINE trc_bdy_dmp
120 
121#else
122   !!----------------------------------------------------------------------
123   !!   Dummy module                   NO Unstruct Open Boundary Conditions
124   !!----------------------------------------------------------------------
125CONTAINS
126   SUBROUTINE trc_bdy(kt)      ! Empty routine
127      WRITE(*,*) 'trc_bdy: You should not have seen this print! error?', kt
128   END SUBROUTINE trc_bdy
129
130   SUBROUTINE trc_bdy_dmp(kt)      ! Empty routine
131      WRITE(*,*) 'trc_bdy_dmp: You should not have seen this print! error?', kt
132   END SUBROUTINE trc_bdy_dmp
133
134#endif
135
136   !!======================================================================
137END MODULE trcbdy
Note: See TracBrowser for help on using the repository browser.