| 1 |
C $Header: /u/gcmpack/MITgcm/pkg/seaice/seaice_jacvec.F,v 1.4 2013/02/28 17:12:48 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 |
#ifdef SEAICE_ALLOW_JFNK |
| 60 |
C Local variables: |
| 61 |
_RL utp (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 62 |
_RL vtp (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 63 |
C u/vIceResP :: residual computed with u/vtp |
| 64 |
_RL uIceResP(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 65 |
_RL vIceResP(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 66 |
|
| 67 |
C i,j,bi,bj :: loop indices |
| 68 |
INTEGER i,j,bi,bj |
| 69 |
_RL epsilon, reps |
| 70 |
CEOP |
| 71 |
C Instructions for using TAF or TAMC to generate exact Jacobian times |
| 72 |
C vector operations: |
| 73 |
C |
| 74 |
C 1. make small_f |
| 75 |
C 2. cat seaice_calc_residual.f seaice_oceandrag_coeffs.f \ |
| 76 |
C seaice_calc_strainrates.f seaice_calc_viscosities.f \ |
| 77 |
C seaice_calc_rhs.f seaice_calc_lhs.f > taf_input.f |
| 78 |
C 3. staf -v1 -forward -toplevel seaice_calc_residual \ |
| 79 |
C -input uIceLoc,viceLoc -output uIceRes,vIceRes taf_input.f |
| 80 |
C 4. insert content of taf_input_ftl.f at the end of this file |
| 81 |
C 5. add the following code and comment out the finite difference code |
| 82 |
C |
| 83 |
C Instruction for using TAF 2.4 and higher (or staf with default -v2 |
| 84 |
C starting with version 2.0): |
| 85 |
C |
| 86 |
C 1. make small_f |
| 87 |
C 2. files="seaice_calc_residual.f seaice_oceandrag_coeffs.f \ |
| 88 |
C seaice_calc_strainrates.f seaice_calc_viscosities.f \ |
| 89 |
C seaice_calc_rhs.f seaice_calc_lhs.f" |
| 90 |
C 3. staf -forward -toplevel seaice_calc_residual \ |
| 91 |
C -input uIceLoc,viceLoc -output uIceRes,vIceRes $files |
| 92 |
C 4. copy files seaice_*_tl.f to the corresponding seaice_*.f files, |
| 93 |
C e.g. with this bash script: |
| 94 |
C for file in $files; do |
| 95 |
C nfile=`echo $file | awk -F. '{printf "%s_tl.f", $1}'`; |
| 96 |
C \cp -f $nfile $file |
| 97 |
C done |
| 98 |
C 5. add the following code, change "call g_seaice_calc_residual" |
| 99 |
C to "call seaice_calc_residual_tl", and comment out the finite |
| 100 |
C difference code |
| 101 |
CML _RL g_duIce(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 102 |
CML _RL g_dvIce(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 103 |
CML _RL g_uIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 104 |
CML _RL g_vIceRes(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 105 |
CML |
| 106 |
CMLC Initialise |
| 107 |
CML DO bj=myByLo(myThid),myByHi(myThid) |
| 108 |
CML DO bi=myBxLo(myThid),myBxHi(myThid) |
| 109 |
CML DO J=1-Oly,sNy+Oly |
| 110 |
CML DO I=1-Olx,sNx+Olx |
| 111 |
CML g_duIce(I,J,bi,bj) = duice(I,J,bi,bj) |
| 112 |
CML g_dvIce(I,J,bi,bj) = dvice(I,J,bi,bj) |
| 113 |
CML g_uIceRes(I,J,bi,bj) = 0. _d 0 |
| 114 |
CML g_vIceRes(I,J,bi,bj) = 0. _d 0 |
| 115 |
CML uIceResP(I,J,bi,bj) = 0. _d 0 |
| 116 |
CML vIceResP(I,J,bi,bj) = 0. _d 0 |
| 117 |
CML ENDDO |
| 118 |
CML ENDDO |
| 119 |
CML ENDDO |
| 120 |
CML ENDDO |
| 121 |
CML |
| 122 |
CML CALL G_SEAICE_CALC_RESIDUAL( uIce, g_duice, vIce, |
| 123 |
CML $g_dvice, uiceresp, g_uiceres, viceresp, g_viceres, newtoniter, |
| 124 |
CML $kryloviter, mytime, myiter, mythid ) |
| 125 |
CMLCML For staf -v2 replace the above with the below call |
| 126 |
CMLCML CALL SEAICE_CALC_RESIDUAL_TL( uIce, g_duice, vIce, |
| 127 |
CMLCML $g_dvice, uiceresp, g_uiceres, viceresp, g_viceres, newtoniter, |
| 128 |
CMLCML $kryloviter, mytime, myiter, mythid ) |
| 129 |
CML |
| 130 |
CML DO bj=myByLo(myThid),myByHi(myThid) |
| 131 |
CML DO bi=myBxLo(myThid),myBxHi(myThid) |
| 132 |
CML DO J=1-Oly,sNy+Oly |
| 133 |
CML DO I=1-Olx,sNx+Olx |
| 134 |
CML duice(I,J,bi,bj)=g_uiceres(I,J,bi,bj) |
| 135 |
CML dvice(I,J,bi,bj)=g_viceres(I,J,bi,bj) |
| 136 |
CML ENDDO |
| 137 |
CML ENDDO |
| 138 |
CML ENDDO |
| 139 |
CML ENDDO |
| 140 |
|
| 141 |
C Initialise |
| 142 |
epsilon = SEAICE_JFNKepsilon |
| 143 |
reps = 1. _d 0/epsilon |
| 144 |
|
| 145 |
DO bj=myByLo(myThid),myByHi(myThid) |
| 146 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
| 147 |
DO J=1-Oly,sNy+Oly |
| 148 |
DO I=1-Olx,sNx+Olx |
| 149 |
utp(I,J,bi,bj) = uIce(I,J,bi,bj) + epsilon * duIce(I,J,bi,bj) |
| 150 |
vtp(I,J,bi,bj) = vIce(I,J,bi,bj) + epsilon * dvIce(I,J,bi,bj) |
| 151 |
ENDDO |
| 152 |
ENDDO |
| 153 |
ENDDO |
| 154 |
ENDDO |
| 155 |
|
| 156 |
C Compute new residual F(u) |
| 157 |
CALL SEAICE_CALC_RESIDUAL( |
| 158 |
I utp, vtp, |
| 159 |
O uIceResP, vIceResP, |
| 160 |
I newtonIter, krylovIter, myTime, myIter, myThid ) |
| 161 |
|
| 162 |
C approximate Jacobian times vector by one-sided finite differences |
| 163 |
C and store in du/vIce |
| 164 |
DO bj = myByLo(myThid),myByHi(myThid) |
| 165 |
DO bi = myBxLo(myThid),myBxHi(myThid) |
| 166 |
DO I = 1, sNx |
| 167 |
DO J = 1, sNy |
| 168 |
duIce(I,J,bi,bj) = |
| 169 |
& (uIceResP(I,J,bi,bj)-uIceRes(I,J,bi,bj))*reps |
| 170 |
dvIce(I,J,bi,bj) = |
| 171 |
& (vIceResP(I,J,bi,bj)-vIceRes(I,J,bi,bj))*reps |
| 172 |
ENDDO |
| 173 |
ENDDO |
| 174 |
ENDDO |
| 175 |
ENDDO |
| 176 |
|
| 177 |
#endif /* SEAICE_ALLOW_JFNK */ |
| 178 |
|
| 179 |
RETURN |
| 180 |
END |
Parent Directory
| 
Revision Log
| 
Revision Graph