| 1 | C $Header: /u/gcmpack/MITgcm/pkg/seaice/seaice_jacvec.F,v 1.2 2012/11/06 13:09:30 mlosch Exp $ | 
| 2 | C $Name:  $ | 
| 3 |  | 
| 4 | #include "SEAICE_OPTIONS.h" | 
| 5 |  | 
| 6 | CBOP | 
| 7 | C     !ROUTINE: SEAICE_JACVEC | 
| 8 | C     !INTERFACE: | 
| 9 | SUBROUTINE SEAICE_JACVEC( | 
| 10 | I     uIceLoc, vIceLoc, uIceRes, vIceRes, | 
| 11 | U     duIce, dvIce, | 
| 12 | I     newtonIter, krylovIter, myTime, myIter, myThid ) | 
| 13 |  | 
| 14 | C     !DESCRIPTION: \bv | 
| 15 | C     *==========================================================* | 
| 16 | C     | SUBROUTINE SEAICE_JACVEC | 
| 17 | C     | o For Jacobian-free Newton-Krylov solver compute | 
| 18 | C     |   Jacobian times vector by finite difference approximation | 
| 19 | C     *==========================================================* | 
| 20 | C     | written by Martin Losch, Oct 2012 | 
| 21 | C     *==========================================================* | 
| 22 | C     \ev | 
| 23 |  | 
| 24 | C     !USES: | 
| 25 | IMPLICIT NONE | 
| 26 |  | 
| 27 | C     === Global variables === | 
| 28 | #include "SIZE.h" | 
| 29 | #include "EEPARAMS.h" | 
| 30 | #include "PARAMS.h" | 
| 31 | #include "DYNVARS.h" | 
| 32 | #include "GRID.h" | 
| 33 | #include "SEAICE_SIZE.h" | 
| 34 | #include "SEAICE_PARAMS.h" | 
| 35 | #include "SEAICE.h" | 
| 36 |  | 
| 37 | C     !INPUT/OUTPUT PARAMETERS: | 
| 38 | C     === Routine arguments === | 
| 39 | C     myTime :: Simulation time | 
| 40 | C     myIter :: Simulation timestep number | 
| 41 | C     myThid :: my Thread Id. number | 
| 42 | C     newtonIter :: current iterate of Newton iteration | 
| 43 | C     krylovIter :: current iterate of Krylov iteration | 
| 44 | _RL     myTime | 
| 45 | INTEGER myIter | 
| 46 | INTEGER myThid | 
| 47 | INTEGER newtonIter | 
| 48 | INTEGER krylovIter | 
| 49 | C     u/vIceLoc :: local copies of the current ice velocity | 
| 50 | _RL uIceLoc(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 51 | _RL vIceLoc(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 52 | C     u/vIceRes :: initial residual of this Newton iterate | 
| 53 | _RL uIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 54 | _RL vIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 55 | C     du/vIce   :: correction of ice velocities | 
| 56 | _RL duIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 57 | _RL dvIce  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 58 |  | 
| 59 | #if ( defined (SEAICE_CGRID) && \ | 
| 60 | defined (SEAICE_ALLOW_JFNK) && \ | 
| 61 | defined (SEAICE_ALLOW_DYNAMICS) ) | 
| 62 | C     Local variables: | 
| 63 | _RL utp     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 64 | _RL vtp     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 65 | C     u/vIceResP :: residual computed with u/vtp | 
| 66 | _RL uIceResP(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 67 | _RL vIceResP(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 68 |  | 
| 69 | C     i,j,bi,bj :: loop indices | 
| 70 | INTEGER i,j,bi,bj | 
| 71 | _RL epsilon, reps | 
| 72 | CEOP | 
| 73 | C     Instructions for using TAF or TAMC to generate exact Jacobian times | 
| 74 | C     vector operations: | 
| 75 | C | 
| 76 | C     1. make small_f | 
| 77 | C     2. cat seaice_calc_residual.f seaice_oceandrag_coeffs.f seaice_calc_strainrates.f seaice_calc_viscosities.f seaice_calc_rhs.f seaice_calc_lhs.f > taf_input.f | 
| 78 | C     3. staf -v1 -forward -toplevel seaice_calc_residual -input uIceLoc,viceLoc -output uIceRes,vIceRes taf_input.f | 
| 79 | C     4. insert content of taf_input_ftl.f at the end of this file | 
| 80 | C     5. add the following code and comment out the finite difference code | 
| 81 | CML      _RL g_duIce(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 82 | CML      _RL g_dvIce(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 83 | CML      _RL g_uIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 84 | CML      _RL g_vIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 85 | CML | 
| 86 | CMLC     Initialise | 
| 87 | CML      DO bj=myByLo(myThid),myByHi(myThid) | 
| 88 | CML       DO bi=myBxLo(myThid),myBxHi(myThid) | 
| 89 | CML        DO J=1-Oly,sNy+Oly | 
| 90 | CML         DO I=1-Olx,sNx+Olx | 
| 91 | CML          g_duIce(I,J,bi,bj) = duice(I,J,bi,bj) | 
| 92 | CML          g_dvIce(I,J,bi,bj) = dvice(I,J,bi,bj) | 
| 93 | CML          g_uIceRes(I,J,bi,bj) = 0. _d 0 | 
| 94 | CML          g_vIceRes(I,J,bi,bj) = 0. _d 0 | 
| 95 | CML          uIceResP(I,J,bi,bj) = 0. _d 0 | 
| 96 | CML          vIceResP(I,J,bi,bj) = 0. _d 0 | 
| 97 | CML         ENDDO | 
| 98 | CML        ENDDO | 
| 99 | CML       ENDDO | 
| 100 | CML      ENDDO | 
| 101 | CML | 
| 102 | CML      CALL G_SEAICE_CALC_RESIDUAL( uIce, g_duice, vIce, | 
| 103 | CML     $g_dvice, uiceresp, g_uiceres, viceresp, g_viceres, newtoniter, | 
| 104 | CML     $kryloviter, mytime, myiter, mythid ) | 
| 105 | CML | 
| 106 | CML      DO bj=myByLo(myThid),myByHi(myThid) | 
| 107 | CML       DO bi=myBxLo(myThid),myBxHi(myThid) | 
| 108 | CML        DO J=1-Oly,sNy+Oly | 
| 109 | CML         DO I=1-Olx,sNx+Olx | 
| 110 | CML          duice(I,J,bi,bj)=g_uiceres(I,J,bi,bj) | 
| 111 | CML          dvice(I,J,bi,bj)=g_viceres(I,J,bi,bj) | 
| 112 | CML         ENDDO | 
| 113 | CML        ENDDO | 
| 114 | CML       ENDDO | 
| 115 | CML      ENDDO | 
| 116 |  | 
| 117 | C     Initialise | 
| 118 | epsilon = 1. _d -06 | 
| 119 | reps    = 1. _d 0/epsilon | 
| 120 |  | 
| 121 | DO bj=myByLo(myThid),myByHi(myThid) | 
| 122 | DO bi=myBxLo(myThid),myBxHi(myThid) | 
| 123 | DO J=1-Oly,sNy+Oly | 
| 124 | DO I=1-Olx,sNx+Olx | 
| 125 | utp(I,J,bi,bj) = uIce(I,J,bi,bj) + epsilon * duIce(I,J,bi,bj) | 
| 126 | vtp(I,J,bi,bj) = vIce(I,J,bi,bj) + epsilon * dvIce(I,J,bi,bj) | 
| 127 | ENDDO | 
| 128 | ENDDO | 
| 129 | ENDDO | 
| 130 | ENDDO | 
| 131 |  | 
| 132 | C     Compute new residual F(u) | 
| 133 | CALL SEAICE_CALC_RESIDUAL( | 
| 134 | I     utp, vtp, | 
| 135 | O     uIceResP, vIceResP, | 
| 136 | I     newtonIter, krylovIter, myTime, myIter, myThid ) | 
| 137 |  | 
| 138 | C     approximate Jacobian times vector by one-sided finite differences | 
| 139 | C     and store in du/vIce | 
| 140 | DO bj = myByLo(myThid),myByHi(myThid) | 
| 141 | DO bi = myBxLo(myThid),myBxHi(myThid) | 
| 142 | DO I = 1, sNx | 
| 143 | DO J = 1, sNy | 
| 144 | duIce(I,J,bi,bj) = | 
| 145 | &         (uIceResP(I,J,bi,bj)-uIceRes(I,J,bi,bj))*reps | 
| 146 | dvIce(I,J,bi,bj) = | 
| 147 | &         (vIceResP(I,J,bi,bj)-vIceRes(I,J,bi,bj))*reps | 
| 148 | ENDDO | 
| 149 | ENDDO | 
| 150 | ENDDO | 
| 151 | ENDDO | 
| 152 |  | 
| 153 | #endif /* SEAICE_ALLOW_DYNAMICS and SEAICE_CGRID and SEAICE_ALLOW_JFNK */ | 
| 154 |  | 
| 155 | RETURN | 
| 156 | END |