/[MITgcm]/MITgcm/pkg/seaice/seaice_jfnk.F
ViewVC logotype

Diff of /MITgcm/pkg/seaice/seaice_jfnk.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.4 by mlosch, Tue Nov 6 13:18:14 2012 UTC revision 1.26 by mlosch, Thu Mar 20 09:24:49 2014 UTC
# Line 3  C $Name$ Line 3  C $Name$
3    
4  #include "SEAICE_OPTIONS.h"  #include "SEAICE_OPTIONS.h"
5    
6    C--  File seaice_jfnk.F: seaice jfnk dynamical solver S/R:
7    C--   Contents
8    C--   o SEAICE_JFNK
9    C--   o SEAICE_JFNK_UPDATE
10    
11  CBOP  CBOP
12  C     !ROUTINE: SEAICE_JFNK  C     !ROUTINE: SEAICE_JFNK
13  C     !INTERFACE:  C     !INTERFACE:
# Line 10  C     !INTERFACE: Line 15  C     !INTERFACE:
15    
16  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
17  C     *==========================================================*  C     *==========================================================*
18  C     | SUBROUTINE SEAICE_JFKF  C     | SUBROUTINE SEAICE_JFNK
19  C     | o Ice dynamics using a Jacobian-free Newton-Krylov solver  C     | o Ice dynamics using a Jacobian-free Newton-Krylov solver
20  C     |   following J.-F. Lemieux et al. Improving the numerical  C     |   following J.-F. Lemieux et al. Improving the numerical
21  C     |   convergence of viscous-plastic sea ice models with the  C     |   convergence of viscous-plastic sea ice models with the
# Line 48  C     myThid :: my Thread Id. number Line 53  C     myThid :: my Thread Id. number
53        INTEGER myIter        INTEGER myIter
54        INTEGER myThid        INTEGER myThid
55    
56  #if ( (defined SEAICE_CGRID) && \  #ifdef SEAICE_ALLOW_JFNK
57        (defined SEAICE_ALLOW_JFNK) && \  C     !FUNCTIONS:
58        (defined SEAICE_ALLOW_DYNAMICS) )        LOGICAL  DIFFERENT_MULTIPLE
59          EXTERNAL DIFFERENT_MULTIPLE
60    
61    C     !LOCAL VARIABLES:
62    C     === Local variables ===
63  C     i,j,bi,bj :: loop indices  C     i,j,bi,bj :: loop indices
64        INTEGER i,j,bi,bj        INTEGER i,j,bi,bj
65  C     loop indices  C     loop indices
66        INTEGER newtonIter, newtonIterFail        INTEGER newtonIter
67        INTEGER krylovIter, krylovIterFail        INTEGER krylovIter, krylovFails
68        INTEGER totalKrylovIter        INTEGER totalKrylovItersLoc, totalNewtonItersLoc
69  C     FGMRES flag that indicates what to do next  C     FGMRES flag that determines amount of output messages of fgmres
70          INTEGER iOutFGMRES
71    C     FGMRES flag that indicates what fgmres wants us to do next
72        INTEGER iCode        INTEGER iCode
73        _RL     JFNKresidual, JFNKresidualTile(nSx,nSy)        _RL     JFNKresidual
74        _RL     JFNKresidualKm1        _RL     JFNKresidualKm1
75  C     parameters to compute convergence criterion  C     parameters to compute convergence criterion
76        _RL     phi_e, alp_e, JFNKgamma_lin        _RL     JFNKgamma_lin
77        _RL     FGMRESeps        _RL     FGMRESeps
78        _RL     JFNKtol        _RL     JFNKtol
79  C      C     backward differences extrapolation factors
80          _RL bdfFac, bdfAlpha
81    C
82        _RL     recip_deltaT        _RL     recip_deltaT
83        LOGICAL JFNKconverged, krylovConverged        LOGICAL JFNKconverged, krylovConverged
84          LOGICAL writeNow
85        CHARACTER*(MAX_LEN_MBUF) msgBuf        CHARACTER*(MAX_LEN_MBUF) msgBuf
86  C  
87  C     u/vIceRes :: residual of sea-ice momentum equations  C     u/vIceRes :: residual of sea-ice momentum equations
88        _RL uIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL uIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
89        _RL vIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL vIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
90    C     extra time level required for backward difference time stepping
91          _RL duIcNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
92          _RL dvIcNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
93  C     du/vIce   :: ice velocity increment to be added to u/vIce  C     du/vIce   :: ice velocity increment to be added to u/vIce
94        _RL duIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL duIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
95        _RL dvIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL dvIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
96  C     precomputed (= constant per Newton iteration) versions of  C     precomputed (= constant per Newton iteration) versions of
97  C     zeta, eta, and DWATN, press  C     zeta, eta, and DWATN, press
98        _RL zetaPre (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL zetaPre (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
99        _RL etaPre  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL etaPre  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
100          _RL etaZPre (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
101        _RL dwatPre (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL dwatPre (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
       _RL pressPre(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
102  CEOP  CEOP
103    
104  C     Initialise  C     Initialise
105        newtonIter      = 0        newtonIter          = 0
106        newtonIterFail  = 0        krylovFails         = 0
107        krylovIterFail  = 0        totalKrylovItersLoc = 0
108        totalKrylovIter = 0        JFNKconverged       = .FALSE.
109        JFNKconverged   = .FALSE.        JFNKtol             = 0. _d 0
110        JFNKtol         = 0. _d 0        JFNKresidual        = 0. _d 0
111        JFNKresidual    = 0. _d 0        JFNKresidualKm1     = 0. _d 0
112        JFNKresidualKm1 = 0. _d 0        FGMRESeps           = 0. _d 0
113        FGMRESeps       = 0. _d 0        recip_deltaT        = 1. _d 0 / SEAICE_deltaTdyn
114        recip_deltaT    = 1. _d 0 / SEAICE_deltaTdyn  
115  C            iOutFGMRES=0
116    C     with iOutFgmres=1, seaice_fgmres prints the residual at each iteration
117          IF ( debugLevel.GE.debLevC .AND.
118         &     DIFFERENT_MULTIPLE( SEAICE_monFreq, myTime, deltaTClock ) )
119         &     iOutFGMRES=1
120    
121    C     backward difference extrapolation factors
122          bdfFac = 0. _d 0
123          IF ( SEAICEuseBDF2 ) THEN
124           IF ( myIter.EQ.nIter0 .AND. SEAICEmomStartBDF.EQ.0 ) THEN
125            bdfFac = 0. _d 0
126           ELSE
127            bdfFac = 0.5 _d 0
128           ENDIF
129          ENDIF
130          bdfAlpha = 1. _d 0 + bdfFac
131    
132        DO bj=myByLo(myThid),myByHi(myThid)        DO bj=myByLo(myThid),myByHi(myThid)
133         DO bi=myBxLo(myThid),myBxHi(myThid)         DO bi=myBxLo(myThid),myBxHi(myThid)
134          DO J=1-Oly,sNy+Oly          DO J=1-OLy,sNy+OLy
135           DO I=1-Olx,sNx+Olx           DO I=1-OLx,sNx+OLx
136            uIceRes(I,J,bi,bj) = 0. _d 0            uIceRes(I,J,bi,bj) = 0. _d 0
137            vIceRes(I,J,bi,bj) = 0. _d 0            vIceRes(I,J,bi,bj) = 0. _d 0
138            duIce  (I,J,bi,bj) = 0. _d 0            duIce  (I,J,bi,bj) = 0. _d 0
139            dvIce  (I,J,bi,bj) = 0. _d 0            dvIce  (I,J,bi,bj) = 0. _d 0
140             ENDDO
141            ENDDO
142    C     cycle ice velocities
143            DO J=1-OLy,sNy+OLy
144             DO I=1-OLx,sNx+OLx
145              duIcNm1(I,J,bi,bj) = uIce(I,J,bi,bj) * bdfAlpha
146         &         + ( uIce(I,J,bi,bj) - uIceNm1(I,J,bi,bj) ) * bdfFac
147              dvIcNm1(I,J,bi,bj) = vIce(I,J,bi,bj) * bdfAlpha
148         &         + ( vIce(I,J,bi,bj) - vIceNm1(I,J,bi,bj) ) * bdfFac
149            uIceNm1(I,J,bi,bj) = uIce(I,J,bi,bj)            uIceNm1(I,J,bi,bj) = uIce(I,J,bi,bj)
150            vIceNm1(I,J,bi,bj) = vIce(I,J,bi,bj)            vIceNm1(I,J,bi,bj) = vIce(I,J,bi,bj)
151           ENDDO           ENDDO
152          ENDDO          ENDDO
153    C     As long as IMEX is not properly implemented leave this commented out
154    CML        IF ( .NOT.SEAICEuseIMEX ) THEN
155  C     Compute things that do no change during the Newton iteration:  C     Compute things that do no change during the Newton iteration:
156  C     sea-surface tilt and wind stress:  C     sea-surface tilt and wind stress:
157  C     FORCEX/Y0 - mass*(u/vIceNm1)/deltaT  C     FORCEX/Y0 - mass*(1.5*u/vIceNm1+0.5*(u/vIceNm1-u/vIceNm2))/deltaT
158          DO J=1-Oly,sNy+Oly          DO J=1-OLy,sNy+OLy
159           DO I=1-Olx,sNx+Olx           DO I=1-OLx,sNx+OLx
160            FORCEX(I,J,bi,bj) = FORCEX0(I,J,bi,bj)            FORCEX(I,J,bi,bj) = FORCEX0(I,J,bi,bj)
161       &         + seaiceMassU(I,J,bi,bj)*uIceNm1(I,J,bi,bj)*recip_deltaT           &         + seaiceMassU(I,J,bi,bj)*duIcNm1(I,J,bi,bj)*recip_deltaT
162            FORCEY(I,J,bi,bj) = FORCEY0(I,J,bi,bj)            FORCEY(I,J,bi,bj) = FORCEY0(I,J,bi,bj)
163       &         + seaiceMassV(I,J,bi,bj)*vIceNm1(I,J,bi,bj)*recip_deltaT           &         + seaiceMassV(I,J,bi,bj)*dvIcNm1(I,J,bi,bj)*recip_deltaT
164           ENDDO           ENDDO
165          ENDDO          ENDDO
166    CML        ENDIF
167         ENDDO         ENDDO
168        ENDDO        ENDDO
169  C     Start nonlinear Newton iteration: outer loop iteration  C     Start nonlinear Newton iteration: outer loop iteration
# Line 128  C     Start nonlinear Newton iteration: Line 172  C     Start nonlinear Newton iteration:
172         newtonIter = newtonIter + 1         newtonIter = newtonIter + 1
173  C     Compute initial residual F(u), (includes computation of global  C     Compute initial residual F(u), (includes computation of global
174  C     variables DWATN, zeta, and eta)  C     variables DWATN, zeta, and eta)
175         CALL SEAICE_CALC_RESIDUAL(         IF ( newtonIter .EQ. 1 ) CALL SEAICE_JFNK_UPDATE(
176       I      uIce, vIce,       I      duIce, dvIce,
177       O      uIceRes, vIceRes,       U      uIce, vIce, JFNKresidual,
178       I      newtonIter, 0, myTime, myIter, myThid )       O      uIceRes, vIceRes,
179         CALL EXCH_UV_XY_RL( uIceRes, vIceRes,.TRUE.,myThid)       I      newtonIter, myTime, myIter, myThid )
180  C     local copies of precomputed coefficients that are to stay  C     local copies of precomputed coefficients that are to stay
181  C     constant for the preconditioner  C     constant for the preconditioner
182         DO bj=myByLo(myThid),myByHi(myThid)         DO bj=myByLo(myThid),myByHi(myThid)
183          DO bi=myBxLo(myThid),myBxHi(myThid)          DO bi=myBxLo(myThid),myBxHi(myThid)
184           DO j=1-Oly,sNy+Oly           DO j=1-OLy,sNy+OLy
185            DO i=1-Olx,sNx+Olx            DO i=1-OLx,sNx+OLx
186              zetaPre(I,J,bi,bj) =  zeta(I,J,bi,bj)             zetaPre(I,J,bi,bj) =  zeta(I,J,bi,bj)
187               etaPre(I,J,bi,bj) =   eta(I,J,bi,bj)              etaPre(I,J,bi,bj) =   eta(I,J,bi,bj)
188              dwatPre(I,J,bi,bj) = DWATN(I,J,bi,bj)             etaZPre(I,J,bi,bj) =  etaZ(I,J,bi,bj)
189             pressPre(I,J,bi,bj) = press(I,J,bi,bj)             dwatPre(I,J,bi,bj) = DWATN(I,J,bi,bj)
190            ENDDO            ENDDO
191           ENDDO           ENDDO
192          ENDDO          ENDDO
193         ENDDO         ENDDO
 C      
        DO bj=myByLo(myThid),myByHi(myThid)  
         DO bi=myBxLo(myThid),myBxHi(myThid)  
          JFNKresidualTile(bi,bj) = 0. _d 0  
          DO J=1,sNy  
           DO I=1,sNx  
 #ifdef CG2D_SINGLECPU_SUM  
            JFNKlocalBuf(I,J,bi,bj) =  
 #else  
            JFNKresidualTile(bi,bj) = JFNKresidualTile(bi,bj) +  
 #endif  
      &          uIceRes(I,J,bi,bj)*uIceRes(I,J,bi,bj) +  
      &          vIceRes(I,J,bi,bj)*vIceRes(I,J,bi,bj)  
           ENDDO  
          ENDDO  
         ENDDO  
        ENDDO  
        JFNKresidual = 0. _d 0  
 #ifdef CG2D_SINGLECPU_SUM  
        CALL GLOBAL_SUM_SINGLECPU_RL(  
      &         JFNKlocalBuf,JFNKresidual, 0, 0, myThid)  
 #else  
        CALL GLOBAL_SUM_TILE_RL( JFNKresidualTile,JFNKresidual,myThid )  
 #endif  
        JFNKresidual = SQRT(JFNKresidual)  
194  C     compute convergence criterion for linear preconditioned FGMRES  C     compute convergence criterion for linear preconditioned FGMRES
195         JFNKgamma_lin = JFNKgamma_lin_max         JFNKgamma_lin = JFNKgamma_lin_max
196         IF ( newtonIter.GT.1.AND.newtonIter.LE.100         IF ( newtonIter.GT.1.AND.newtonIter.LE.SEAICE_JFNK_tolIter
197       &      .AND.JFNKresidual.LT.JFNKres_t ) THEN       &      .AND.JFNKresidual.LT.JFNKres_t ) THEN
198  C     Eisenstat, 1996, equ.(2.6)        C     Eisenstat and Walker (1996), eq.(2.6)
199          phi_e = 1. _d 0          JFNKgamma_lin = SEAICE_JFNKphi
200          alp_e = 1. _d 0       &       *( JFNKresidual/JFNKresidualKm1 )**SEAICE_JFNKalpha
         JFNKgamma_lin = phi_e*( JFNKresidual/JFNKresidualKm1 )**alp_e  
201          JFNKgamma_lin = min(JFNKgamma_lin_max, JFNKgamma_lin)          JFNKgamma_lin = min(JFNKgamma_lin_max, JFNKgamma_lin)
202          JFNKgamma_lin = max(JFNKgamma_lin_min, JFNKgamma_lin)          JFNKgamma_lin = max(JFNKgamma_lin_min, JFNKgamma_lin)
203         ENDIF         ENDIF
204  C     save the residual for the next iteration  C     save the residual for the next iteration
205         JFNKresidualKm1 = JFNKresidual         JFNKresidualKm1 = JFNKresidual
206  C  
207  C     The Krylov iteration using FGMRES, the preconditioner is LSOR  C     The Krylov iteration using FGMRES, the preconditioner is LSOR
208  C     for now. The code is adapted from SEAICE_LSR, but heavily stripped  C     for now. The code is adapted from SEAICE_LSR, but heavily stripped
209  C     down.  C     down.
# Line 193  C     krylovIter is mapped into "its" in Line 211  C     krylovIter is mapped into "its" in
211  C     in that routine  C     in that routine
212         krylovIter    = 0         krylovIter    = 0
213         iCode         = 0         iCode         = 0
214         IF ( debugLevel.GE.debLevA ) THEN    
         WRITE(msgBuf,'(2A,2(1XI6),2E12.5)')  
      &       ' S/R SEAICE_JFNK: newtonIter,',  
      &       ' total newtonIter, JFNKgamma_lin, initial norm = ',  
      &       newtonIter,SEAICEnewtonIterMax*(myIter-nIter0)+newtonIter,  
      &       JFNKgamma_lin, JFNKresidual  
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,  
      &       SQUEEZE_RIGHT, myThid )  
        ENDIF  
 C  
215         JFNKconverged = JFNKresidual.LT.JFNKtol         JFNKconverged = JFNKresidual.LT.JFNKtol
216  C  
217  C     do Krylov loop only if convergence is not reached  C     do Krylov loop only if convergence is not reached
218  C  
219         IF ( .NOT.JFNKconverged ) THEN         IF ( .NOT.JFNKconverged ) THEN
220  C  
221  C     start Krylov iteration (FGMRES)  C     start Krylov iteration (FGMRES)
222  C  
223          krylovConverged = .FALSE.          krylovConverged = .FALSE.
224          FGMRESeps = JFNKgamma_lin * JFNKresidual          FGMRESeps = JFNKgamma_lin * JFNKresidual
225          DO WHILE ( .NOT.krylovConverged )          DO WHILE ( .NOT.krylovConverged )
226  C     solution vector sol = du/vIce  C     solution vector sol = du/vIce
227  C     residual vector (rhs) Fu = u/vIceRes  C     residual vector (rhs) Fu = u/vIceRes
228  C     output work vectors wk1, -> input work vector wk2  C     output work vectors wk1, -> input work vector wk2
229  C      
230           CALL SEAICE_FGMRES_DRIVER(           CALL SEAICE_FGMRES_DRIVER(
231       I        uIceRes, vIceRes,       I        uIceRes, vIceRes,
232       U        duIce, dvIce, iCode,       U        duIce, dvIce, iCode,
233       I        FGMRESeps,         I        FGMRESeps, iOutFGMRES,
234       I        newtonIter, krylovIter, myTime, myIter, myThid )       I        newtonIter, krylovIter, myTime, myIter, myThid )
235  C     FGMRES returns iCode either asking for an new preconditioned vector  C     FGMRES returns iCode either asking for an new preconditioned vector
236  C     or product of matrix (Jacobian) times vector. For iCode = 0, terminate  C     or product of matrix (Jacobian) times vector. For iCode = 0, terminate
237  C     iteration  C     iteration
238           IF (iCode.EQ.1) THEN           IF (iCode.EQ.1) THEN
239  C     Call preconditioner  C     Call preconditioner
240            CALL SEAICE_PRECONDITIONER(            IF ( SOLV_MAX_ITERS .GT. 0 )
241       U         duIce, dvIce,       &         CALL SEAICE_PRECONDITIONER(
242       I         zetaPre, etaPre, dwatPre, pressPre,       U         duIce, dvIce,
243         I         zetaPre, etaPre, etaZpre, dwatPre,
244       I         newtonIter, krylovIter, myTime, myIter, myThid )       I         newtonIter, krylovIter, myTime, myIter, myThid )
245           ELSEIF (iCode.GE.2) THEN           ELSEIF (iCode.GE.2) THEN
246  C     Compute Jacobian times vector  C     Compute Jacobian times vector
247            CALL SEAICE_JACVEC(            CALL SEAICE_JACVEC(
248       I         uIce, vIce, uIceRes, vIceRes,       I         uIce, vIce, uIceRes, vIceRes,
249       U         duIce, dvIce,         U         duIce, dvIce,
250       I         newtonIter, krylovIter, myTime, myIter, myThid )       I         newtonIter, krylovIter, myTime, myIter, myThid )
251           ENDIF           ENDIF
252           krylovConverged = iCode.EQ.0           krylovConverged = iCode.EQ.0
253  C     End of Krylov iterate  C     End of Krylov iterate
254          ENDDO          ENDDO
255          totalKrylovIter = totalKrylovIter + krylovIter          totalKrylovItersLoc = totalKrylovItersLoc + krylovIter
256  C     some output diagnostics  C     some output diagnostics
257          IF ( debugLevel.GE.debLevA ) THEN          IF ( debugLevel.GE.debLevA ) THEN
258             _BEGIN_MASTER( myThid )
259             totalNewtonItersLoc =
260         &        SEAICEnewtonIterMax*(myIter-nIter0)+newtonIter
261             WRITE(msgBuf,'(2A,2(1XI6),2E12.5)')
262         &        ' S/R SEAICE_JFNK: Newton iterate / total, ',
263         &        'JFNKgamma_lin, initial norm = ',
264         &        newtonIter, totalNewtonItersLoc,
265         &        JFNKgamma_lin,JFNKresidual
266             CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
267         &        SQUEEZE_RIGHT, myThid )
268           WRITE(msgBuf,'(3(A,I6))')           WRITE(msgBuf,'(3(A,I6))')
269       &        ' S/R SEAICE_JFNK: Newton iterate / total = ', newtonIter,       &        ' S/R SEAICE_JFNK: Newton iterate / total = ',newtonIter,
270       &        ' / ', SEAICEnewtonIterMax*(myIter-nIter0)+newtonIter,       &        ' / ', totalNewtonItersLoc,
271       &        ', Nb. of FGMRES iterations = ', krylovIter       &        ', Nb. of FGMRES iterations = ', krylovIter
272           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
273       &        SQUEEZE_RIGHT, myThid )       &        SQUEEZE_RIGHT, myThid )
274             _END_MASTER( myThid )
275          ENDIF          ENDIF
276          IF ( krylovIter.EQ.SEAICEkrylovIterMax ) THEN          IF ( krylovIter.EQ.SEAICEkrylovIterMax ) THEN
277           krylovIterFail = krylovIterFail + 1           krylovFails = krylovFails + 1
278            ENDIF
279    C     Set the stopping criterion for the Newton iteration and the
280    C     criterion for the transition from accurate to approximate FGMRES
281            IF ( newtonIter .EQ. 1 ) THEN
282             JFNKtol=JFNKgamma_nonlin*JFNKresidual
283             IF ( JFNKres_tFac .NE. UNSET_RL )
284         &        JFNKres_t = JFNKresidual * JFNKres_tFac
285          ENDIF          ENDIF
286  C     Update linear solution vector and return to Newton iteration  C     Update linear solution vector and return to Newton iteration
287    C     Do a linesearch if necessary, and compute a new residual.
288    C     Note that it should be possible to do the following operations
289    C     at the beginning of the Newton iteration, thereby saving us from
290    C     the extra call of seaice_jfnk_update, but unfortunately that
291    C     changes the results, so we leave the stuff here for now.
292            CALL SEAICE_JFNK_UPDATE(
293         I       duIce, dvIce,
294         U       uIce, vIce, JFNKresidual,
295         O       uIceRes, vIceRes,
296         I       newtonIter, myTime, myIter, myThid )
297    C     reset du/vIce here instead of setting sol = 0 in seaice_fgmres_driver
298          DO bj=myByLo(myThid),myByHi(myThid)          DO bj=myByLo(myThid),myByHi(myThid)
299           DO bi=myBxLo(myThid),myBxHi(myThid)           DO bi=myBxLo(myThid),myBxHi(myThid)
300            DO J=1-Oly,sNy+Oly            DO J=1-OLy,sNy+OLy
301             DO I=1-Olx,sNx+Olx             DO I=1-OLx,sNx+OLx
             uIce(I,J,bi,bj) = uIce(I,J,bi,bj)+duIce(I,J,bi,bj)  
             vIce(I,J,bi,bj) = vIce(I,J,bi,bj)+dvIce(I,J,bi,bj)  
 C     reset du/vIce here instead of setting sol = 0 in seaice_fgmres_driver  
302              duIce(I,J,bi,bj)= 0. _d 0              duIce(I,J,bi,bj)= 0. _d 0
303              dvIce(I,J,bi,bj)= 0. _d 0              dvIce(I,J,bi,bj)= 0. _d 0
304             ENDDO             ENDDO
305            ENDDO            ENDDO
306           ENDDO           ENDDO
307          ENDDO          ENDDO
 C     Set the stopping criterion for the Newton iteration  
         IF ( newtonIter .EQ. 1 ) JFNKtol=JFNKgamma_nonlin*JFNKresidual  
308         ENDIF         ENDIF
309  C     end of Newton iterate  C     end of Newton iterate
310        ENDDO        ENDDO
311  C     some output diagnostics  
312        IF ( debugLevel.GE.debLevA ) THEN  C--   Output diagnostics
313    
314          IF ( SEAICE_monFreq .GT. 0. _d 0 ) THEN
315    C     Count iterations
316           totalJFNKtimeSteps = totalJFNKtimeSteps + 1
317           totalNewtonIters   = totalNewtonIters + newtonIter
318           totalKrylovIters   = totalKrylovIters + totalKrylovItersLoc
319  C     Record failure  C     Record failure
320           totalKrylovFails   = totalKrylovFails + krylovFails
321         IF ( newtonIter .EQ. SEAICEnewtonIterMax ) THEN         IF ( newtonIter .EQ. SEAICEnewtonIterMax ) THEN
322          newtonIterFail = newtonIterFail + 1          totalNewtonFails = totalNewtonFails + 1
323          WRITE(msgBuf,'(A,I10)')         ENDIF
324          ENDIF
325    C     Decide whether it is time to dump and reset the counter
326          writeNow = DIFFERENT_MULTIPLE(SEAICE_monFreq,
327         &     myTime+deltaTClock, deltaTClock)
328    #ifdef ALLOW_CAL
329          IF ( useCAL ) THEN
330           CALL CAL_TIME2DUMP(
331         I      zeroRL, SEAICE_monFreq,  deltaTClock,
332         U      writeNow,
333         I      myTime+deltaTclock, myIter+1, myThid )
334          ENDIF
335    #endif
336          IF ( writeNow ) THEN
337           _BEGIN_MASTER( myThid )
338           WRITE(msgBuf,'(A)')
339         &' // ======================================================='
340           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
341         &      SQUEEZE_RIGHT, myThid )
342           WRITE(msgBuf,'(A)') ' // Begin JFNK statistics'
343           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
344         &      SQUEEZE_RIGHT, myThid )
345           WRITE(msgBuf,'(A)')
346         &' // ======================================================='
347           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
348         &      SQUEEZE_RIGHT, myThid )
349           WRITE(msgBuf,'(A,I10)')
350         &      ' %JFNK_MON: time step              = ', myIter+1
351           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
352         &      SQUEEZE_RIGHT, myThid )
353           WRITE(msgBuf,'(A,I10)')
354         &      ' %JFNK_MON: Nb. of time steps      = ', totalJFNKtimeSteps
355           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
356         &      SQUEEZE_RIGHT, myThid )
357           WRITE(msgBuf,'(A,I10)')
358         &      ' %JFNK_MON: Nb. of Newton steps    = ', totalNewtonIters
359           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
360         &      SQUEEZE_RIGHT, myThid )
361           WRITE(msgBuf,'(A,I10)')
362         &      ' %JFNK_MON: Nb. of Krylov steps    = ', totalKrylovIters
363           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
364         &      SQUEEZE_RIGHT, myThid )
365           WRITE(msgBuf,'(A,I10)')
366         &      ' %JFNK_MON: Nb. of Newton failures = ', totalNewtonFails
367           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
368         &      SQUEEZE_RIGHT, myThid )
369           WRITE(msgBuf,'(A,I10)')
370         &      ' %JFNK_MON: Nb. of Krylov failures = ', totalKrylovFails
371           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
372         &      SQUEEZE_RIGHT, myThid )
373           WRITE(msgBuf,'(A)')
374         &' // ======================================================='
375           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
376         &      SQUEEZE_RIGHT, myThid )
377           WRITE(msgBuf,'(A)') ' // End JFNK statistics'
378           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
379         &      SQUEEZE_RIGHT, myThid )
380           WRITE(msgBuf,'(A)')
381         &' // ======================================================='
382           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
383         &      SQUEEZE_RIGHT, myThid )
384           _END_MASTER( myThid )
385    C     reset and start again
386           totalJFNKtimeSteps = 0
387           totalNewtonIters   = 0
388           totalKrylovIters   = 0
389           totalKrylovFails   = 0
390           totalNewtonFails   = 0
391          ENDIF
392    
393    C     Print more debugging information
394          IF ( debugLevel.GE.debLevA ) THEN
395           IF ( newtonIter .EQ. SEAICEnewtonIterMax ) THEN
396            _BEGIN_MASTER( myThid )
397            WRITE(msgBuf,'(A,I10)')
398       &       ' S/R SEAICE_JFNK: JFNK did not converge in timestep ',       &       ' S/R SEAICE_JFNK: JFNK did not converge in timestep ',
399       &       myIter       &       myIter+1
400          CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,          CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
401       &       SQUEEZE_RIGHT, myThid )       &       SQUEEZE_RIGHT, myThid )
402            _END_MASTER( myThid )
403         ENDIF         ENDIF
404         IF ( krylovIterFail .GT. 0 ) THEN         IF ( krylovFails .GT. 0 ) THEN
405          WRITE(msgBuf,'(A,I4,A,I10)')          _BEGIN_MASTER( myThid )
406            WRITE(msgBuf,'(A,I4,A,I10)')
407       &       ' S/R SEAICE_JFNK: FGMRES did not converge ',       &       ' S/R SEAICE_JFNK: FGMRES did not converge ',
408       &       krylovIterFail, ' times in timestep ', myIter       &       krylovFails, ' times in timestep ', myIter+1
409          CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,          CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
410       &       SQUEEZE_RIGHT, myThid )       &       SQUEEZE_RIGHT, myThid )
411            _END_MASTER( myThid )
412         ENDIF         ENDIF
413         WRITE(msgBuf,'(A,I6)')         _BEGIN_MASTER( myThid )
414           WRITE(msgBuf,'(A,I6,A,I10)')
415       &      ' S/R SEAICE_JFNK: Total number FGMRES iterations = ',       &      ' S/R SEAICE_JFNK: Total number FGMRES iterations = ',
416       &      totalKrylovIter       &      totalKrylovItersLoc, ' in timestep ', myIter+1
417           CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
418         &      SQUEEZE_RIGHT, myThid )
419           _END_MASTER( myThid )
420          ENDIF
421    
422          RETURN
423          END
424    
425    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
426    CBOP
427    C     !ROUTINE: SEAICE_JFNK_UPDATE
428    C     !INTERFACE:
429    
430          SUBROUTINE SEAICE_JFNK_UPDATE(
431         I     duIce, dvIce,
432         U     uIce, vIce, JFNKresidual,
433         O     uIceRes, vIceRes,
434         I     newtonIter, myTime, myIter, myThid )
435    
436    C     !DESCRIPTION: \bv
437    C     *==========================================================*
438    C     | SUBROUTINE SEAICE_JFNK_UPDATE
439    C     | o Update velocities with incremental solutions of FGMRES
440    C     | o compute residual of updated solutions and do
441    C     | o linesearch:
442    C     |   reduce update until residual is smaller than previous
443    C     |   one (input)
444    C     *==========================================================*
445    C     | written by Martin Losch, Jan 2013
446    C     *==========================================================*
447    C     \ev
448    
449    C     !USES:
450          IMPLICIT NONE
451    
452    C     === Global variables ===
453    #include "SIZE.h"
454    #include "EEPARAMS.h"
455    #include "PARAMS.h"
456    #include "SEAICE_SIZE.h"
457    #include "SEAICE_PARAMS.h"
458    
459    C     !INPUT/OUTPUT PARAMETERS:
460    C     === Routine arguments ===
461    C     myTime :: Simulation time
462    C     myIter :: Simulation timestep number
463    C     myThid :: my Thread Id. number
464    C     newtonIter :: current iterate of Newton iteration
465          _RL     myTime
466          INTEGER myIter
467          INTEGER myThid
468          INTEGER newtonIter
469    C     JFNKresidual :: Residual at the beginning of the FGMRES iteration,
470    C                     changes with newtonIter (updated)
471          _RL     JFNKresidual
472    C     du/vIce   :: ice velocity increment to be added to u/vIce (input)
473          _RL duIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
474          _RL dvIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
475    C     u/vIce    :: ice velocity increment to be added to u/vIce (updated)
476          _RL uIce   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
477          _RL vIce   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
478    C     u/vIceRes :: residual of sea-ice momentum equations (output)
479          _RL uIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
480          _RL vIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
481    
482    C     !LOCAL VARIABLES:
483    C     === Local variables ===
484    C     i,j,bi,bj :: loop indices
485          INTEGER i,j,bi,bj
486          INTEGER l
487          _RL     resLoc, facLS
488          LOGICAL doLineSearch
489    C     nVec    :: size of the input vector(s)
490    C     resTmp  :: vector version of the residuals
491          INTEGER nVec
492          PARAMETER ( nVec  = 2*sNx*sNy )
493          _RL resTmp (nVec,1,nSx,nSy)
494    
495          CHARACTER*(MAX_LEN_MBUF) msgBuf
496    CEOP
497    
498    C     Initialise some local variables
499          l = 0
500          resLoc = JFNKresidual
501          facLS = 1. _d 0
502          doLineSearch = .TRUE.
503          DO WHILE ( doLineSearch )
504    C     Create update
505           DO bj=myByLo(myThid),myByHi(myThid)
506            DO bi=myBxLo(myThid),myBxHi(myThid)
507             DO J=1-OLy,sNy+OLy
508              DO I=1-OLx,sNx+OLx
509               uIce(I,J,bi,bj) = uIce(I,J,bi,bj)+facLS*duIce(I,J,bi,bj)
510               vIce(I,J,bi,bj) = vIce(I,J,bi,bj)+facLS*dvIce(I,J,bi,bj)
511              ENDDO
512             ENDDO
513            ENDDO
514           ENDDO
515    C     Compute current residual F(u), (includes re-computation of global
516    C     variables DWATN, zeta, and eta, i.e. they are different after this)
517           CALL SEAICE_CALC_RESIDUAL(
518         I      uIce, vIce,
519         O      uIceRes, vIceRes,
520         I      newtonIter, 0, myTime, myIter, myThid )
521    C     Important: Compute the norm of the residual using the same scalar
522    C     product that SEAICE_FGMRES does
523           CALL SEAICE_MAP2VEC(nVec,uIceRes,vIceRes,resTmp,.TRUE.,myThid)
524           CALL SEAICE_SCALPROD(nVec,1,1,1,resTmp,resTmp,resLoc,myThid)
525           resLoc = SQRT(resLoc)
526    C     Determine, if we need more iterations
527           doLineSearch = resLoc .GE. JFNKresidual
528    C     Limit the maximum number of iterations arbitrarily to four
529           doLineSearch = doLineSearch .AND. l .LT. 4
530    C     For the first iteration du/vIce = 0 and there will be no
531    C     improvement of the residual possible, so we do only the first
532    C     iteration
533           IF ( newtonIter .EQ. 1 ) doLineSearch = .FALSE.
534    C     Only start a linesearch after some Newton iterations
535           IF ( newtonIter .LE. SEAICE_JFNK_lsIter ) doLineSearch = .FALSE.
536    C     Increment counter
537           l = l + 1
538    C     some output diagnostics
539           IF ( debugLevel.GE.debLevA .AND. doLineSearch ) THEN
540            _BEGIN_MASTER( myThid )
541            WRITE(msgBuf,'(2A,2(1XI6),3E12.5)')
542         &       ' S/R SEAICE_JFNK_UPDATE: Newton iter, LSiter, ',
543         &       'facLS, JFNKresidual, resLoc = ',
544         &        newtonIter, l, facLS, JFNKresidual, resLoc
545          CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,          CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
546       &       SQUEEZE_RIGHT, myThid )       &       SQUEEZE_RIGHT, myThid )
547                  _END_MASTER( myThid )
548        ENDIF         ENDIF
549    C     Get ready for the next iteration: after adding du/vIce in the first
550    C     iteration, we substract 0.5*du/vIce from u/vIce in the next
551    C     iterations, 0.25*du/vIce in the second, etc.
552           facLS = - 0.5 _d 0 * ABS(facLS)
553          ENDDO
554    C     This is the new residual
555          JFNKresidual = resLoc
556    
557  #endif /* SEAICE_ALLOW_DYNAMICS and SEAICE_CGRID and SEAICE_ALLOW_JFNK */  #endif /* SEAICE_ALLOW_JFNK */
558    
559        RETURN        RETURN
560        END        END
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.26
  ViewVC Help
Powered by ViewVC 1.1.22