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.
mpp_nfd_generic.h90 in utils/tools_UKMO_MERGE_2019/DOMAINcfg/src – NEMO

source: utils/tools_UKMO_MERGE_2019/DOMAINcfg/src/mpp_nfd_generic.h90 @ 12101

Last change on this file since 12101 was 12101, checked in by mathiot, 4 years ago

merge ENHANCE-03_domcfg and ENHANCE-02_ISF_nemo

File size: 13.3 KB
Line 
1#if defined MULTI
2#   define NAT_IN(k)                cd_nat(k)   
3#   define SGN_IN(k)                psgn(k)
4#   define F_SIZE(ptab)             kfld
5#   define LBC_ARG                  (jf)
6#   if defined DIM_2d
7#      define ARRAY_TYPE(i,j,k,l,f)    TYPE(PTR_2D)     , INTENT(inout) ::   ptab(f)
8#      define ARRAY_IN(i,j,k,l,f)      ptab(f)%pt2d(i,j)
9#      define K_SIZE(ptab)             1
10#      define L_SIZE(ptab)             1
11#   endif
12#   if defined DIM_3d
13#      define ARRAY_TYPE(i,j,k,l,f)    TYPE(PTR_3D)     , INTENT(inout) ::   ptab(f)
14#      define ARRAY_IN(i,j,k,l,f)      ptab(f)%pt3d(i,j,k)
15#      define K_SIZE(ptab)             SIZE(ptab(1)%pt3d,3)
16#      define L_SIZE(ptab)             1
17#   endif
18#   if defined DIM_4d
19#      define ARRAY_TYPE(i,j,k,l,f)    TYPE(PTR_4D)     , INTENT(inout) ::   ptab(f)
20#      define ARRAY_IN(i,j,k,l,f)      ptab(f)%pt4d(i,j,k,l)
21#      define K_SIZE(ptab)             SIZE(ptab(1)%pt4d,3)
22#      define L_SIZE(ptab)             SIZE(ptab(1)%pt4d,4)
23#   endif
24#else
25!                          !==  IN: ptab is an array  ==!
26#   define ARRAY_TYPE(i,j,k,l,f)    REAL(wp)         , INTENT(inout) ::   ARRAY_IN(i,j,k,l,f)
27#   define NAT_IN(k)                cd_nat
28#   define SGN_IN(k)                psgn
29#   define F_SIZE(ptab)             1
30#   define LBC_ARG
31#   if defined DIM_2d
32#      define ARRAY_IN(i,j,k,l,f)   ptab(i,j)
33#      define K_SIZE(ptab)          1
34#      define L_SIZE(ptab)          1
35#   endif
36#   if defined DIM_3d
37#      define ARRAY_IN(i,j,k,l,f)   ptab(i,j,k)
38#      define K_SIZE(ptab)          SIZE(ptab,3)
39#      define L_SIZE(ptab)          1
40#   endif
41#   if defined DIM_4d
42#      define ARRAY_IN(i,j,k,l,f)   ptab(i,j,k,l)
43#      define K_SIZE(ptab)          SIZE(ptab,3)
44#      define L_SIZE(ptab)          SIZE(ptab,4)
45#   endif
46#endif
47
48   SUBROUTINE ROUTINE_NFD( ptab, cd_nat, psgn, kfld )
49      !!----------------------------------------------------------------------
50      ARRAY_TYPE(:,:,:,:,:)   ! array or pointer of arrays on which the boundary condition is applied
51      CHARACTER(len=1) , INTENT(in   ) ::   NAT_IN(:)   ! nature of array grid-points
52      REAL(wp)         , INTENT(in   ) ::   SGN_IN(:)   ! sign used across the north fold boundary
53      INTEGER, OPTIONAL, INTENT(in   ) ::   kfld        ! number of pt3d arrays
54      !
55      INTEGER  ::   ji,  jj,  jk,  jl, jh, jf, jr   ! dummy loop indices
56      INTEGER  ::   ipi, ipj, ipk, ipl, ipf         ! dimension of the input array
57      INTEGER  ::   imigr, iihom, ijhom             ! local integers
58      INTEGER  ::   ierr, ibuffsize, ilci, ildi, ilei, iilb
59      INTEGER  ::   ij, iproc
60      INTEGER, DIMENSION (jpmaxngh)       ::   ml_req_nf   ! for mpi_isend when avoiding mpi_allgather
61      INTEGER                             ::   ml_err      ! for mpi_isend when avoiding mpi_allgather
62      INTEGER, DIMENSION(MPI_STATUS_SIZE) ::   ml_stat     ! for mpi_isend when avoiding mpi_allgather
63      !                                                    ! Workspace for message transfers avoiding mpi_allgather
64      INTEGER                             ::   ipf_j       ! sum of lines for all multi fields
65      INTEGER                             ::   js          ! counter
66      INTEGER, DIMENSION(:,:),          ALLOCATABLE ::   jj_s  ! position of sent lines
67      INTEGER, DIMENSION(:),            ALLOCATABLE ::   ipj_s ! number of sent lines
68      REAL(wp), DIMENSION(:,:,:)      , ALLOCATABLE ::   ztabl
69      REAL(wp), DIMENSION(:,:,:,:,:)  , ALLOCATABLE ::   ztab, ztabr
70      REAL(wp), DIMENSION(:,:,:,:,:)  , ALLOCATABLE ::   znorthloc, zfoldwk     
71      REAL(wp), DIMENSION(:,:,:,:,:,:), ALLOCATABLE ::   znorthgloio
72      !!----------------------------------------------------------------------
73      !
74      ipk = K_SIZE(ptab)   ! 3rd dimension
75      ipl = L_SIZE(ptab)   ! 4th    -
76      ipf = F_SIZE(ptab)   ! 5th    -      use in "multi" case (array of pointers)
77      !
78      IF( l_north_nogather ) THEN      !==  ????  ==!
79
80         ALLOCATE(ipj_s(ipf))
81
82         ipj      = 2            ! Max 2nd dimension of message transfers (last two j-line only)
83         ipj_s(:) = 1            ! Real 2nd dimension of message transfers (depending on perf requirement)
84                                 ! by default, only one line is exchanged
85
86         ALLOCATE( jj_s(ipf,2) )
87
88         ! re-define number of exchanged lines :
89         !  must be two during the first two time steps
90         !  to correct possible incoherent values on North fold lines from restart
91
92         !!!!!!!!!           temporary switch off this optimisation ==> force TRUE           !!!!!!!!
93         !!!!!!!!!  needed to get the same results without agrif and with agrif and no zoom  !!!!!!!!
94         !!!!!!!!!                    I don't know why we must do that...                    !!!!!!!!
95         l_full_nf_update = .TRUE.
96
97         ! Two lines update (slower but necessary to avoid different values ion identical grid points
98         IF ( l_full_nf_update .OR.                          &    ! if coupling fields
99              ( ncom_stp == nit000 .AND. .NOT. ln_rstart ) ) &    ! at first time step, if not restart
100            ipj_s(:) = 2
101
102         ! Index of modifying lines in input
103         DO jf = 1, ipf                      ! Loop over the number of arrays to be processed
104            !
105            SELECT CASE ( npolj )
106            !
107            CASE ( 3, 4 )                       ! *  North fold  T-point pivot
108               !
109               SELECT CASE ( NAT_IN(jf) )
110               !
111               CASE ( 'T' , 'W' ,'U' )                            ! T-, U-, W-point
112                  jj_s(jf,1) = nlcj - 2 ;  jj_s(jf,2) = nlcj - 1
113               CASE ( 'V' , 'F' )                                 ! V-, F-point
114                  jj_s(jf,1) = nlcj - 3 ;  jj_s(jf,2) = nlcj - 2
115               END SELECT
116            !
117            CASE ( 5, 6 )                        ! *  North fold  F-point pivot
118               SELECT CASE ( NAT_IN(jf) )
119               !
120               CASE ( 'T' , 'W' ,'U' )                            ! T-, U-, W-point
121                  jj_s(jf,1) = nlcj - 1     
122                  ipj_s(jf) = 1                  ! need only one line anyway
123               CASE ( 'V' , 'F' )                                 ! V-, F-point
124                  jj_s(jf,1) = nlcj - 2 ;  jj_s(jf,2) = nlcj - 1
125               END SELECT
126            !
127            END SELECT
128            !
129         ENDDO
130         !
131         ipf_j = sum (ipj_s(:))      ! Total number of lines to be exchanged
132         !
133         ALLOCATE( znorthloc(jpimax,ipf_j,ipk,ipl,1) )
134         !
135         js = 0
136         DO jf = 1, ipf                      ! Loop over the number of arrays to be processed
137            DO jj = 1, ipj_s(jf)
138               js = js + 1
139               DO jl = 1, ipl
140                  DO jk = 1, ipk
141                     znorthloc(1:jpi,js,jk,jl,1) = ARRAY_IN(1:jpi,jj_s(jf,jj),jk,jl,jf)
142                  END DO
143               END DO
144            END DO
145         END DO
146         !
147         ibuffsize = jpimax * ipf_j * ipk * ipl
148         !
149         ALLOCATE( zfoldwk(jpimax,ipf_j,ipk,ipl,1) )
150         ALLOCATE( ztabr(jpimax*jpmaxngh,ipj,ipk,ipl,ipf) )
151         ! when some processors of the north fold are suppressed,
152         ! values of ztab* arrays corresponding to these suppressed domain won't be defined
153         ! and we need a default definition to 0.
154         ! a better test should be: a testing if "suppressed land-processors" belongs to the north-pole folding
155         IF ( jpni*jpnj /= jpnij ) ztabr(:,:,:,:,:) = 0._wp
156         !
157         ! start waiting time measurement
158         IF( ln_timing ) CALL tic_tac(.TRUE.)
159         !
160         DO jr = 1, nsndto
161            IF( nfipproc(isendto(jr),jpnj) /= narea-1 .AND. nfipproc(isendto(jr),jpnj) /= -1 ) THEN
162               CALL mppsend( 5, znorthloc, ibuffsize, nfipproc(isendto(jr),jpnj), ml_req_nf(jr) )
163            ENDIF
164         END DO
165         !
166         DO jr = 1,nsndto
167            iproc = nfipproc(isendto(jr),jpnj)
168            IF(iproc /= -1) THEN
169               iilb = nimppt(iproc+1)
170               ilci = nlcit (iproc+1)
171               ildi = nldit (iproc+1)
172               ilei = nleit (iproc+1)
173               IF( iilb            ==      1 )   ildi = 1      ! e-w boundary already done -> force to take 1st column
174               IF( iilb + ilci - 1 == jpiglo )   ilei = ilci   ! e-w boundary already done -> force to take last column
175               iilb = nfiimpp(isendto(jr),jpnj) - nfiimpp(isendto(1),jpnj)
176            ENDIF
177            IF( iproc /= narea-1 .AND. iproc /= -1 ) THEN
178               CALL mpprecv(5, zfoldwk, ibuffsize, iproc)
179               js = 0
180               DO jf = 1, ipf ; DO jj = 1, ipj_s(jf)
181                  js = js + 1
182                  DO jl = 1, ipl
183                     DO jk = 1, ipk
184                        DO ji = ildi, ilei
185                           ztabr(iilb+ji,jj,jk,jl,jf) = zfoldwk(ji,js,jk,jl,1)
186                        END DO
187                     END DO
188                  END DO
189               END DO; END DO
190            ELSE IF( iproc == narea-1 ) THEN
191               DO jf = 1, ipf ; DO jj = 1, ipj_s(jf)
192                  DO jl = 1, ipl
193                     DO jk = 1, ipk
194                        DO ji = ildi, ilei
195                           ztabr(iilb+ji,jj,jk,jl,jf) = ARRAY_IN(ji,jj_s(jf,jj),jk,jl,jf)
196                        END DO
197                     END DO
198                  END DO
199               END DO; END DO
200            ENDIF
201         END DO
202         IF( l_isend ) THEN
203            DO jr = 1,nsndto
204               IF( nfipproc(isendto(jr),jpnj) /= narea-1 .AND. nfipproc(isendto(jr),jpnj) /= -1 ) THEN
205                  CALL mpi_wait( ml_req_nf(jr), ml_stat, ml_err )
206               ENDIF
207            END DO
208         ENDIF
209         !
210         IF( ln_timing ) CALL tic_tac(.FALSE.)
211         !
212         ! North fold boundary condition
213         !
214         DO jf = 1, ipf
215            CALL lbc_nfd_nogather(ARRAY_IN(:,:,:,:,jf), ztabr(:,1:ipj_s(jf),:,:,jf), cd_nat LBC_ARG, psgn LBC_ARG )
216         END DO
217         !
218         DEALLOCATE( zfoldwk )
219         DEALLOCATE( ztabr )
220         DEALLOCATE( jj_s )
221         DEALLOCATE( ipj_s )
222      ELSE                             !==  ????  ==!
223         !
224         ipj   = 4            ! 2nd dimension of message transfers (last j-lines)
225         !
226         ALLOCATE( znorthloc(jpimax,ipj,ipk,ipl,ipf) )
227         !
228         DO jf = 1, ipf                ! put in znorthloc the last ipj j-lines of ptab
229            DO jl = 1, ipl
230               DO jk = 1, ipk
231                  DO jj = nlcj - ipj +1, nlcj
232                     ij = jj - nlcj + ipj
233                     znorthloc(1:jpi,ij,jk,jl,jf) = ARRAY_IN(1:jpi,jj,jk,jl,jf)
234                  END DO
235               END DO
236            END DO
237         END DO
238         !
239         ibuffsize = jpimax * ipj * ipk * ipl * ipf
240         !
241         ALLOCATE( ztab       (jpiglo,ipj,ipk,ipl,ipf     ) )
242         ALLOCATE( znorthgloio(jpimax,ipj,ipk,ipl,ipf,jpni) )
243         !
244         ! when some processors of the north fold are suppressed,
245         ! values of ztab* arrays corresponding to these suppressed domain won't be defined
246         ! and we need a default definition to 0.
247         ! a better test should be: a testing if "suppressed land-processors" belongs to the north-pole folding
248         IF ( jpni*jpnj /= jpnij ) ztab(:,:,:,:,:) = 0._wp
249         !
250         ! start waiting time measurement
251         IF( ln_timing ) CALL tic_tac(.TRUE.)
252         CALL MPI_ALLGATHER( znorthloc  , ibuffsize, MPI_DOUBLE_PRECISION,                &
253            &                znorthgloio, ibuffsize, MPI_DOUBLE_PRECISION, ncomm_north, ierr )
254         !
255         ! stop waiting time measurement
256         IF( ln_timing ) CALL tic_tac(.FALSE.)
257         !
258         DO jr = 1, ndim_rank_north         ! recover the global north array
259            iproc = nrank_north(jr) + 1
260            iilb  = nimppt(iproc)
261            ilci  = nlcit (iproc)
262            ildi  = nldit (iproc)
263            ilei  = nleit (iproc)
264            IF( iilb            ==      1 )   ildi = 1      ! e-w boundary already done -> force to take 1st column
265            IF( iilb + ilci - 1 == jpiglo )   ilei = ilci   ! e-w boundary already done -> force to take last column
266            DO jf = 1, ipf
267               DO jl = 1, ipl
268                  DO jk = 1, ipk
269                     DO jj = 1, ipj
270                        DO ji = ildi, ilei
271                           ztab(ji+iilb-1,jj,jk,jl,jf) = znorthgloio(ji,jj,jk,jl,jf,jr)
272                        END DO
273                     END DO
274                  END DO
275               END DO
276            END DO
277         END DO
278         DO jf = 1, ipf
279            CALL lbc_nfd( ztab(:,:,:,:,jf), cd_nat LBC_ARG, psgn LBC_ARG )   ! North fold boundary condition
280         END DO
281         !
282         DO jf = 1, ipf
283            DO jl = 1, ipl
284               DO jk = 1, ipk
285                  DO jj = nlcj-ipj+1, nlcj             ! Scatter back to ARRAY_IN
286                     ij = jj - nlcj + ipj
287                     DO ji= 1, nlci
288                        ARRAY_IN(ji,jj,jk,jl,jf) = ztab(ji+nimpp-1,ij,jk,jl,jf)
289                     END DO
290                  END DO
291               END DO
292            END DO
293         END DO
294         !
295      !
296         DEALLOCATE( ztab )
297         DEALLOCATE( znorthgloio )
298      ENDIF
299      !
300      DEALLOCATE( znorthloc )
301      !
302   END SUBROUTINE ROUTINE_NFD
303
304#undef ARRAY_TYPE
305#undef NAT_IN
306#undef SGN_IN
307#undef ARRAY_IN
308#undef K_SIZE
309#undef L_SIZE
310#undef F_SIZE
311#undef LBC_ARG
Note: See TracBrowser for help on using the repository browser.