source: trunk/NEMOGCM/NEMO/OPA_SRC/SBC/cpl_oasis3.F90

Last change on this file was 65, checked in by smasson, 11 years ago

bugfix for agrf, obc and xios

File size: 17.6 KB
Line 
1MODULE cpl_oasis3
2   !!======================================================================
3   !!                    ***  MODULE cpl_oasis  ***
4   !! Coupled O/A : coupled ocean-atmosphere case using OASIS3 V. prism_2_4
5   !!               special case: NEMO OPA/LIM coupled to ECHAM5
6   !!=====================================================================
7   !! History :   
8   !!   9.0  !  04-06  (R. Redler, NEC Laboratories Europe, Germany) Original code
9   !!   " "  !  04-11  (R. Redler, NEC Laboratories Europe; N. Keenlyside, W. Park, IFM-GEOMAR, Germany) revision
10   !!   " "  !  04-11  (V. Gayler, MPI M&D) Grid writing
11   !!   " "  !  05-08  (R. Redler, W. Park) frld initialization, paral(2) revision
12   !!   " "  !  05-09  (R. Redler) extended to allow for communication over root only
13   !!   " "  !  06-01  (W. Park) modification of physical part
14   !!   " "  !  06-02  (R. Redler, W. Park) buffer array fix for root exchange
15   !!   3.4  !  11-11  (C. Harris) Changes to allow mutiple category fields
16   !!----------------------------------------------------------------------
17#if defined key_oasis3
18   !!----------------------------------------------------------------------
19   !!   'key_oasis3'                    coupled Ocean/Atmosphere via OASIS3
20   !!----------------------------------------------------------------------
21   !!   cpl_prism_init     : initialization of coupled mode communication
22   !!   cpl_prism_define   : definition of grid and fields
23   !!   cpl_prism_snd     : snd out fields in coupled mode
24   !!   cpl_prism_rcv     : receive fields in coupled mode
25   !!   cpl_prism_finalize : finalize the coupled mode communication
26   !!----------------------------------------------------------------------
27#if defined key_oasis_mct
28   USE mod_prism
29#else
30   USE mod_prism_proto              ! OASIS3 prism module
31   USE mod_prism_def_partition_proto! OASIS3 prism module for partitioning
32   USE mod_prism_put_proto          ! OASIS3 prism module for snding
33   USE mod_prism_get_proto          ! OASIS3 prism module for receiving
34   USE mod_comprism_proto           ! OASIS3 prism module to get coupling frequency
35#endif
36   USE par_oce                      ! ocean parameters
37   USE dom_oce                      ! ocean space and time domain
38   USE in_out_manager               ! I/O manager
39   USE lbclnk                       ! ocean lateral boundary conditions (or mpp link)
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   cpl_prism_init
45   PUBLIC   cpl_prism_define
46   PUBLIC   cpl_prism_snd
47   PUBLIC   cpl_prism_rcv
48   PUBLIC   cpl_prism_freq
49   PUBLIC   cpl_prism_finalize
50
51   LOGICAL, PUBLIC, PARAMETER ::   lk_cpl = .TRUE.   !: coupled flag
52   INTEGER, PUBLIC            ::   OASIS_Rcv  = 1    !: return code if received field
53   INTEGER, PUBLIC            ::   OASIS_idle = 0    !: return code if nothing done by oasis
54   INTEGER                    ::   ncomp_id          ! id returned by prism_init_comp
55   INTEGER                    ::   nerror            ! return error code
56
57   INTEGER, PUBLIC, PARAMETER ::   nmaxfld=40    ! Maximum number of coupling fields
58   
59   TYPE, PUBLIC ::   FLD_CPL               !: Type for coupling field information
60      LOGICAL               ::   laction   ! To be coupled or not
61      CHARACTER(len = 8)    ::   clname    ! Name of the coupling field   
62      CHARACTER(len = 1)    ::   clgrid    ! Grid type 
63      REAL(wp)              ::   nsgn      ! Control of the sign change
64      INTEGER, DIMENSION(9) ::   nid       ! Id of the field (no more than 9 categories)
65      INTEGER               ::   nct       ! Number of categories in field
66   END TYPE FLD_CPL
67
68   TYPE(FLD_CPL), DIMENSION(:), ALLOCATABLE, PUBLIC ::   srcv, ssnd   !: Coupling fields
69
70   REAL(wp), DIMENSION(:,:), ALLOCATABLE ::   exfld   ! Temporary buffer for receiving
71
72   !!----------------------------------------------------------------------
73   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
74   !! $Id: cpl_oasis3.F90 3294 2012-01-28 16:44:18Z rblod $
75   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
76   !!----------------------------------------------------------------------
77CONTAINS
78
79   SUBROUTINE cpl_prism_init( kl_comm )
80      !!-------------------------------------------------------------------
81      !!             ***  ROUTINE cpl_prism_init  ***
82      !!
83      !! ** Purpose :   Initialize coupled mode communication for ocean
84      !!    exchange between AGCM, OGCM and COUPLER. (OASIS3 software)
85      !!
86      !! ** Method  :   OASIS3 MPI communication
87      !!--------------------------------------------------------------------
88      INTEGER, INTENT(out) ::   kl_comm   ! local communicator of the model
89      !!--------------------------------------------------------------------
90
91      ! WARNING: No write in numout in this routine
92      !============================================
93      !------------------------------------------------------------------
94      ! 1st Initialize the PRISM system for the application
95      !------------------------------------------------------------------
96      CALL prism_init_comp_proto ( ncomp_id, 'oceanx', nerror )
97      IF ( nerror /= PRISM_Ok ) &
98         CALL prism_abort_proto (ncomp_id, 'cpl_prism_init', 'Failure in prism_init_comp_proto')
99
100      !------------------------------------------------------------------
101      ! 3rd Get an MPI communicator for OPA local communication
102      !------------------------------------------------------------------
103
104      CALL prism_get_localcomm_proto ( kl_comm, nerror )
105      IF ( nerror /= PRISM_Ok ) &
106         CALL prism_abort_proto (ncomp_id, 'cpl_prism_init','Failure in prism_get_localcomm_proto' )
107      !
108   END SUBROUTINE cpl_prism_init
109
110
111   SUBROUTINE cpl_prism_define( krcv, ksnd )
112      !!-------------------------------------------------------------------
113      !!             ***  ROUTINE cpl_prism_define  ***
114      !!
115      !! ** Purpose :   Define grid and field information for ocean
116      !!    exchange between AGCM, OGCM and COUPLER. (OASIS3 software)
117      !!
118      !! ** Method  :   OASIS3 MPI communication
119      !!--------------------------------------------------------------------
120      INTEGER, INTENT(in) ::   krcv, ksnd     ! Number of received and sent coupling fields
121      !
122      INTEGER :: id_part
123      INTEGER :: paral(5)       ! OASIS3 box partition
124      INTEGER :: ishape(2,2)    ! shape of arrays passed to PSMILe
125      INTEGER :: ji,jc          ! local loop indicees
126      CHARACTER(LEN=8) :: zclname
127      !!--------------------------------------------------------------------
128
129      IF(lwp) WRITE(numout,*)
130      IF(lwp) WRITE(numout,*) 'cpl_prism_define : initialization in coupled ocean/atmosphere case'
131      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~~~~'
132      IF(lwp) WRITE(numout,*)
133
134      !
135      ! ... Define the shape for the area that excludes the halo
136      !     For serial configuration (key_mpp_mpi not being active)
137      !     nl* is set to the global values 1 and jp*glo.
138      !
139      ishape(:,1) = (/ 1, nlei-nldi+1 /)
140      ishape(:,2) = (/ 1, nlej-nldj+1 /)
141      !
142      ! ... Allocate memory for data exchange
143      !
144      ALLOCATE(exfld(nlei-nldi+1, nlej-nldj+1), stat = nerror)
145      IF( nerror > 0 ) THEN
146         CALL prism_abort_proto ( ncomp_id, 'cpl_prism_define', 'Failure in allocating exfld')   ;   RETURN
147      ENDIF
148      !
149      ! -----------------------------------------------------------------
150      ! ... Define the partition
151      ! -----------------------------------------------------------------
152     
153      paral(1) = 2                                              ! box partitioning
154      paral(2) = jpiglo * (nldj-1+njmpp-1) + (nldi-1+nimpp-1)   ! NEMO lower left corner global offset   
155      paral(3) = nlei-nldi+1                                    ! local extent in i
156      paral(4) = nlej-nldj+1                                    ! local extent in j
157      paral(5) = jpiglo                                         ! global extent in x
158     
159      IF( ln_ctl ) THEN
160         WRITE(numout,*) ' multiexchg: paral (1:5)', paral
161         WRITE(numout,*) ' multiexchg: jpi, jpj =', jpi, jpj
162         WRITE(numout,*) ' multiexchg: nldi, nlei, nimpp =', nldi, nlei, nimpp
163         WRITE(numout,*) ' multiexchg: nldj, nlej, njmpp =', nldj, nlej, njmpp
164      ENDIF
165     
166      CALL prism_def_partition_proto ( id_part, paral, nerror )
167      !
168      ! ... Announce send variables.
169      !
170      DO ji = 1, ksnd
171         IF ( ssnd(ji)%laction ) THEN
172            DO jc = 1, ssnd(ji)%nct
173               IF ( ssnd(ji)%nct .gt. 1 ) THEN
174                  WRITE(zclname,'( a7, i1)') ssnd(ji)%clname,jc
175               ELSE
176                  zclname=ssnd(ji)%clname
177               ENDIF
178               IF( ln_ctl ) WRITE(numout,*) "Define",ji,jc,zclname," for",PRISM_Out
179               CALL prism_def_var_proto (ssnd(ji)%nid(jc), zclname, id_part, (/ 2, 0/),   &
180                    PRISM_Out, ishape, PRISM_REAL, nerror)
181               IF ( nerror /= PRISM_Ok ) THEN
182                  WRITE(numout,*) 'Failed to define transient ', ji, TRIM(zclname)
183                  CALL prism_abort_proto ( ssnd(ji)%nid(jc), 'cpl_prism_define', 'Failure in prism_def_var')
184               ENDIF
185            END DO
186         ENDIF
187      END DO
188      !
189      ! ... Announce received variables.
190      !
191      DO ji = 1, krcv
192         IF ( srcv(ji)%laction ) THEN
193            DO jc = 1, srcv(ji)%nct
194               IF ( srcv(ji)%nct .gt. 1 ) THEN
195                  WRITE(zclname,'( a7, i1)') srcv(ji)%clname,jc
196               ELSE
197                  zclname=srcv(ji)%clname
198               ENDIF
199#if defined key_agrif
200               IF( agrif_fixed() /= 0 ) THEN
201                  zclname=TRIM(Agrif_CFixed())//zclname(2:8)
202               END IF
203#endif
204               IF( ln_ctl ) WRITE(numout,*) "Define",ji,jc,zclname," for",PRISM_In
205               CALL prism_def_var_proto ( srcv(ji)%nid(jc), zclname, id_part, (/ 2, 0/),   &
206                    &                      PRISM_In    , ishape   , PRISM_REAL, nerror)
207               IF ( nerror /= PRISM_Ok ) THEN
208                  WRITE(numout,*) 'Failed to define transient ', ji, TRIM(zclname)
209                  CALL prism_abort_proto ( srcv(ji)%nid(jc), 'cpl_prism_define', 'Failure in prism_def_var')
210               ENDIF
211            END DO
212         ENDIF
213      END DO
214     
215      !------------------------------------------------------------------
216      ! End of definition phase
217      !------------------------------------------------------------------
218#if defined key_agrif
219!!$      IF( agrif_fixed() == agrif_nb_fixed_grids() ) THEN
220      IF( .NOT. Agrif_Root() ) THEN
221#endif
222         WRITE(numout,*) 'before prism_enddef_proto'
223         CALL FLUSH(numout)
224
225         CALL prism_enddef_proto(nerror)
226         IF( nerror /= PRISM_Ok )   CALL prism_abort_proto ( ncomp_id, 'cpl_prism_define', 'Failure in prism_enddef')
227      !
228         WRITE(numout,*) 'after prism_enddef_proto'
229         CALL FLUSH(numout)
230#if defined key_agrif
231      ENDIF
232#endif
233
234   END SUBROUTINE cpl_prism_define
235   
236   
237   SUBROUTINE cpl_prism_snd( kid, kstep, pdata, kinfo )
238      !!---------------------------------------------------------------------
239      !!              ***  ROUTINE cpl_prism_snd  ***
240      !!
241      !! ** Purpose : - At each coupling time-step,this routine sends fields
242      !!      like sst or ice cover to the coupler or remote application.
243      !!----------------------------------------------------------------------
244      INTEGER                   , INTENT(in   ) ::   kid       ! variable index in the array
245      INTEGER                   , INTENT(  out) ::   kinfo     ! OASIS3 info argument
246      INTEGER                   , INTENT(in   ) ::   kstep     ! ocean time-step in seconds
247      REAL(wp), DIMENSION(:,:,:), INTENT(in   ) ::   pdata
248      !!
249      INTEGER                                   ::   jc        ! local loop index
250      !!--------------------------------------------------------------------
251      !
252      ! snd data to OASIS3
253      !
254      DO jc = 1, ssnd(kid)%nct
255
256         CALL prism_put_proto ( ssnd(kid)%nid(jc), kstep, pdata(nldi:nlei, nldj:nlej,jc), kinfo )
257         
258         IF ( ln_ctl ) THEN       
259            IF ( kinfo == PRISM_Sent     .OR. kinfo == PRISM_ToRest .OR.   &
260                 & kinfo == PRISM_SentOut  .OR. kinfo == PRISM_ToRestOut ) THEN
261               WRITE(numout,*) '****************'
262               WRITE(numout,*) 'prism_put_proto: Outgoing ', ssnd(kid)%clname
263               WRITE(numout,*) 'prism_put_proto: ivarid ', ssnd(kid)%nid(jc)
264               WRITE(numout,*) 'prism_put_proto:  kstep ', kstep
265               WRITE(numout,*) 'prism_put_proto:   info ', kinfo
266               WRITE(numout,*) '     - Minimum value is ', MINVAL(pdata(:,:,jc))
267               WRITE(numout,*) '     - Maximum value is ', MAXVAL(pdata(:,:,jc))
268               WRITE(numout,*) '     -     Sum value is ', SUM(pdata(:,:,jc))
269               WRITE(numout,*) '****************'
270            ENDIF
271         ENDIF
272
273      ENDDO
274      !
275    END SUBROUTINE cpl_prism_snd
276
277
278   SUBROUTINE cpl_prism_rcv( kid, kstep, pdata, kinfo )
279      !!---------------------------------------------------------------------
280      !!              ***  ROUTINE cpl_prism_rcv  ***
281      !!
282      !! ** Purpose : - At each coupling time-step,this routine receives fields
283      !!      like stresses and fluxes from the coupler or remote application.
284      !!----------------------------------------------------------------------
285      INTEGER                   , INTENT(in   ) ::   kid       ! variable index in the array
286      INTEGER                   , INTENT(in   ) ::   kstep     ! ocean time-step in seconds
287      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   pdata     ! IN to keep the value if nothing is done
288      INTEGER                   , INTENT(  out) ::   kinfo     ! OASIS3 info argument
289      !!
290      INTEGER                                   ::   jc        ! local loop index
291      LOGICAL                                   ::   llaction
292      !!--------------------------------------------------------------------
293      !
294      ! receive local data from OASIS3 on every process
295      !
296      DO jc = 1, srcv(kid)%nct
297
298         CALL prism_get_proto ( srcv(kid)%nid(jc), kstep, exfld, kinfo )         
299         
300         llaction = .false.
301         IF( kinfo == PRISM_Recvd   .OR. kinfo == PRISM_FromRest .OR.   &
302              kinfo == PRISM_RecvOut .OR. kinfo == PRISM_FromRestOut )   llaction = .TRUE.
303         
304         IF ( ln_ctl )   WRITE(numout,*) "llaction, kinfo, kstep, ivarid: " , llaction, kinfo, kstep, srcv(kid)%nid(jc)
305         
306         IF ( llaction ) THEN
307           
308            kinfo = OASIS_Rcv
309            pdata(nldi:nlei, nldj:nlej,jc) = exfld(:,:)
310           
311            !--- Fill the overlap areas and extra hallows (mpp)
312            !--- check periodicity conditions (all cases)
313            CALL lbc_lnk( pdata(:,:,jc), srcv(kid)%clgrid, srcv(kid)%nsgn )   
314           
315            IF ( ln_ctl ) THEN       
316               WRITE(numout,*) '****************'
317               WRITE(numout,*) 'prism_get_proto: Incoming ', srcv(kid)%clname
318               WRITE(numout,*) 'prism_get_proto: ivarid '  , srcv(kid)%nid(jc)
319               WRITE(numout,*) 'prism_get_proto:   kstep', kstep
320               WRITE(numout,*) 'prism_get_proto:   info ', kinfo
321               WRITE(numout,*) '     - Minimum value is ', MINVAL(pdata(:,:,jc))
322               WRITE(numout,*) '     - Maximum value is ', MAXVAL(pdata(:,:,jc))
323               WRITE(numout,*) '     -     Sum value is ', SUM(pdata(:,:,jc))
324               WRITE(numout,*) '****************'
325            ENDIF
326           
327         ELSE
328            kinfo = OASIS_idle     
329         ENDIF
330         
331      ENDDO
332      !
333   END SUBROUTINE cpl_prism_rcv
334
335
336   INTEGER FUNCTION cpl_prism_freq( kid ) 
337      !!---------------------------------------------------------------------
338      !!              ***  ROUTINE cpl_prism_freq  ***
339      !!
340      !! ** Purpose : - send back the coupling frequency for a particular field
341      !!----------------------------------------------------------------------
342      INTEGER,INTENT(in) ::   kid   ! variable index
343      !!----------------------------------------------------------------------
344!EM OASIS-MCT info not yet available on official distrib
345!      cpl_prism_freq = ig_def_freq( kid )
346      cpl_prism_freq = 300
347      !
348   END FUNCTION cpl_prism_freq
349
350
351   SUBROUTINE cpl_prism_finalize
352      !!---------------------------------------------------------------------
353      !!              ***  ROUTINE cpl_prism_finalize  ***
354      !!
355      !! ** Purpose : - Finalizes the coupling. If MPI_init has not been
356      !!      called explicitly before cpl_prism_init it will also close
357      !!      MPI communication.
358      !!----------------------------------------------------------------------
359      !
360      DEALLOCATE( exfld )
361      CALL prism_terminate_proto( nerror )         
362      !
363   END SUBROUTINE cpl_prism_finalize
364
365#else
366   !!----------------------------------------------------------------------
367   !!   Default case          Dummy module          Forced Ocean/Atmosphere
368   !!----------------------------------------------------------------------
369   USE in_out_manager               ! I/O manager
370   LOGICAL, PUBLIC, PARAMETER :: lk_cpl = .FALSE.   !: coupled flag
371   PUBLIC cpl_prism_init
372   PUBLIC cpl_prism_finalize
373CONTAINS
374   SUBROUTINE cpl_prism_init (kl_comm) 
375      INTEGER, INTENT(out)   :: kl_comm       ! local communicator of the model
376      kl_comm = -1
377      WRITE(numout,*) 'cpl_prism_init: Error you sould not be there...'
378   END SUBROUTINE cpl_prism_init
379   SUBROUTINE cpl_prism_finalize
380      WRITE(numout,*) 'cpl_prism_finalize: Error you sould not be there...'
381   END SUBROUTINE cpl_prism_finalize
382#endif
383
384   !!=====================================================================
385END MODULE cpl_oasis3
Note: See TracBrowser for help on using the repository browser.