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

source: NEMO/trunk/src/NST/agrif_top_interp.F90 @ 14130

Last change on this file since 14130 was 14086, checked in by cetlod, 3 years ago

Adding AGRIF branches into the trunk
  • Property svn:keywords set to Id
File size: 8.6 KB
Line 
1MODULE agrif_top_interp
2   !!======================================================================
3   !!                   ***  MODULE  agrif_top_interp  ***
4   !! AGRIF: interpolation package for TOP
5   !!======================================================================
6   !! History :  2.0  !  ???
7   !!----------------------------------------------------------------------
8#if defined key_agrif && defined key_top
9   !!----------------------------------------------------------------------
10   !!   'key_agrif'                                              AGRIF zoom
11   !!   'key_top'                                           on-line tracers
12   !!----------------------------------------------------------------------
13   USE par_oce
14   USE oce
15   USE dom_oce     
16   USE agrif_oce
17   USE agrif_top_sponge
18   USE par_trc
19   USE trc
20   USE vremap
21   !
22   USE lib_mpp     ! MPP library
23
24   IMPLICIT NONE
25   PRIVATE
26
27   PUBLIC Agrif_trc, interptrn
28
29  !!----------------------------------------------------------------------
30   !! NEMO/NST 4.0 , NEMO Consortium (2018)
31   !! $Id$
32   !! Software governed by the CeCILL license (see ./LICENSE)
33   !!----------------------------------------------------------------------
34CONTAINS
35
36   SUBROUTINE Agrif_trc
37      !!----------------------------------------------------------------------
38      !!                   ***  ROUTINE Agrif_trc  ***
39      !!----------------------------------------------------------------------
40      !
41      IF( Agrif_Root() )   RETURN
42      !
43      Agrif_SpecialValue    = 0._wp
44      Agrif_UseSpecialValue = .TRUE.
45      l_vremap              = ln_vert_remap
46      !
47      CALL Agrif_Bc_variable( trn_id, procname=interptrn )
48      !
49      Agrif_UseSpecialValue = .FALSE.
50      l_vremap              = .FALSE.
51      !
52   END SUBROUTINE Agrif_trc
53
54   SUBROUTINE interptrn( ptab, i1, i2, j1, j2, k1, k2, n1, n2, before )
55      !!----------------------------------------------------------------------
56      !!                  *** ROUTINE interptrn ***
57      !!----------------------------------------------------------------------
58      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) ::   ptab
59      INTEGER                                     , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2, n1, n2
60      LOGICAL                                     , INTENT(in   ) ::   before
61      !
62      INTEGER  ::   ji, jj, jk, jn  ! dummy loop indices
63      INTEGER  ::   N_in, N_out
64      INTEGER  :: item
65      ! vertical interpolation:
66      REAL(wp) :: zhtot, zwgt
67      REAL(wp), DIMENSION(k1:k2,1:jptra) :: tabin, tabin_i
68      REAL(wp), DIMENSION(k1:k2) :: z_in, h_in_i, z_in_i
69      REAL(wp), DIMENSION(1:jpk) :: h_out, z_out
70      !!----------------------------------------------------------------------
71
72      IF( before ) THEN
73
74         item = Kmm_a
75         IF( l_ini_child )   Kmm_a = Kbb_a 
76
77         DO jn = 1,jptra
78            DO jk=k1,k2
79               DO jj=j1,j2
80                 DO ji=i1,i2
81                       ptab(ji,jj,jk,jn) = tr(ji,jj,jk,jn,Kmm_a)
82                 END DO
83              END DO
84           END DO
85         END DO
86
87         IF( l_vremap .OR. l_ini_child .OR. ln_zps ) THEN
88            ! Fill cell depths (i.e. gdept) to be interpolated
89            ! Warning: these are masked, hence extrapolated prior interpolation.
90            DO jj=j1,j2
91               DO ji=i1,i2
92                  ptab(ji,jj,k1,jptra+1) = 0.5_wp * tmask(ji,jj,k1) * e3t(ji,jj,k1,Kmm_a)
93                  DO jk=k1+1,k2
94                     ptab(ji,jj,jk,jptra+1) = tmask(ji,jj,jk) * &
95                        & ( ptab(ji,jj,jk-1,jptra+1) + 0.5_wp * (e3t(ji,jj,jk-1,Kmm_a)+e3t(ji,jj,jk,Kmm_a)) )
96                  END DO
97               END DO
98            END DO
99
100            ! Save ssh at last level:
101            IF (.NOT.ln_linssh) THEN
102               ptab(i1:i2,j1:j2,k2,jptra+1) = ssh(i1:i2,j1:j2,Kmm_a)*tmask(i1:i2,j1:j2,1) 
103            END IF     
104         ENDIF
105         Kmm_a = item
106
107      ELSE
108         item = Krhs_a
109         IF( l_ini_child )   Krhs_a = Kbb_a 
110
111         IF( l_vremap .OR. l_ini_child ) THEN
112            IF (ln_linssh) ptab(i1:i2,j1:j2,k2,n2) = 0._wp 
113               
114            DO jj=j1,j2
115               DO ji=i1,i2
116                  tr(ji,jj,:,:,Krhs_a) = 0. 
117                  !
118                  ! Build vertical grids:
119                  N_in = mbkt_parent(ji,jj)
120                  ! Input grid (account for partial cells if any):
121                  DO jk=1,N_in
122                     z_in(jk) = ptab(ji,jj,jk,n2) - ptab(ji,jj,k2,n2)
123                     tabin(jk,1:jptra) = ptab(ji,jj,jk,1:jptra)
124                  END DO
125                 
126                  ! Intermediate grid:
127                  IF ( l_vremap ) THEN
128                     DO jk = 1, N_in
129                        h_in_i(jk) = e3t0_parent(ji,jj,jk) * & 
130                          &       (1._wp + ptab(ji,jj,k2,n2)/(ht0_parent(ji,jj)*ssmask(ji,jj) + 1._wp - ssmask(ji,jj)))
131                     END DO
132                     z_in_i(1) = 0.5_wp * h_in_i(1)
133                     DO jk=2,N_in
134                        z_in_i(jk) = z_in_i(jk-1) + 0.5_wp * ( h_in_i(jk) + h_in_i(jk-1) )
135                     END DO
136                     z_in_i(1:N_in) = z_in_i(1:N_in)  - ptab(ji,jj,k2,n2)
137                  ENDIF
138
139                  ! Output (Child) grid:
140                  N_out = mbkt(ji,jj)
141                  DO jk=1,N_out
142                     h_out(jk) = e3t(ji,jj,jk,Krhs_a)
143                  END DO
144                  z_out(1) = 0.5_wp * h_out(1)
145                  DO jk=2,N_out
146                     z_out(jk) = z_out(jk-1) + 0.5_wp * ( h_out(jk)+h_out(jk-1) )
147                  END DO
148                  IF (.NOT.ln_linssh) z_out(1:N_out) = z_out(1:N_out)  - ssh(ji,jj,Krhs_a)               
149
150                  IF (N_in*N_out > 0) THEN
151                     IF( l_ini_child ) THEN
152                        CALL remap_linear(tabin(1:N_in,1:jptra),z_in(1:N_in),tr(ji,jj,1:N_out,1:jptra,Krhs_a),          &
153                                      &   z_out(1:N_out),N_in,N_out,jptra) 
154                     ELSE 
155                        CALL remap_linear(tabin(1:N_in,1:jptra),z_in(1:N_in),tabin_i(1:N_in,1:jptra),                     &
156                                     &   z_in_i(1:N_in),N_in,N_in,jptra)
157                        CALL reconstructandremap(tabin_i(1:N_in,1:jptra),h_in_i(1:N_in),tr(ji,jj,1:N_out,1:jptra,Krhs_a), &
158                                      &   h_out(1:N_out),N_in,N_out,jptra)   
159                     ENDIF
160                  ENDIF
161               END DO
162            END DO
163            Krhs_a = item
164 
165         ELSE
166
167            IF ( Agrif_Parent(ln_zps) ) THEN ! Account for partial cells
168                                             ! linear vertical interpolation
169               DO jj=j1,j2
170                  DO ji=i1,i2
171                     !
172                     N_in  = mbkt(ji,jj)
173                     N_out = mbkt(ji,jj)
174                     z_in(1) = ptab(ji,jj,1,n2)
175                     tabin(1,1:jptra) = ptab(ji,jj,1,1:jptra)
176                     DO jk=2, N_in
177                        z_in(jk) = ptab(ji,jj,jk,n2)
178                        tabin(jk,1:jptra) = ptab(ji,jj,jk,1:jptra)
179                     END DO
180                     IF (.NOT.ln_linssh) z_in(1:N_in) = z_in(1:N_in) - ptab(ji,jj,k2,n2)
181                     z_out(1) = 0.5_wp * e3t(ji,jj,1,Krhs_a)
182                     DO jk=2, N_out
183                        z_out(jk) = z_out(jk-1) + 0.5_wp * (e3t(ji,jj,jk-1,Krhs_a) + e3t(ji,jj,jk,Krhs_a))
184                     END DO
185                     IF (.NOT.ln_linssh) z_out(1:N_out) = z_out(1:N_out) - ssh(ji,jj,Krhs_a)
186                     CALL remap_linear(tabin(1:N_in,1:jptra),z_in(1:N_in),ptab(ji,jj,1:N_out,1:jptra), &
187                                   &   z_out(1:N_out),N_in,N_out,jptra) 
188                  END DO
189               END DO
190
191            ENDIF
192
193            DO jn=1, jptra
194                tr(i1:i2,j1:j2,1:jpk,jn,Krhs_a)=ptab(i1:i2,j1:j2,1:jpk,jn)*tmask(i1:i2,j1:j2,1:jpk) 
195            END DO
196         ENDIF
197
198      ENDIF
199      !
200   END SUBROUTINE interptrn
201
202#else
203   !!----------------------------------------------------------------------
204   !!   Empty module                                           no TOP AGRIF
205   !!----------------------------------------------------------------------
206CONTAINS
207   SUBROUTINE Agrif_TOP_Interp_empty
208      !!---------------------------------------------
209      !!   *** ROUTINE agrif_Top_Interp_empty ***
210      !!---------------------------------------------
211      WRITE(*,*)  'agrif_top_interp : You should not have seen this print! error?'
212   END SUBROUTINE Agrif_TOP_Interp_empty
213#endif
214
215   !!======================================================================
216END MODULE agrif_top_interp
Note: See TracBrowser for help on using the repository browser.