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.
agrif_top_update.F90 in NEMO/trunk/src/NST – NEMO

source: NEMO/trunk/src/NST/agrif_top_update.F90

Last change on this file was 15265, checked in by jchanut, 3 years ago

Improve ghost cell initialization with AGRIF + minor changes such as missing _wp, tests namelists updates, etc... can be assigned to #2638

  • Property svn:keywords set to Id
File size: 8.2 KB
Line 
1#undef DECAL_FEEDBACK
2
3MODULE agrif_top_update
4   !!======================================================================
5   !!                ***  MODULE agrif_top_update  ***
6   !! AGRIF :   update package for passive tracers (TOP)
7   !!======================================================================
8   !! History : 
9   !!----------------------------------------------------------------------
10#if defined key_agrif && defined key_top
11   !!----------------------------------------------------------------------
12   !!   'key_agrif'                                              AGRIF zoom
13   !!   'key_TOP'                                           on-line tracers
14   !!----------------------------------------------------------------------
15   USE par_oce
16   USE oce
17   USE dom_oce
18   USE agrif_oce
19   USE par_trc
20   USE trc
21   USE vremap
22
23   IMPLICIT NONE
24   PRIVATE
25
26   PUBLIC Agrif_Update_Trc
27
28   !! * Substitutions
29#  include "domzgr_substitute.h90"
30   !!----------------------------------------------------------------------
31   !! NEMO/NST 4.0 , NEMO Consortium (2018)
32   !! $Id$
33   !! Software governed by the CeCILL license (see ./LICENSE)
34   !!----------------------------------------------------------------------
35CONTAINS
36
37   SUBROUTINE Agrif_Update_Trc( )
38      !!----------------------------------------------------------------------
39      !!                   *** ROUTINE Agrif_Update_Trc ***
40      !!----------------------------------------------------------------------
41      !
42      IF (Agrif_Root()) RETURN 
43      !
44      l_vremap                      = ln_vert_remap
45      Agrif_UseSpecialValueInUpdate = .NOT.l_vremap
46      Agrif_SpecialValueFineGrid    = 0._wp
47
48      !
49# if ! defined DECAL_FEEDBACK
50      CALL Agrif_Update_Variable(trn_id, procname=updateTRC )
51!      CALL Agrif_Update_Variable( trn_id, locupdate=(/0,2/), procname=updateTRC )
52# else
53      CALL Agrif_Update_Variable(trn_id, locupdate=(/1,0/),procname=updateTRC )
54!      CALL Agrif_Update_Variable( trn_id, locupdate=(/1,2/), procname=updateTRC )
55# endif
56      !
57      Agrif_UseSpecialValueInUpdate = .FALSE.
58      l_vremap                      = .FALSE.
59      !
60   END SUBROUTINE Agrif_Update_Trc
61
62   SUBROUTINE updateTRC( tabres, i1, i2, j1, j2, k1, k2, n1, n2, before )
63
64      INTEGER, INTENT(in) :: i1,i2,j1,j2,k1,k2,n1,n2
65      REAL(wp),DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) :: tabres
66      LOGICAL, INTENT(in) :: before
67      !!
68      INTEGER :: ji,jj,jk,jn
69      REAL(wp) :: ztb, ztnu, ztno
70      REAL(wp) :: h_in(k1:k2)
71      REAL(wp) :: h_out(1:jpk)
72      INTEGER  :: N_in, N_out
73      REAL(wp) :: h_diff
74      REAL(wp) :: tabin(k1:k2,1:jptra)
75      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk,1:jptra) :: tabres_child
76
77      IF (before) THEN
78         IF ( l_vremap ) THEN
79            DO jn = n1,n2-1
80               DO jk=k1,k2
81                  DO jj=j1,j2
82                     DO ji=i1,i2
83                        tabres(ji,jj,jk,jn) = tr(ji,jj,jk,jn,Kmm_a) * e3t(ji,jj,jk,Kmm_a)
84                     END DO
85                  END DO
86               END DO
87            END DO
88            DO jk=k1,k2
89               DO jj=j1,j2
90                  DO ji=i1,i2
91                     tabres(ji,jj,jk,n2) = tmask(ji,jj,jk) * e3t(ji,jj,jk,Kmm_a)
92                  END DO
93               END DO
94            END DO
95         ELSE
96            DO jn = 1,jptra
97               DO jk=k1,k2
98                  DO jj=j1,j2
99                     DO ji=i1,i2
100                        tabres(ji,jj,jk,jn) = tr(ji,jj,jk,jn,Kmm_a)  * e3t(ji,jj,jk,Kmm_a) / e3t_0(ji,jj,jk)
101                     END DO
102                  END DO
103               END DO
104            END DO
105
106         ENDIF
107      ELSE
108         IF ( l_vremap ) THEN
109            tabres_child(:,:,:,:) = 0._wp
110            AGRIF_SpecialValue = 0._wp
111            DO jj=j1,j2
112               DO ji=i1,i2
113                  N_in = 0
114                  DO jk=k1,k2 !k2 = jpk of child grid
115                     IF (tabres(ji,jj,jk,n2) <= 1.e-6_wp  ) EXIT
116                     N_in = N_in + 1
117                     tabin(jk,:) = tabres(ji,jj,jk,n1:n2-1)/tabres(ji,jj,jk,n2)
118                     h_in(N_in) = tabres(ji,jj,jk,n2)
119                  ENDDO
120                  N_out = 0
121                  DO jk=1,jpk ! jpk of parent grid
122                     IF (tmask(ji,jj,jk) == 0._wp ) EXIT ! TODO: Will not work with ISF
123                     N_out = N_out + 1
124                     h_out(N_out) = e3t(ji,jj,jk,Kmm_a)
125                  ENDDO
126                  IF (N_in*N_out > 0) THEN !Remove this?
127                     CALL reconstructandremap(tabin(1:N_in,1:jptra),h_in(1:N_in),tabres_child(ji,jj,1:N_out,1:jptra),h_out(1:N_out),N_in,N_out,jptra)
128                  ENDIF
129               ENDDO
130            ENDDO
131
132            IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN
133               ! Add asselin part
134               DO jn = 1,jptra
135                  DO jk = 1, jpkm1
136                     DO jj = j1, j2
137                        DO ji = i1, i2
138                           IF( tabres_child(ji,jj,jk,jn) /= 0._wp ) THEN
139                              ztb  = tr(ji,jj,jk,jn,Kbb_a) * e3t(ji,jj,jk,Kbb_a) ! fse3t_b prior update should be used
140                              ztnu = tabres_child(ji,jj,jk,jn) * e3t(ji,jj,jk,Kmm_a)
141                              ztno = tr(ji,jj,jk,jn,Kmm_a) * e3t(ji,jj,jk,Krhs_a)
142                              tr(ji,jj,jk,jn,Kbb_a) = ( ztb + rn_atfp * ( ztnu - ztno) )  &
143                                        &        * tmask(ji,jj,jk) / e3t(ji,jj,jk,Kbb_a)
144                           ENDIF
145                        END DO
146                     END DO
147                  END DO
148               END DO
149            ENDIF
150            DO jn = 1,jptra
151               DO jk = 1, jpkm1
152                  DO jj = j1, j2
153                     DO ji = i1, i2
154                        IF( tabres_child(ji,jj,jk,jn) /= 0._wp ) THEN
155                           tr(ji,jj,jk,jn,Kmm_a) = tabres_child(ji,jj,jk,jn)
156                        END IF
157                     END DO
158                  END DO
159               END DO
160            END DO
161         ELSE
162            DO jn = 1,jptra
163               tabres(i1:i2,j1:j2,k1:k2,jn) =  tabres(i1:i2,j1:j2,k1:k2,jn) * e3t_0(i1:i2,j1:j2,k1:k2) &
164                                            & * tmask(i1:i2,j1:j2,k1:k2)
165            ENDDO
166            IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN
167               ! Add asselin part
168               DO jn = 1,jptra
169                  DO jk = k1, k2
170                     DO jj = j1, j2
171                        DO ji = i1, i2
172                           IF( tabres(ji,jj,jk,jn) /= 0._wp ) THEN
173                              ztb  = tr(ji,jj,jk,jn,Kbb_a) * e3t(ji,jj,jk,Kbb_a) ! fse3t_b prior update should be used
174                              ztnu = tabres(ji,jj,jk,jn)
175                              ztno = tr(ji,jj,jk,jn,Kmm_a) * e3t(ji,jj,jk,Krhs_a)
176                              tr(ji,jj,jk,jn,Kbb_a) = ( ztb + rn_atfp * ( ztnu - ztno) )  &
177                                        &        * tmask(ji,jj,jk) / e3t(ji,jj,jk,Kbb_a)
178                           ENDIF
179                        END DO
180                     END DO
181                  END DO
182               END DO
183            ENDIF
184            DO jn = 1,jptra
185               DO jk=k1,k2
186                  DO jj=j1,j2
187                     DO ji=i1,i2
188                        IF( tabres(ji,jj,jk,jn) /= 0._wp ) THEN
189                           tr(ji,jj,jk,jn,Kmm_a) = tabres(ji,jj,jk,jn) / e3t(ji,jj,jk,Kmm_a)
190                        END IF
191                     END DO
192                  END DO
193               END DO
194            END DO
195            !
196         ENDIF
197         IF  ((l_1st_euler).AND.(Agrif_Nb_Step()==0) ) THEN
198            tr(i1:i2,j1:j2,1:jpkm1,1:jptra,Kbb_a)  = tr(i1:i2,j1:j2,1:jpkm1,1:jptra,Kmm_a)
199         ENDIF
200      ENDIF
201      !
202   END SUBROUTINE updateTRC
203
204#else
205   !!----------------------------------------------------------------------
206   !!   Empty module                                           no TOP AGRIF
207   !!----------------------------------------------------------------------
208CONTAINS
209   SUBROUTINE agrif_top_update_empty
210      WRITE(*,*)  'agrif_top_update : You should not have seen this print! error?'
211   END SUBROUTINE agrif_top_update_empty
212#endif
213
214   !!======================================================================
215END MODULE agrif_top_update
Note: See TracBrowser for help on using the repository browser.