[3] | 1 | MODULE solmat |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE solmat *** |
---|
| 4 | !! solver : construction of the matrix |
---|
| 5 | !!====================================================================== |
---|
[1601] | 6 | !! History : 1.0 ! 1988-04 (G. Madec) Original code |
---|
| 7 | !! ! 1993-03 (M. Guyon) symetrical conditions |
---|
| 8 | !! ! 1993-06 (M. Guyon) suppress pointers |
---|
| 9 | !! ! 1996-05 (G. Madec) merge sor and pcg formulations |
---|
| 10 | !! ! 1996-11 (A. Weaver) correction to preconditioning |
---|
| 11 | !! NEMO 1.0 ! 1902-08 (G. Madec) F90: Free form |
---|
| 12 | !! - ! 1902-11 (C. Talandier, A-M. Treguier) Free surface & Open boundaries |
---|
| 13 | !! 2.0 ! 2005-09 (R. Benshila) add sol_exd for extra outer halo |
---|
| 14 | !! - ! 2005-11 (V. Garnier) Surface pressure gradient organization |
---|
| 15 | !! 3.2 ! 2009-06 (S. Masson) distributed restart using iom |
---|
| 16 | !! - ! 2009-07 (R. Benshila) suppression of rigid-lid option |
---|
[508] | 17 | !!---------------------------------------------------------------------- |
---|
[3] | 18 | |
---|
| 19 | !!---------------------------------------------------------------------- |
---|
[1601] | 20 | !! sol_mat : Construction of the matrix of used by the elliptic solvers |
---|
| 21 | !! sol_exd : |
---|
[3] | 22 | !!---------------------------------------------------------------------- |
---|
| 23 | USE oce ! ocean dynamics and active tracers |
---|
| 24 | USE dom_oce ! ocean space and time domain |
---|
| 25 | USE sol_oce ! ocean solver |
---|
| 26 | USE phycst ! physical constants |
---|
| 27 | USE obc_oce ! ocean open boundary conditions |
---|
[312] | 28 | USE lbclnk ! lateral boudary conditions |
---|
[3] | 29 | USE lib_mpp ! distributed memory computing |
---|
[413] | 30 | USE in_out_manager ! I/O manager |
---|
[3] | 31 | |
---|
| 32 | IMPLICIT NONE |
---|
| 33 | PRIVATE |
---|
| 34 | |
---|
[1601] | 35 | PUBLIC sol_mat ! routine called by inisol.F90 |
---|
| 36 | |
---|
[3] | 37 | !!---------------------------------------------------------------------- |
---|
[1601] | 38 | !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009) |
---|
[1152] | 39 | !! $Id$ |
---|
[508] | 40 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
---|
[3] | 41 | !!---------------------------------------------------------------------- |
---|
| 42 | |
---|
| 43 | CONTAINS |
---|
| 44 | |
---|
[413] | 45 | SUBROUTINE sol_mat( kt ) |
---|
[3] | 46 | !!---------------------------------------------------------------------- |
---|
| 47 | !! *** ROUTINE sol_mat *** |
---|
| 48 | !! |
---|
| 49 | !! ** Purpose : Construction of the matrix of used by the elliptic |
---|
[1601] | 50 | !! solvers (either sor or pcg methods). |
---|
[3] | 51 | !! |
---|
[1601] | 52 | !! ** Method : The matrix is built for the divergence of the transport |
---|
| 53 | !! system. a diagonal preconditioning matrix is also defined. |
---|
[3] | 54 | !! |
---|
| 55 | !! ** Action : - gcp : extra-diagonal elements of the matrix |
---|
| 56 | !! - gcdmat : preconditioning matrix (diagonal elements) |
---|
| 57 | !! - gcdprc : inverse of the preconditioning matrix |
---|
| 58 | !!---------------------------------------------------------------------- |
---|
[413] | 59 | INTEGER, INTENT(in) :: kt |
---|
[1601] | 60 | !! |
---|
[3] | 61 | INTEGER :: ji, jj ! dummy loop indices |
---|
| 62 | REAL(wp) :: zcoefs, zcoefw, zcoefe, zcoefn ! temporary scalars |
---|
[16] | 63 | REAL(wp) :: z2dt, zcoef |
---|
[3] | 64 | !!---------------------------------------------------------------------- |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | ! 1. Construction of the matrix |
---|
| 68 | ! ----------------------------- |
---|
[1601] | 69 | zcoef = 0.e0 ! initialize to zero |
---|
[3] | 70 | gcp(:,:,1) = 0.e0 |
---|
| 71 | gcp(:,:,2) = 0.e0 |
---|
| 72 | gcp(:,:,3) = 0.e0 |
---|
| 73 | gcp(:,:,4) = 0.e0 |
---|
[1601] | 74 | ! |
---|
[3] | 75 | gcdprc(:,:) = 0.e0 |
---|
| 76 | gcdmat(:,:) = 0.e0 |
---|
[1601] | 77 | ! |
---|
| 78 | IF( neuler == 0 .AND. kt == nit000 ) THEN ; z2dt = rdt |
---|
| 79 | ELSE ; z2dt = 2. * rdt |
---|
[413] | 80 | ENDIF |
---|
[3] | 81 | |
---|
[359] | 82 | #if defined key_dynspg_flt && ! defined key_obc |
---|
[3] | 83 | |
---|
[1601] | 84 | DO jj = 2, jpjm1 ! matrix of free surface elliptic system |
---|
[3] | 85 | DO ji = 2, jpim1 |
---|
[1601] | 86 | zcoef = z2dt * z2dt * grav * bmask(ji,jj) |
---|
[3] | 87 | zcoefs = -zcoef * hv(ji ,jj-1) * e1v(ji ,jj-1) / e2v(ji ,jj-1) ! south coefficient |
---|
| 88 | zcoefw = -zcoef * hu(ji-1,jj ) * e2u(ji-1,jj ) / e1u(ji-1,jj ) ! west coefficient |
---|
| 89 | zcoefe = -zcoef * hu(ji ,jj ) * e2u(ji ,jj ) / e1u(ji ,jj ) ! east coefficient |
---|
| 90 | zcoefn = -zcoef * hv(ji ,jj ) * e1v(ji ,jj ) / e2v(ji ,jj ) ! north coefficient |
---|
| 91 | gcp(ji,jj,1) = zcoefs |
---|
| 92 | gcp(ji,jj,2) = zcoefw |
---|
| 93 | gcp(ji,jj,3) = zcoefe |
---|
| 94 | gcp(ji,jj,4) = zcoefn |
---|
| 95 | gcdmat(ji,jj) = e1t(ji,jj) * e2t(ji,jj) * bmask(ji,jj) & ! diagonal coefficient |
---|
[16] | 96 | & - zcoefs -zcoefw -zcoefe -zcoefn |
---|
[3] | 97 | END DO |
---|
| 98 | END DO |
---|
| 99 | |
---|
[359] | 100 | # elif defined key_dynspg_flt && defined key_obc |
---|
[3] | 101 | |
---|
[1601] | 102 | DO jj = 2, jpjm1 ! matrix of free surface elliptic system with open boundaries |
---|
[3] | 103 | DO ji = 2, jpim1 |
---|
[1601] | 104 | zcoef = z2dt * z2dt * grav * bmask(ji,jj) |
---|
| 105 | ! ! south coefficient |
---|
[85] | 106 | IF( lp_obc_south .AND. ( jj == njs0p1 ) ) THEN |
---|
[3] | 107 | zcoefs = -zcoef * hv(ji,jj-1) * e1v(ji,jj-1)/e2v(ji,jj-1)*(1.-vsmsk(ji,1)) |
---|
| 108 | ELSE |
---|
| 109 | zcoefs = -zcoef * hv(ji,jj-1) * e1v(ji,jj-1)/e2v(ji,jj-1) |
---|
| 110 | END IF |
---|
| 111 | gcp(ji,jj,1) = zcoefs |
---|
[1601] | 112 | ! |
---|
| 113 | ! ! west coefficient |
---|
[85] | 114 | IF( lp_obc_west .AND. ( ji == niw0p1 ) ) THEN |
---|
[3] | 115 | zcoefw = -zcoef * hu(ji-1,jj) * e2u(ji-1,jj)/e1u(ji-1,jj)*(1.-uwmsk(jj,1)) |
---|
| 116 | ELSE |
---|
| 117 | zcoefw = -zcoef * hu(ji-1,jj) * e2u(ji-1,jj)/e1u(ji-1,jj) |
---|
| 118 | END IF |
---|
| 119 | gcp(ji,jj,2) = zcoefw |
---|
[1601] | 120 | ! |
---|
| 121 | ! ! east coefficient |
---|
[85] | 122 | IF( lp_obc_east .AND. ( ji == nie0 ) ) THEN |
---|
[3] | 123 | zcoefe = -zcoef * hu(ji,jj) * e2u(ji,jj)/e1u(ji,jj)*(1.-uemsk(jj,1)) |
---|
| 124 | ELSE |
---|
| 125 | zcoefe = -zcoef * hu(ji,jj) * e2u(ji,jj)/e1u(ji,jj) |
---|
| 126 | END IF |
---|
| 127 | gcp(ji,jj,3) = zcoefe |
---|
[1601] | 128 | ! |
---|
| 129 | ! ! north coefficient |
---|
[85] | 130 | IF( lp_obc_north .AND. ( jj == njn0 ) ) THEN |
---|
[3] | 131 | zcoefn = -zcoef * hv(ji,jj) * e1v(ji,jj)/e2v(ji,jj)*(1.-vnmsk(ji,1)) |
---|
| 132 | ELSE |
---|
| 133 | zcoefn = -zcoef * hv(ji,jj) * e1v(ji,jj)/e2v(ji,jj) |
---|
| 134 | END IF |
---|
| 135 | gcp(ji,jj,4) = zcoefn |
---|
[1601] | 136 | ! |
---|
| 137 | ! ! diagonal coefficient |
---|
| 138 | gcdmat(ji,jj) = e1t(ji,jj)*e2t(ji,jj)*bmask(ji,jj) & |
---|
| 139 | & - zcoefs -zcoefw -zcoefe -zcoefn |
---|
[3] | 140 | END DO |
---|
| 141 | END DO |
---|
[1601] | 142 | #endif |
---|
[3] | 143 | |
---|
[392] | 144 | #if defined key_agrif |
---|
[1601] | 145 | IF( .NOT.AGRIF_ROOT() ) THEN |
---|
| 146 | ! |
---|
| 147 | IF( nbondi == -1 .OR. nbondi == 2 ) bmask(2 ,: ) = 0.e0 |
---|
| 148 | IF( nbondi == 1 .OR. nbondi == 2 ) bmask(nlci-1,: ) = 0.e0 |
---|
| 149 | IF( nbondj == -1 .OR. nbondj == 2 ) bmask(: ,2 ) = 0.e0 |
---|
| 150 | IF( nbondj == 1 .OR. nbondj == 2 ) bmask(: ,nlcj-1) = 0.e0 |
---|
| 151 | ! |
---|
| 152 | DO jj = 2, jpjm1 |
---|
| 153 | DO ji = 2, jpim1 |
---|
| 154 | zcoef = z2dt * z2dt * grav * bmask(ji,jj) |
---|
| 155 | ! south coefficient |
---|
| 156 | IF( ( nbondj == -1 .OR. nbondj == 2 ) .AND. ( jj == 3 ) ) THEN |
---|
| 157 | zcoefs = -zcoef * hv(ji,jj-1) * e1v(ji,jj-1)/e2v(ji,jj-1)*(1.-vmask(ji,jj-1,1)) |
---|
| 158 | ELSE |
---|
| 159 | zcoefs = -zcoef * hv(ji,jj-1) * e1v(ji,jj-1)/e2v(ji,jj-1) |
---|
| 160 | END IF |
---|
| 161 | gcp(ji,jj,1) = zcoefs |
---|
| 162 | ! |
---|
| 163 | ! west coefficient |
---|
| 164 | IF( ( nbondi == -1 .OR. nbondi == 2 ) .AND. ( ji == 3 ) ) THEN |
---|
| 165 | zcoefw = -zcoef * hu(ji-1,jj) * e2u(ji-1,jj)/e1u(ji-1,jj)*(1.-umask(ji-1,jj,1)) |
---|
| 166 | ELSE |
---|
| 167 | zcoefw = -zcoef * hu(ji-1,jj) * e2u(ji-1,jj)/e1u(ji-1,jj) |
---|
| 168 | END IF |
---|
| 169 | gcp(ji,jj,2) = zcoefw |
---|
| 170 | ! |
---|
| 171 | ! east coefficient |
---|
| 172 | IF( ( nbondi == 1 .OR. nbondi == 2 ) .AND. ( ji == nlci-2 ) ) THEN |
---|
| 173 | zcoefe = -zcoef * hu(ji,jj) * e2u(ji,jj)/e1u(ji,jj)*(1.-umask(ji,jj,1)) |
---|
| 174 | ELSE |
---|
| 175 | zcoefe = -zcoef * hu(ji,jj) * e2u(ji,jj)/e1u(ji,jj) |
---|
| 176 | END IF |
---|
| 177 | gcp(ji,jj,3) = zcoefe |
---|
| 178 | ! |
---|
| 179 | ! north coefficient |
---|
| 180 | IF( ( nbondj == 1 .OR. nbondj == 2 ) .AND. ( jj == nlcj-2 ) ) THEN |
---|
| 181 | zcoefn = -zcoef * hv(ji,jj) * e1v(ji,jj)/e2v(ji,jj)*(1.-vmask(ji,jj,1)) |
---|
| 182 | ELSE |
---|
| 183 | zcoefn = -zcoef * hv(ji,jj) * e1v(ji,jj)/e2v(ji,jj) |
---|
| 184 | END IF |
---|
| 185 | gcp(ji,jj,4) = zcoefn |
---|
| 186 | ! |
---|
| 187 | ! diagonal coefficient |
---|
| 188 | gcdmat(ji,jj) = e1t(ji,jj)*e2t(ji,jj)*bmask(ji,jj) & |
---|
| 189 | & - zcoefs -zcoefw -zcoefe -zcoefn |
---|
| 190 | END DO |
---|
[389] | 191 | END DO |
---|
[1601] | 192 | ! |
---|
| 193 | ENDIF |
---|
[389] | 194 | #endif |
---|
| 195 | |
---|
[3] | 196 | ! 2. Boundary conditions |
---|
| 197 | ! ---------------------- |
---|
| 198 | |
---|
| 199 | ! Cyclic east-west boundary conditions |
---|
| 200 | ! ji=2 is the column east of ji=jpim1 and reciprocally, |
---|
| 201 | ! ji=jpim1 is the column west of ji=2 |
---|
| 202 | ! all the coef are already set to zero as bmask is initialized to |
---|
| 203 | ! zero for ji=1 and ji=jpj in dommsk. |
---|
| 204 | |
---|
| 205 | ! Symetrical conditions |
---|
| 206 | ! free surface: no specific action |
---|
| 207 | ! bsf system: n-s gradient of bsf = 0 along j=2 (perhaps a bug !!!!!!) |
---|
| 208 | ! the diagonal coefficient of the southern grid points must be modify to |
---|
| 209 | ! account for the existence of the south symmetric bassin. |
---|
| 210 | |
---|
| 211 | ! North fold boundary condition |
---|
| 212 | ! all the coef are already set to zero as bmask is initialized to |
---|
| 213 | ! zero on duplicated lignes and portion of lignes |
---|
| 214 | |
---|
| 215 | ! 3. Preconditioned matrix |
---|
| 216 | ! ------------------------ |
---|
| 217 | |
---|
[1556] | 218 | ! SOR and PCG solvers |
---|
| 219 | DO jj = 1, jpj |
---|
| 220 | DO ji = 1, jpi |
---|
| 221 | IF( bmask(ji,jj) /= 0.e0 ) gcdprc(ji,jj) = 1.e0 / gcdmat(ji,jj) |
---|
[3] | 222 | END DO |
---|
[1556] | 223 | END DO |
---|
[3] | 224 | |
---|
[1556] | 225 | gcp(:,:,1) = gcp(:,:,1) * gcdprc(:,:) |
---|
| 226 | gcp(:,:,2) = gcp(:,:,2) * gcdprc(:,:) |
---|
| 227 | gcp(:,:,3) = gcp(:,:,3) * gcdprc(:,:) |
---|
| 228 | gcp(:,:,4) = gcp(:,:,4) * gcdprc(:,:) |
---|
[1601] | 229 | IF( nn_solv == 2 ) gccd(:,:) = rn_sor * gcp(:,:,2) |
---|
[3] | 230 | |
---|
[1601] | 231 | IF( nn_solv == 2 .AND. MAX( jpr2di, jpr2dj ) > 0) THEN |
---|
[1556] | 232 | CALL lbc_lnk_e( gcp (:,:,1), c_solver_pt, 1. ) ! lateral boundary conditions |
---|
| 233 | CALL lbc_lnk_e( gcp (:,:,2), c_solver_pt, 1. ) ! lateral boundary conditions |
---|
| 234 | CALL lbc_lnk_e( gcp (:,:,3), c_solver_pt, 1. ) ! lateral boundary conditions |
---|
| 235 | CALL lbc_lnk_e( gcp (:,:,4), c_solver_pt, 1. ) ! lateral boundary conditions |
---|
| 236 | CALL lbc_lnk_e( gcdprc(:,:) , c_solver_pt, 1. ) ! lateral boundary conditions |
---|
| 237 | CALL lbc_lnk_e( gcdmat(:,:) , c_solver_pt, 1. ) ! lateral boundary conditions |
---|
| 238 | IF( npolj /= 0 ) CALL sol_exd( gcp , c_solver_pt ) ! switch northernelements |
---|
| 239 | END IF |
---|
| 240 | |
---|
[3] | 241 | ! 4. Initialization the arrays used in pcg |
---|
| 242 | ! ---------------------------------------- |
---|
| 243 | gcb (:,:) = 0.e0 |
---|
| 244 | gcr (:,:) = 0.e0 |
---|
| 245 | gcdes(:,:) = 0.e0 |
---|
| 246 | gccd (:,:) = 0.e0 |
---|
[1556] | 247 | ! |
---|
[3] | 248 | END SUBROUTINE sol_mat |
---|
| 249 | |
---|
[312] | 250 | |
---|
| 251 | SUBROUTINE sol_exd( pt3d, cd_type ) |
---|
| 252 | !!---------------------------------------------------------------------- |
---|
| 253 | !! *** routine sol_exd *** |
---|
| 254 | !! |
---|
| 255 | !! ** Purpose : Reorder gcb coefficient on the extra outer halo |
---|
| 256 | !! at north fold in case of T or F pivot |
---|
| 257 | !! |
---|
| 258 | !! ** Method : Perform a circular permutation of the coefficients on |
---|
| 259 | !! the total area strictly above the pivot point, |
---|
| 260 | !! and on the semi-row of the pivot point |
---|
| 261 | !!---------------------------------------------------------------------- |
---|
[1601] | 262 | CHARACTER(len=1) , INTENT( in ) :: cd_type ! define the nature of pt2d array grid-points |
---|
| 263 | ! ! = T , U , V , F , W |
---|
| 264 | ! ! = S : T-point, north fold treatment |
---|
| 265 | ! ! = G : F-point, north fold treatment |
---|
| 266 | ! ! = I : sea-ice velocity at F-point with index shift |
---|
| 267 | REAL(wp), DIMENSION(1-jpr2di:jpi+jpr2di,1-jpr2dj:jpj+jpr2dj,4), INTENT(inout) :: pt3d ! 2D field to be treated |
---|
| 268 | !! |
---|
| 269 | INTEGER :: ji, jk ! dummy loop indices |
---|
| 270 | INTEGER :: iloc ! temporary integers |
---|
| 271 | REAL(wp), DIMENSION(1-jpr2di:jpi+jpr2di,1-jpr2dj:jpj+jpr2dj,4) :: ztab ! 2D workspace |
---|
[312] | 272 | !!---------------------------------------------------------------------- |
---|
| 273 | |
---|
| 274 | ztab = pt3d |
---|
| 275 | |
---|
[1601] | 276 | SELECT CASE ( npolj ) ! north fold type |
---|
| 277 | ! |
---|
| 278 | CASE ( 3 , 4 ) !== T pivot ==! |
---|
[312] | 279 | iloc = jpiglo/2 +1 |
---|
[1601] | 280 | ! |
---|
| 281 | SELECT CASE ( cd_type ) |
---|
| 282 | ! |
---|
| 283 | CASE ( 'T', 'S', 'U', 'W' ) |
---|
| 284 | DO jk = 1, 4 |
---|
| 285 | DO ji = 1-jpr2di, nlci+jpr2di |
---|
| 286 | pt3d(ji,nlcj:nlcj+jpr2dj,jk) = ztab(ji,nlcj:nlcj+jpr2dj,jk+3-2*MOD(jk+3,4)) |
---|
| 287 | END DO |
---|
| 288 | END DO |
---|
| 289 | DO jk =1, 4 |
---|
| 290 | DO ji = nlci+jpr2di, 1-jpr2di, -1 |
---|
| 291 | IF( ( ji .LT. mi0(iloc) .AND. mi0(iloc) /= 1 ) & |
---|
| 292 | & .OR. ( mi0(iloc) == jpi+1 ) ) EXIT |
---|
[312] | 293 | pt3d(ji,nlcj-1,jk) = ztab(ji,nlcj-1,jk+3-2*MOD(jk+3,4)) |
---|
[1601] | 294 | END DO |
---|
| 295 | END DO |
---|
| 296 | ! |
---|
| 297 | CASE ( 'F' ,'G' , 'I', 'V' ) |
---|
| 298 | DO jk =1, 4 |
---|
| 299 | DO ji = 1-jpr2di, nlci+jpr2di |
---|
| 300 | pt3d(ji,nlcj-1:nlcj+jpr2dj,jk) = ztab(ji,nlcj-1:nlcj+jpr2dj,jk+3-2*MOD(jk+3,4)) |
---|
| 301 | END DO |
---|
| 302 | END DO |
---|
| 303 | ! |
---|
| 304 | END SELECT ! cd_type |
---|
| 305 | ! |
---|
| 306 | CASE ( 5 , 6 ) !== F pivot ==! |
---|
| 307 | iloc=jpiglo/2 |
---|
| 308 | ! |
---|
| 309 | SELECT CASE (cd_type ) |
---|
| 310 | ! |
---|
| 311 | CASE ( 'T' ,'S', 'U', 'W') |
---|
| 312 | DO jk =1, 4 |
---|
| 313 | DO ji = 1-jpr2di, nlci+jpr2di |
---|
| 314 | pt3d(ji,nlcj:nlcj+jpr2dj,jk) = ztab(ji,nlcj:nlcj+jpr2dj,jk+3-2*MOD(jk+3,4)) |
---|
| 315 | END DO |
---|
| 316 | END DO |
---|
| 317 | ! |
---|
| 318 | CASE ( 'F' ,'G' , 'I', 'V' ) |
---|
| 319 | DO jk =1, 4 |
---|
| 320 | DO ji = 1-jpr2di, nlci+jpr2di |
---|
| 321 | pt3d(ji,nlcj:nlcj+jpr2dj,jk) = ztab(ji,nlcj:nlcj+jpr2dj,jk+3-2*MOD(jk+3,4)) |
---|
| 322 | END DO |
---|
| 323 | END DO |
---|
| 324 | DO jk =1, 4 |
---|
| 325 | DO ji = nlci+jpr2di, 1-jpr2di, -1 |
---|
| 326 | IF( ( ji .LT. mi0(iloc) .AND. mi0(iloc) /= 1 ) .OR. ( mi0(iloc) == jpi+1 ) ) EXIT |
---|
[312] | 327 | pt3d(ji,nlcj-1,jk) = ztab(ji,nlcj-1,jk+3-2*MOD(jk+3,4)) |
---|
[1601] | 328 | END DO |
---|
| 329 | END DO |
---|
| 330 | ! |
---|
| 331 | END SELECT ! cd_type |
---|
| 332 | ! |
---|
| 333 | END SELECT ! npolj |
---|
[1556] | 334 | ! |
---|
[312] | 335 | END SUBROUTINE sol_exd |
---|
| 336 | |
---|
[3] | 337 | !!====================================================================== |
---|
| 338 | END MODULE solmat |
---|