[532] | 1 | MODULE cpl_oasis3 |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE cpl_oasis *** |
---|
[4990] | 4 | !! Coupled O/A : coupled ocean-atmosphere case using OASIS3-MCT |
---|
[532] | 5 | !!===================================================================== |
---|
[5836] | 6 | !! History : 1.0 ! 2004-06 (R. Redler, NEC Laboratories Europe, Germany) Original code |
---|
| 7 | !! - ! 2004-11 (R. Redler, NEC Laboratories Europe; N. Keenlyside, W. Park, IFM-GEOMAR, Germany) revision |
---|
| 8 | !! - ! 2004-11 (V. Gayler, MPI M&D) Grid writing |
---|
| 9 | !! 2.0 ! 2005-08 (R. Redler, W. Park) frld initialization, paral(2) revision |
---|
| 10 | !! - ! 2005-09 (R. Redler) extended to allow for communication over root only |
---|
| 11 | !! - ! 2006-01 (W. Park) modification of physical part |
---|
| 12 | !! - ! 2006-02 (R. Redler, W. Park) buffer array fix for root exchange |
---|
| 13 | !! 3.4 ! 2011-11 (C. Harris) Changes to allow mutiple category fields |
---|
| 14 | !! 3.6 ! 2014-11 (S. Masson) OASIS3-MCT |
---|
[532] | 15 | !!---------------------------------------------------------------------- |
---|
[5836] | 16 | |
---|
[532] | 17 | !!---------------------------------------------------------------------- |
---|
[5407] | 18 | !! 'key_oasis3' coupled Ocean/Atmosphere via OASIS3-MCT |
---|
| 19 | !! 'key_oa3mct_v3' to be added for OASIS3-MCT version 3 |
---|
[532] | 20 | !!---------------------------------------------------------------------- |
---|
[4990] | 21 | !! cpl_init : initialization of coupled mode communication |
---|
| 22 | !! cpl_define : definition of grid and fields |
---|
[5836] | 23 | !! cpl_snd : snd out fields in coupled mode |
---|
| 24 | !! cpl_rcv : receive fields in coupled mode |
---|
[4990] | 25 | !! cpl_finalize : finalize the coupled mode communication |
---|
[532] | 26 | !!---------------------------------------------------------------------- |
---|
[4990] | 27 | #if defined key_oasis3 |
---|
| 28 | USE mod_oasis ! OASIS3-MCT module |
---|
| 29 | #endif |
---|
[1218] | 30 | USE par_oce ! ocean parameters |
---|
[532] | 31 | USE dom_oce ! ocean space and time domain |
---|
| 32 | USE in_out_manager ! I/O manager |
---|
[2715] | 33 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
| 34 | |
---|
[532] | 35 | IMPLICIT NONE |
---|
[1218] | 36 | PRIVATE |
---|
[532] | 37 | |
---|
[4990] | 38 | PUBLIC cpl_init |
---|
| 39 | PUBLIC cpl_define |
---|
| 40 | PUBLIC cpl_snd |
---|
| 41 | PUBLIC cpl_rcv |
---|
| 42 | PUBLIC cpl_freq |
---|
| 43 | PUBLIC cpl_finalize |
---|
[11105] | 44 | |
---|
[2715] | 45 | |
---|
| 46 | INTEGER, PUBLIC :: OASIS_Rcv = 1 !: return code if received field |
---|
| 47 | INTEGER, PUBLIC :: OASIS_idle = 0 !: return code if nothing done by oasis |
---|
[4990] | 48 | INTEGER :: ncomp_id ! id returned by oasis_init_comp |
---|
[2715] | 49 | INTEGER :: nerror ! return error code |
---|
[4990] | 50 | #if ! defined key_oasis3 |
---|
| 51 | ! OASIS Variables not used. defined only for compilation purpose |
---|
| 52 | INTEGER :: OASIS_Out = -1 |
---|
| 53 | INTEGER :: OASIS_REAL = -1 |
---|
| 54 | INTEGER :: OASIS_Ok = -1 |
---|
| 55 | INTEGER :: OASIS_In = -1 |
---|
| 56 | INTEGER :: OASIS_Sent = -1 |
---|
| 57 | INTEGER :: OASIS_SentOut = -1 |
---|
| 58 | INTEGER :: OASIS_ToRest = -1 |
---|
| 59 | INTEGER :: OASIS_ToRestOut = -1 |
---|
| 60 | INTEGER :: OASIS_Recvd = -1 |
---|
| 61 | INTEGER :: OASIS_RecvOut = -1 |
---|
| 62 | INTEGER :: OASIS_FromRest = -1 |
---|
| 63 | INTEGER :: OASIS_FromRestOut = -1 |
---|
| 64 | #endif |
---|
[2715] | 65 | |
---|
[5407] | 66 | INTEGER :: nrcv ! total number of fields received |
---|
| 67 | INTEGER :: nsnd ! total number of fields sent |
---|
| 68 | INTEGER :: ncplmodel ! Maximum number of models to/from which NEMO is potentialy sending/receiving data |
---|
[9023] | 69 | INTEGER, PUBLIC, PARAMETER :: nmaxfld=60 ! Maximum number of coupling fields |
---|
[4990] | 70 | INTEGER, PUBLIC, PARAMETER :: nmaxcat=5 ! Maximum number of coupling fields |
---|
| 71 | INTEGER, PUBLIC, PARAMETER :: nmaxcpl=5 ! Maximum number of coupling fields |
---|
[10112] | 72 | LOGICAL, PARAMETER :: ltmp_wapatch = .TRUE. ! patch to restore wraparound rows in cpl_send, cpl_rcv, cpl_define |
---|
| 73 | INTEGER :: nldi_save, nlei_save |
---|
| 74 | INTEGER :: nldj_save, nlej_save |
---|
[1218] | 75 | |
---|
[3294] | 76 | TYPE, PUBLIC :: FLD_CPL !: Type for coupling field information |
---|
| 77 | LOGICAL :: laction ! To be coupled or not |
---|
| 78 | CHARACTER(len = 8) :: clname ! Name of the coupling field |
---|
| 79 | CHARACTER(len = 1) :: clgrid ! Grid type |
---|
| 80 | REAL(wp) :: nsgn ! Control of the sign change |
---|
[4990] | 81 | INTEGER, DIMENSION(nmaxcat,nmaxcpl) :: nid ! Id of the field (no more than 9 categories and 9 extrena models) |
---|
[3294] | 82 | INTEGER :: nct ! Number of categories in field |
---|
[4990] | 83 | INTEGER :: ncplmodel ! Maximum number of models to/from which this variable may be sent/received |
---|
[1218] | 84 | END TYPE FLD_CPL |
---|
[532] | 85 | |
---|
[2715] | 86 | TYPE(FLD_CPL), DIMENSION(nmaxfld), PUBLIC :: srcv, ssnd !: Coupling fields |
---|
[532] | 87 | |
---|
[2715] | 88 | REAL(wp), DIMENSION(:,:), ALLOCATABLE :: exfld ! Temporary buffer for receiving |
---|
[11105] | 89 | |
---|
[532] | 90 | !!---------------------------------------------------------------------- |
---|
[9598] | 91 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[2528] | 92 | !! $Id$ |
---|
[10068] | 93 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[532] | 94 | !!---------------------------------------------------------------------- |
---|
| 95 | CONTAINS |
---|
| 96 | |
---|
[5407] | 97 | SUBROUTINE cpl_init( cd_modname, kl_comm ) |
---|
[532] | 98 | !!------------------------------------------------------------------- |
---|
[4990] | 99 | !! *** ROUTINE cpl_init *** |
---|
[532] | 100 | !! |
---|
| 101 | !! ** Purpose : Initialize coupled mode communication for ocean |
---|
| 102 | !! exchange between AGCM, OGCM and COUPLER. (OASIS3 software) |
---|
| 103 | !! |
---|
| 104 | !! ** Method : OASIS3 MPI communication |
---|
| 105 | !!-------------------------------------------------------------------- |
---|
[5836] | 106 | CHARACTER(len = *), INTENT(in ) :: cd_modname ! model name as set in namcouple file |
---|
| 107 | INTEGER , INTENT( out) :: kl_comm ! local communicator of the model |
---|
[1226] | 108 | !!-------------------------------------------------------------------- |
---|
[1218] | 109 | |
---|
[1579] | 110 | ! WARNING: No write in numout in this routine |
---|
| 111 | !============================================ |
---|
| 112 | |
---|
[532] | 113 | !------------------------------------------------------------------ |
---|
[4990] | 114 | ! 1st Initialize the OASIS system for the application |
---|
[532] | 115 | !------------------------------------------------------------------ |
---|
[5407] | 116 | CALL oasis_init_comp ( ncomp_id, TRIM(cd_modname), nerror ) |
---|
[4990] | 117 | IF ( nerror /= OASIS_Ok ) & |
---|
| 118 | CALL oasis_abort (ncomp_id, 'cpl_init', 'Failure in oasis_init_comp') |
---|
[532] | 119 | |
---|
| 120 | !------------------------------------------------------------------ |
---|
| 121 | ! 3rd Get an MPI communicator for OPA local communication |
---|
| 122 | !------------------------------------------------------------------ |
---|
| 123 | |
---|
[4990] | 124 | CALL oasis_get_localcomm ( kl_comm, nerror ) |
---|
| 125 | IF ( nerror /= OASIS_Ok ) & |
---|
| 126 | CALL oasis_abort (ncomp_id, 'cpl_init','Failure in oasis_get_localcomm' ) |
---|
[2715] | 127 | ! |
---|
[4990] | 128 | END SUBROUTINE cpl_init |
---|
[532] | 129 | |
---|
| 130 | |
---|
[4990] | 131 | SUBROUTINE cpl_define( krcv, ksnd, kcplmodel ) |
---|
[532] | 132 | !!------------------------------------------------------------------- |
---|
[4990] | 133 | !! *** ROUTINE cpl_define *** |
---|
[532] | 134 | !! |
---|
| 135 | !! ** Purpose : Define grid and field information for ocean |
---|
| 136 | !! exchange between AGCM, OGCM and COUPLER. (OASIS3 software) |
---|
| 137 | !! |
---|
| 138 | !! ** Method : OASIS3 MPI communication |
---|
| 139 | !!-------------------------------------------------------------------- |
---|
[2715] | 140 | INTEGER, INTENT(in) :: krcv, ksnd ! Number of received and sent coupling fields |
---|
[4990] | 141 | INTEGER, INTENT(in) :: kcplmodel ! Maximum number of models to/from which NEMO is potentialy sending/receiving data |
---|
[1226] | 142 | ! |
---|
[2715] | 143 | INTEGER :: id_part |
---|
| 144 | INTEGER :: paral(5) ! OASIS3 box partition |
---|
[10404] | 145 | INTEGER :: ishape(4) ! shape of arrays passed to PSMILe |
---|
[4990] | 146 | INTEGER :: ji,jc,jm ! local loop indicees |
---|
| 147 | CHARACTER(LEN=64) :: zclname |
---|
| 148 | CHARACTER(LEN=2) :: cli2 |
---|
[532] | 149 | !!-------------------------------------------------------------------- |
---|
[1218] | 150 | |
---|
[10112] | 151 | ! patch to restore wraparound rows in cpl_send, cpl_rcv, cpl_define |
---|
| 152 | IF ( ltmp_wapatch ) THEN |
---|
| 153 | nldi_save = nldi ; nlei_save = nlei |
---|
| 154 | nldj_save = nldj ; nlej_save = nlej |
---|
| 155 | IF( nimpp == 1 ) nldi = 1 |
---|
| 156 | IF( nimpp + jpi - 1 == jpiglo ) nlei = jpi |
---|
| 157 | IF( njmpp == 1 ) nldj = 1 |
---|
| 158 | IF( njmpp + jpj - 1 == jpjglo ) nlej = jpj |
---|
| 159 | ENDIF |
---|
[532] | 160 | IF(lwp) WRITE(numout,*) |
---|
[4990] | 161 | IF(lwp) WRITE(numout,*) 'cpl_define : initialization in coupled ocean/atmosphere case' |
---|
[532] | 162 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~~~~' |
---|
| 163 | IF(lwp) WRITE(numout,*) |
---|
| 164 | |
---|
[5407] | 165 | ncplmodel = kcplmodel |
---|
[4990] | 166 | IF( kcplmodel > nmaxcpl ) THEN |
---|
[5407] | 167 | CALL oasis_abort ( ncomp_id, 'cpl_define', 'ncplmodel is larger than nmaxcpl, increase nmaxcpl') ; RETURN |
---|
[4990] | 168 | ENDIF |
---|
[5407] | 169 | |
---|
| 170 | nrcv = krcv |
---|
| 171 | IF( nrcv > nmaxfld ) THEN |
---|
| 172 | CALL oasis_abort ( ncomp_id, 'cpl_define', 'nrcv is larger than nmaxfld, increase nmaxfld') ; RETURN |
---|
| 173 | ENDIF |
---|
| 174 | |
---|
| 175 | nsnd = ksnd |
---|
| 176 | IF( nsnd > nmaxfld ) THEN |
---|
| 177 | CALL oasis_abort ( ncomp_id, 'cpl_define', 'nsnd is larger than nmaxfld, increase nmaxfld') ; RETURN |
---|
| 178 | ENDIF |
---|
[532] | 179 | ! |
---|
| 180 | ! ... Define the shape for the area that excludes the halo |
---|
| 181 | ! For serial configuration (key_mpp_mpi not being active) |
---|
| 182 | ! nl* is set to the global values 1 and jp*glo. |
---|
| 183 | ! |
---|
[10404] | 184 | ishape(1) = 1 |
---|
| 185 | ishape(2) = nlei-nldi+1 |
---|
| 186 | ishape(3) = 1 |
---|
| 187 | ishape(4) = nlej-nldj+1 |
---|
[532] | 188 | ! |
---|
| 189 | ! ... Allocate memory for data exchange |
---|
| 190 | ! |
---|
[1218] | 191 | ALLOCATE(exfld(nlei-nldi+1, nlej-nldj+1), stat = nerror) |
---|
[2715] | 192 | IF( nerror > 0 ) THEN |
---|
[4990] | 193 | CALL oasis_abort ( ncomp_id, 'cpl_define', 'Failure in allocating exfld') ; RETURN |
---|
[532] | 194 | ENDIF |
---|
| 195 | ! |
---|
[1218] | 196 | ! ----------------------------------------------------------------- |
---|
| 197 | ! ... Define the partition |
---|
| 198 | ! ----------------------------------------------------------------- |
---|
| 199 | |
---|
| 200 | paral(1) = 2 ! box partitioning |
---|
| 201 | paral(2) = jpiglo * (nldj-1+njmpp-1) + (nldi-1+nimpp-1) ! NEMO lower left corner global offset |
---|
| 202 | paral(3) = nlei-nldi+1 ! local extent in i |
---|
| 203 | paral(4) = nlej-nldj+1 ! local extent in j |
---|
| 204 | paral(5) = jpiglo ! global extent in x |
---|
| 205 | |
---|
| 206 | IF( ln_ctl ) THEN |
---|
| 207 | WRITE(numout,*) ' multiexchg: paral (1:5)', paral |
---|
| 208 | WRITE(numout,*) ' multiexchg: jpi, jpj =', jpi, jpj |
---|
| 209 | WRITE(numout,*) ' multiexchg: nldi, nlei, nimpp =', nldi, nlei, nimpp |
---|
| 210 | WRITE(numout,*) ' multiexchg: nldj, nlej, njmpp =', nldj, nlej, njmpp |
---|
| 211 | ENDIF |
---|
[7848] | 212 | |
---|
| 213 | CALL oasis_def_partition ( id_part, paral, nerror, jpiglo*jpjglo ) |
---|
[532] | 214 | ! |
---|
[1218] | 215 | ! ... Announce send variables. |
---|
[532] | 216 | ! |
---|
[4990] | 217 | ssnd(:)%ncplmodel = kcplmodel |
---|
| 218 | ! |
---|
[1226] | 219 | DO ji = 1, ksnd |
---|
[4990] | 220 | IF ( ssnd(ji)%laction ) THEN |
---|
| 221 | |
---|
| 222 | IF( ssnd(ji)%nct > nmaxcat ) THEN |
---|
| 223 | CALL oasis_abort ( ncomp_id, 'cpl_define', 'Number of categories of '// & |
---|
| 224 | & TRIM(ssnd(ji)%clname)//' is larger than nmaxcat, increase nmaxcat' ) |
---|
| 225 | RETURN |
---|
| 226 | ENDIF |
---|
| 227 | |
---|
[3294] | 228 | DO jc = 1, ssnd(ji)%nct |
---|
[4990] | 229 | DO jm = 1, kcplmodel |
---|
| 230 | |
---|
| 231 | IF ( ssnd(ji)%nct .GT. 1 ) THEN |
---|
| 232 | WRITE(cli2,'(i2.2)') jc |
---|
| 233 | zclname = TRIM(ssnd(ji)%clname)//'_cat'//cli2 |
---|
| 234 | ELSE |
---|
| 235 | zclname = ssnd(ji)%clname |
---|
| 236 | ENDIF |
---|
| 237 | IF ( kcplmodel > 1 ) THEN |
---|
| 238 | WRITE(cli2,'(i2.2)') jm |
---|
| 239 | zclname = 'model'//cli2//'_'//TRIM(zclname) |
---|
| 240 | ENDIF |
---|
| 241 | #if defined key_agrif |
---|
| 242 | IF( agrif_fixed() /= 0 ) THEN |
---|
| 243 | zclname=TRIM(Agrif_CFixed())//'_'//TRIM(zclname) |
---|
| 244 | END IF |
---|
| 245 | #endif |
---|
| 246 | IF( ln_ctl ) WRITE(numout,*) "Define", ji, jc, jm, " "//TRIM(zclname), " for ", OASIS_Out |
---|
[10404] | 247 | CALL oasis_def_var (ssnd(ji)%nid(jc,jm), zclname, id_part , (/ 2, 1 /), & |
---|
[4990] | 248 | & OASIS_Out , ishape , OASIS_REAL, nerror ) |
---|
| 249 | IF ( nerror /= OASIS_Ok ) THEN |
---|
| 250 | WRITE(numout,*) 'Failed to define transient ', ji, jc, jm, " "//TRIM(zclname) |
---|
| 251 | CALL oasis_abort ( ssnd(ji)%nid(jc,jm), 'cpl_define', 'Failure in oasis_def_var' ) |
---|
| 252 | ENDIF |
---|
| 253 | IF( ln_ctl .AND. ssnd(ji)%nid(jc,jm) /= -1 ) WRITE(numout,*) "variable defined in the namcouple" |
---|
| 254 | IF( ln_ctl .AND. ssnd(ji)%nid(jc,jm) == -1 ) WRITE(numout,*) "variable NOT defined in the namcouple" |
---|
| 255 | END DO |
---|
[3294] | 256 | END DO |
---|
[1218] | 257 | ENDIF |
---|
| 258 | END DO |
---|
| 259 | ! |
---|
| 260 | ! ... Announce received variables. |
---|
| 261 | ! |
---|
[4990] | 262 | srcv(:)%ncplmodel = kcplmodel |
---|
| 263 | ! |
---|
[1226] | 264 | DO ji = 1, krcv |
---|
[1218] | 265 | IF ( srcv(ji)%laction ) THEN |
---|
[4990] | 266 | |
---|
| 267 | IF( srcv(ji)%nct > nmaxcat ) THEN |
---|
| 268 | CALL oasis_abort ( ncomp_id, 'cpl_define', 'Number of categories of '// & |
---|
| 269 | & TRIM(srcv(ji)%clname)//' is larger than nmaxcat, increase nmaxcat' ) |
---|
| 270 | RETURN |
---|
| 271 | ENDIF |
---|
| 272 | |
---|
[3294] | 273 | DO jc = 1, srcv(ji)%nct |
---|
[4990] | 274 | DO jm = 1, kcplmodel |
---|
| 275 | |
---|
| 276 | IF ( srcv(ji)%nct .GT. 1 ) THEN |
---|
| 277 | WRITE(cli2,'(i2.2)') jc |
---|
| 278 | zclname = TRIM(srcv(ji)%clname)//'_cat'//cli2 |
---|
| 279 | ELSE |
---|
| 280 | zclname = srcv(ji)%clname |
---|
| 281 | ENDIF |
---|
| 282 | IF ( kcplmodel > 1 ) THEN |
---|
| 283 | WRITE(cli2,'(i2.2)') jm |
---|
| 284 | zclname = 'model'//cli2//'_'//TRIM(zclname) |
---|
| 285 | ENDIF |
---|
| 286 | #if defined key_agrif |
---|
| 287 | IF( agrif_fixed() /= 0 ) THEN |
---|
| 288 | zclname=TRIM(Agrif_CFixed())//'_'//TRIM(zclname) |
---|
| 289 | END IF |
---|
| 290 | #endif |
---|
| 291 | IF( ln_ctl ) WRITE(numout,*) "Define", ji, jc, jm, " "//TRIM(zclname), " for ", OASIS_In |
---|
[10404] | 292 | CALL oasis_def_var (srcv(ji)%nid(jc,jm), zclname, id_part , (/ 2, 1 /), & |
---|
[4990] | 293 | & OASIS_In , ishape , OASIS_REAL, nerror ) |
---|
| 294 | IF ( nerror /= OASIS_Ok ) THEN |
---|
| 295 | WRITE(numout,*) 'Failed to define transient ', ji, jc, jm, " "//TRIM(zclname) |
---|
| 296 | CALL oasis_abort ( srcv(ji)%nid(jc,jm), 'cpl_define', 'Failure in oasis_def_var' ) |
---|
| 297 | ENDIF |
---|
| 298 | IF( ln_ctl .AND. srcv(ji)%nid(jc,jm) /= -1 ) WRITE(numout,*) "variable defined in the namcouple" |
---|
| 299 | IF( ln_ctl .AND. srcv(ji)%nid(jc,jm) == -1 ) WRITE(numout,*) "variable NOT defined in the namcouple" |
---|
| 300 | |
---|
| 301 | END DO |
---|
[3294] | 302 | END DO |
---|
[1218] | 303 | ENDIF |
---|
| 304 | END DO |
---|
| 305 | |
---|
[532] | 306 | !------------------------------------------------------------------ |
---|
[1218] | 307 | ! End of definition phase |
---|
[532] | 308 | !------------------------------------------------------------------ |
---|
[1218] | 309 | |
---|
[4990] | 310 | CALL oasis_enddef(nerror) |
---|
| 311 | IF( nerror /= OASIS_Ok ) CALL oasis_abort ( ncomp_id, 'cpl_define', 'Failure in oasis_enddef') |
---|
[2715] | 312 | ! |
---|
[10112] | 313 | IF ( ltmp_wapatch ) THEN |
---|
| 314 | nldi = nldi_save ; nlei = nlei_save |
---|
| 315 | nldj = nldj_save ; nlej = nlej_save |
---|
| 316 | ENDIF |
---|
[4990] | 317 | END SUBROUTINE cpl_define |
---|
[1218] | 318 | |
---|
| 319 | |
---|
[4990] | 320 | SUBROUTINE cpl_snd( kid, kstep, pdata, kinfo ) |
---|
[532] | 321 | !!--------------------------------------------------------------------- |
---|
[4990] | 322 | !! *** ROUTINE cpl_snd *** |
---|
[532] | 323 | !! |
---|
| 324 | !! ** Purpose : - At each coupling time-step,this routine sends fields |
---|
| 325 | !! like sst or ice cover to the coupler or remote application. |
---|
| 326 | !!---------------------------------------------------------------------- |
---|
[3294] | 327 | INTEGER , INTENT(in ) :: kid ! variable index in the array |
---|
| 328 | INTEGER , INTENT( out) :: kinfo ! OASIS3 info argument |
---|
| 329 | INTEGER , INTENT(in ) :: kstep ! ocean time-step in seconds |
---|
| 330 | REAL(wp), DIMENSION(:,:,:), INTENT(in ) :: pdata |
---|
| 331 | !! |
---|
[4990] | 332 | INTEGER :: jc,jm ! local loop index |
---|
[532] | 333 | !!-------------------------------------------------------------------- |
---|
[10112] | 334 | ! patch to restore wraparound rows in cpl_send, cpl_rcv, cpl_define |
---|
| 335 | IF ( ltmp_wapatch ) THEN |
---|
| 336 | nldi_save = nldi ; nlei_save = nlei |
---|
| 337 | nldj_save = nldj ; nlej_save = nlej |
---|
| 338 | IF( nimpp == 1 ) nldi = 1 |
---|
| 339 | IF( nimpp + jpi - 1 == jpiglo ) nlei = jpi |
---|
| 340 | IF( njmpp == 1 ) nldj = 1 |
---|
| 341 | IF( njmpp + jpj - 1 == jpjglo ) nlej = jpj |
---|
| 342 | ENDIF |
---|
[532] | 343 | ! |
---|
[1218] | 344 | ! snd data to OASIS3 |
---|
[532] | 345 | ! |
---|
[3294] | 346 | DO jc = 1, ssnd(kid)%nct |
---|
[4990] | 347 | DO jm = 1, ssnd(kid)%ncplmodel |
---|
| 348 | |
---|
| 349 | IF( ssnd(kid)%nid(jc,jm) /= -1 ) THEN |
---|
| 350 | CALL oasis_put ( ssnd(kid)%nid(jc,jm), kstep, pdata(nldi:nlei, nldj:nlej,jc), kinfo ) |
---|
| 351 | |
---|
| 352 | IF ( ln_ctl ) THEN |
---|
| 353 | IF ( kinfo == OASIS_Sent .OR. kinfo == OASIS_ToRest .OR. & |
---|
| 354 | & kinfo == OASIS_SentOut .OR. kinfo == OASIS_ToRestOut ) THEN |
---|
| 355 | WRITE(numout,*) '****************' |
---|
| 356 | WRITE(numout,*) 'oasis_put: Outgoing ', ssnd(kid)%clname |
---|
| 357 | WRITE(numout,*) 'oasis_put: ivarid ', ssnd(kid)%nid(jc,jm) |
---|
| 358 | WRITE(numout,*) 'oasis_put: kstep ', kstep |
---|
| 359 | WRITE(numout,*) 'oasis_put: info ', kinfo |
---|
| 360 | WRITE(numout,*) ' - Minimum value is ', MINVAL(pdata(:,:,jc)) |
---|
| 361 | WRITE(numout,*) ' - Maximum value is ', MAXVAL(pdata(:,:,jc)) |
---|
| 362 | WRITE(numout,*) ' - Sum value is ', SUM(pdata(:,:,jc)) |
---|
| 363 | WRITE(numout,*) '****************' |
---|
| 364 | ENDIF |
---|
| 365 | ENDIF |
---|
| 366 | |
---|
[3294] | 367 | ENDIF |
---|
[4990] | 368 | |
---|
| 369 | ENDDO |
---|
[3294] | 370 | ENDDO |
---|
[10112] | 371 | IF ( ltmp_wapatch ) THEN |
---|
| 372 | nldi = nldi_save ; nlei = nlei_save |
---|
| 373 | nldj = nldj_save ; nlej = nlej_save |
---|
| 374 | ENDIF |
---|
[2715] | 375 | ! |
---|
[4990] | 376 | END SUBROUTINE cpl_snd |
---|
[532] | 377 | |
---|
| 378 | |
---|
[4990] | 379 | SUBROUTINE cpl_rcv( kid, kstep, pdata, pmask, kinfo ) |
---|
[532] | 380 | !!--------------------------------------------------------------------- |
---|
[4990] | 381 | !! *** ROUTINE cpl_rcv *** |
---|
[532] | 382 | !! |
---|
| 383 | !! ** Purpose : - At each coupling time-step,this routine receives fields |
---|
| 384 | !! like stresses and fluxes from the coupler or remote application. |
---|
| 385 | !!---------------------------------------------------------------------- |
---|
[3294] | 386 | INTEGER , INTENT(in ) :: kid ! variable index in the array |
---|
| 387 | INTEGER , INTENT(in ) :: kstep ! ocean time-step in seconds |
---|
| 388 | REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: pdata ! IN to keep the value if nothing is done |
---|
[4990] | 389 | REAL(wp), DIMENSION(:,:,:), INTENT(in ) :: pmask ! coupling mask |
---|
[3294] | 390 | INTEGER , INTENT( out) :: kinfo ! OASIS3 info argument |
---|
[532] | 391 | !! |
---|
[4990] | 392 | INTEGER :: jc,jm ! local loop index |
---|
| 393 | LOGICAL :: llaction, llfisrt |
---|
[1218] | 394 | !!-------------------------------------------------------------------- |
---|
[10112] | 395 | ! patch to restore wraparound rows in cpl_send, cpl_rcv, cpl_define |
---|
| 396 | IF ( ltmp_wapatch ) THEN |
---|
| 397 | nldi_save = nldi ; nlei_save = nlei |
---|
| 398 | nldj_save = nldj ; nlej_save = nlej |
---|
| 399 | ENDIF |
---|
[532] | 400 | ! |
---|
[1218] | 401 | ! receive local data from OASIS3 on every process |
---|
| 402 | ! |
---|
[4990] | 403 | kinfo = OASIS_idle |
---|
| 404 | ! |
---|
[3294] | 405 | DO jc = 1, srcv(kid)%nct |
---|
[10112] | 406 | IF ( ltmp_wapatch ) THEN |
---|
| 407 | IF( nimpp == 1 ) nldi = 1 |
---|
| 408 | IF( nimpp + jpi - 1 == jpiglo ) nlei = jpi |
---|
| 409 | IF( njmpp == 1 ) nldj = 1 |
---|
| 410 | IF( njmpp + jpj - 1 == jpjglo ) nlej = jpj |
---|
| 411 | ENDIF |
---|
[4990] | 412 | llfisrt = .TRUE. |
---|
[532] | 413 | |
---|
[4990] | 414 | DO jm = 1, srcv(kid)%ncplmodel |
---|
| 415 | |
---|
| 416 | IF( srcv(kid)%nid(jc,jm) /= -1 ) THEN |
---|
| 417 | |
---|
| 418 | CALL oasis_get ( srcv(kid)%nid(jc,jm), kstep, exfld, kinfo ) |
---|
| 419 | |
---|
| 420 | llaction = kinfo == OASIS_Recvd .OR. kinfo == OASIS_FromRest .OR. & |
---|
| 421 | & kinfo == OASIS_RecvOut .OR. kinfo == OASIS_FromRestOut |
---|
| 422 | |
---|
| 423 | IF ( ln_ctl ) WRITE(numout,*) "llaction, kinfo, kstep, ivarid: " , llaction, kinfo, kstep, srcv(kid)%nid(jc,jm) |
---|
| 424 | |
---|
| 425 | IF ( llaction ) THEN |
---|
| 426 | |
---|
| 427 | kinfo = OASIS_Rcv |
---|
| 428 | IF( llfisrt ) THEN |
---|
| 429 | pdata(nldi:nlei,nldj:nlej,jc) = exfld(:,:) * pmask(nldi:nlei,nldj:nlej,jm) |
---|
| 430 | llfisrt = .FALSE. |
---|
| 431 | ELSE |
---|
| 432 | pdata(nldi:nlei,nldj:nlej,jc) = pdata(nldi:nlei,nldj:nlej,jc) + exfld(:,:) * pmask(nldi:nlei,nldj:nlej,jm) |
---|
| 433 | ENDIF |
---|
| 434 | |
---|
| 435 | IF ( ln_ctl ) THEN |
---|
| 436 | WRITE(numout,*) '****************' |
---|
| 437 | WRITE(numout,*) 'oasis_get: Incoming ', srcv(kid)%clname |
---|
| 438 | WRITE(numout,*) 'oasis_get: ivarid ' , srcv(kid)%nid(jc,jm) |
---|
| 439 | WRITE(numout,*) 'oasis_get: kstep', kstep |
---|
| 440 | WRITE(numout,*) 'oasis_get: info ', kinfo |
---|
| 441 | WRITE(numout,*) ' - Minimum value is ', MINVAL(pdata(:,:,jc)) |
---|
| 442 | WRITE(numout,*) ' - Maximum value is ', MAXVAL(pdata(:,:,jc)) |
---|
| 443 | WRITE(numout,*) ' - Sum value is ', SUM(pdata(:,:,jc)) |
---|
| 444 | WRITE(numout,*) '****************' |
---|
[11105] | 445 | CALL FLUSH(numout) |
---|
[4990] | 446 | ENDIF |
---|
| 447 | |
---|
| 448 | ENDIF |
---|
| 449 | |
---|
| 450 | ENDIF |
---|
[3294] | 451 | |
---|
[4990] | 452 | ENDDO |
---|
[4806] | 453 | |
---|
[10112] | 454 | IF ( ltmp_wapatch ) THEN |
---|
| 455 | nldi = nldi_save ; nlei = nlei_save |
---|
| 456 | nldj = nldj_save ; nlej = nlej_save |
---|
| 457 | ENDIF |
---|
[4990] | 458 | !--- Fill the overlap areas and extra hallows (mpp) |
---|
| 459 | !--- check periodicity conditions (all cases) |
---|
[10425] | 460 | IF( .not. llfisrt ) THEN |
---|
| 461 | CALL lbc_lnk( 'cpl_oasis3', pdata(:,:,jc), srcv(kid)%clgrid, srcv(kid)%nsgn ) |
---|
| 462 | ENDIF |
---|
[4990] | 463 | |
---|
[3294] | 464 | ENDDO |
---|
[2715] | 465 | ! |
---|
[4990] | 466 | END SUBROUTINE cpl_rcv |
---|
[532] | 467 | |
---|
| 468 | |
---|
[5407] | 469 | INTEGER FUNCTION cpl_freq( cdfieldname ) |
---|
[2528] | 470 | !!--------------------------------------------------------------------- |
---|
[4990] | 471 | !! *** ROUTINE cpl_freq *** |
---|
[2528] | 472 | !! |
---|
| 473 | !! ** Purpose : - send back the coupling frequency for a particular field |
---|
| 474 | !!---------------------------------------------------------------------- |
---|
[5407] | 475 | CHARACTER(len = *), INTENT(in) :: cdfieldname ! field name as set in namcouple file |
---|
[4990] | 476 | !! |
---|
[5407] | 477 | INTEGER :: id |
---|
[4990] | 478 | INTEGER :: info |
---|
| 479 | INTEGER, DIMENSION(1) :: itmp |
---|
[5407] | 480 | INTEGER :: ji,jm ! local loop index |
---|
| 481 | INTEGER :: mop |
---|
[2715] | 482 | !!---------------------------------------------------------------------- |
---|
[5407] | 483 | cpl_freq = 0 ! defaut definition |
---|
| 484 | id = -1 ! defaut definition |
---|
[2715] | 485 | ! |
---|
[5407] | 486 | DO ji = 1, nsnd |
---|
| 487 | IF (ssnd(ji)%laction ) THEN |
---|
| 488 | DO jm = 1, ncplmodel |
---|
| 489 | IF( ssnd(ji)%nid(1,jm) /= -1 ) THEN |
---|
| 490 | IF( TRIM(cdfieldname) == TRIM(ssnd(ji)%clname) ) THEN |
---|
| 491 | id = ssnd(ji)%nid(1,jm) |
---|
| 492 | mop = OASIS_Out |
---|
| 493 | ENDIF |
---|
| 494 | ENDIF |
---|
| 495 | ENDDO |
---|
| 496 | ENDIF |
---|
| 497 | ENDDO |
---|
| 498 | DO ji = 1, nrcv |
---|
| 499 | IF (srcv(ji)%laction ) THEN |
---|
| 500 | DO jm = 1, ncplmodel |
---|
| 501 | IF( srcv(ji)%nid(1,jm) /= -1 ) THEN |
---|
| 502 | IF( TRIM(cdfieldname) == TRIM(srcv(ji)%clname) ) THEN |
---|
| 503 | id = srcv(ji)%nid(1,jm) |
---|
| 504 | mop = OASIS_In |
---|
| 505 | ENDIF |
---|
| 506 | ENDIF |
---|
| 507 | ENDDO |
---|
| 508 | ENDIF |
---|
| 509 | ENDDO |
---|
| 510 | ! |
---|
| 511 | IF( id /= -1 ) THEN |
---|
[10577] | 512 | #if ! defined key_oa3mct_v1v2 |
---|
[5407] | 513 | CALL oasis_get_freqs(id, mop, 1, itmp, info) |
---|
| 514 | #else |
---|
[11446] | 515 | CALL oasis_get_freqs(id, 1, itmp, info) |
---|
[5407] | 516 | #endif |
---|
[11446] | 517 | cpl_freq = itmp(1) |
---|
[5407] | 518 | ENDIF |
---|
| 519 | ! |
---|
[4990] | 520 | END FUNCTION cpl_freq |
---|
[2528] | 521 | |
---|
| 522 | |
---|
[4990] | 523 | SUBROUTINE cpl_finalize |
---|
[532] | 524 | !!--------------------------------------------------------------------- |
---|
[4990] | 525 | !! *** ROUTINE cpl_finalize *** |
---|
[532] | 526 | !! |
---|
| 527 | !! ** Purpose : - Finalizes the coupling. If MPI_init has not been |
---|
[4990] | 528 | !! called explicitly before cpl_init it will also close |
---|
[532] | 529 | !! MPI communication. |
---|
| 530 | !!---------------------------------------------------------------------- |
---|
[2715] | 531 | ! |
---|
| 532 | DEALLOCATE( exfld ) |
---|
[4990] | 533 | IF (nstop == 0) THEN |
---|
| 534 | CALL oasis_terminate( nerror ) |
---|
| 535 | ELSE |
---|
| 536 | CALL oasis_abort( ncomp_id, "cpl_finalize", "NEMO ABORT STOP" ) |
---|
| 537 | ENDIF |
---|
[2715] | 538 | ! |
---|
[4990] | 539 | END SUBROUTINE cpl_finalize |
---|
[532] | 540 | |
---|
[4990] | 541 | #if ! defined key_oasis3 |
---|
| 542 | |
---|
[1218] | 543 | !!---------------------------------------------------------------------- |
---|
[4990] | 544 | !! No OASIS Library OASIS3 Dummy module... |
---|
[1218] | 545 | !!---------------------------------------------------------------------- |
---|
[4990] | 546 | |
---|
| 547 | SUBROUTINE oasis_init_comp(k1,cd1,k2) |
---|
| 548 | CHARACTER(*), INTENT(in ) :: cd1 |
---|
| 549 | INTEGER , INTENT( out) :: k1,k2 |
---|
| 550 | k1 = -1 ; k2 = -1 |
---|
| 551 | WRITE(numout,*) 'oasis_init_comp: Error you sould not be there...', cd1 |
---|
| 552 | END SUBROUTINE oasis_init_comp |
---|
| 553 | |
---|
| 554 | SUBROUTINE oasis_abort(k1,cd1,cd2) |
---|
| 555 | INTEGER , INTENT(in ) :: k1 |
---|
| 556 | CHARACTER(*), INTENT(in ) :: cd1,cd2 |
---|
| 557 | WRITE(numout,*) 'oasis_abort: Error you sould not be there...', cd1, cd2 |
---|
| 558 | END SUBROUTINE oasis_abort |
---|
| 559 | |
---|
| 560 | SUBROUTINE oasis_get_localcomm(k1,k2) |
---|
| 561 | INTEGER , INTENT( out) :: k1,k2 |
---|
| 562 | k1 = -1 ; k2 = -1 |
---|
| 563 | WRITE(numout,*) 'oasis_get_localcomm: Error you sould not be there...' |
---|
| 564 | END SUBROUTINE oasis_get_localcomm |
---|
| 565 | |
---|
[7851] | 566 | SUBROUTINE oasis_def_partition(k1,k2,k3,k4) |
---|
[4990] | 567 | INTEGER , INTENT( out) :: k1,k3 |
---|
| 568 | INTEGER , INTENT(in ) :: k2(5) |
---|
[7851] | 569 | INTEGER , INTENT(in ) :: k4 |
---|
| 570 | k1 = k2(1) ; k3 = k2(5)+k4 |
---|
[4990] | 571 | WRITE(numout,*) 'oasis_def_partition: Error you sould not be there...' |
---|
| 572 | END SUBROUTINE oasis_def_partition |
---|
| 573 | |
---|
| 574 | SUBROUTINE oasis_def_var(k1,cd1,k2,k3,k4,k5,k6,k7) |
---|
| 575 | CHARACTER(*), INTENT(in ) :: cd1 |
---|
| 576 | INTEGER , INTENT(in ) :: k2,k3(2),k4,k5(2,2),k6 |
---|
| 577 | INTEGER , INTENT( out) :: k1,k7 |
---|
| 578 | k1 = -1 ; k7 = -1 |
---|
| 579 | WRITE(numout,*) 'oasis_def_var: Error you sould not be there...', cd1 |
---|
| 580 | END SUBROUTINE oasis_def_var |
---|
| 581 | |
---|
| 582 | SUBROUTINE oasis_enddef(k1) |
---|
| 583 | INTEGER , INTENT( out) :: k1 |
---|
| 584 | k1 = -1 |
---|
| 585 | WRITE(numout,*) 'oasis_enddef: Error you sould not be there...' |
---|
| 586 | END SUBROUTINE oasis_enddef |
---|
| 587 | |
---|
| 588 | SUBROUTINE oasis_put(k1,k2,p1,k3) |
---|
| 589 | REAL(wp), DIMENSION(:,:), INTENT(in ) :: p1 |
---|
| 590 | INTEGER , INTENT(in ) :: k1,k2 |
---|
| 591 | INTEGER , INTENT( out) :: k3 |
---|
| 592 | k3 = -1 |
---|
| 593 | WRITE(numout,*) 'oasis_put: Error you sould not be there...' |
---|
| 594 | END SUBROUTINE oasis_put |
---|
| 595 | |
---|
| 596 | SUBROUTINE oasis_get(k1,k2,p1,k3) |
---|
| 597 | REAL(wp), DIMENSION(:,:), INTENT( out) :: p1 |
---|
| 598 | INTEGER , INTENT(in ) :: k1,k2 |
---|
| 599 | INTEGER , INTENT( out) :: k3 |
---|
| 600 | p1(1,1) = -1. ; k3 = -1 |
---|
| 601 | WRITE(numout,*) 'oasis_get: Error you sould not be there...' |
---|
| 602 | END SUBROUTINE oasis_get |
---|
| 603 | |
---|
[10582] | 604 | SUBROUTINE oasis_get_freqs(k1,k5,k2,k3,k4) |
---|
[4990] | 605 | INTEGER , INTENT(in ) :: k1,k2 |
---|
| 606 | INTEGER, DIMENSION(1), INTENT( out) :: k3 |
---|
[10582] | 607 | INTEGER , INTENT( out) :: k4,k5 |
---|
| 608 | k3(1) = k1 ; k4 = k2 ; k5 = k2 |
---|
[4990] | 609 | WRITE(numout,*) 'oasis_get_freqs: Error you sould not be there...' |
---|
| 610 | END SUBROUTINE oasis_get_freqs |
---|
| 611 | |
---|
| 612 | SUBROUTINE oasis_terminate(k1) |
---|
| 613 | INTEGER , INTENT( out) :: k1 |
---|
| 614 | k1 = -1 |
---|
| 615 | WRITE(numout,*) 'oasis_terminate: Error you sould not be there...' |
---|
| 616 | END SUBROUTINE oasis_terminate |
---|
| 617 | |
---|
[532] | 618 | #endif |
---|
| 619 | |
---|
[2715] | 620 | !!===================================================================== |
---|
[532] | 621 | END MODULE cpl_oasis3 |
---|