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