pkg/grdchk/grdchk_main.F

C $Header: /u/gcmpack/MITgcm/pkg/grdchk/grdchk_main.F,v 1.38 2012/08/21 14:00:04 gforget Exp $
C $Name:  $

#include "GRDCHK_OPTIONS.h"
#include "AD_CONFIG.h"

CBOI
C
C !TITLE: GRADIENT CHECK
C !AUTHORS: mitgcm developers ( support@mitgcm.org )
C !AFFILIATION: Massachussetts Institute of Technology
C !DATE:
C !INTRODUCTION: gradient check package
c \bv
c Compare the gradients calculated by the adjoint model with
c finite difference approximations.
c
C     !CALLING SEQUENCE:
c
c the_model_main
c |
c |-- ctrl_unpack
c |-- adthe_main_loop          - unperturbed cost function and
c |-- ctrl_pack                  adjoint gradient are computed here
c |
c |-- grdchk_main
c     |
c     |-- grdchk_init
c     |-- do icomp=...        - loop over control vector elements
c         |
c         |-- grdchk_loc      - determine location of icomp on grid
c         |
c         |-- grdchk_getxx    - get control vector component from file
c         |                     perturb it and write back to file
c         |-- grdchk_getadxx  - get gradient component calculated
c         |                     via adjoint
c         |-- the_main_loop   - forward run and cost evaluation
c         |                     with perturbed control vector element
c         |-- calculate ratio of adj. vs. finite difference gradient
c         |
c         |-- grdchk_setxx    - Reset control vector element
c         |
c         |-- grdchk_print    - print results
c \ev
CEOI

CBOP
C     !ROUTINE: grdchk_main
C     !INTERFACE:
      subroutine grdchk_main( mythid )

C     !DESCRIPTION: \bv
c     ==================================================================
c     SUBROUTINE grdchk_main
c     ==================================================================
c     o Compare the gradients calculated by the adjoint model with
c       finite difference approximations.
c     started: Christian Eckert eckert@mit.edu 24-Feb-2000
c     continued&finished: heimbach@mit.edu: 13-Jun-2001
c     changed: mlosch@ocean.mit.edu: 09-May-2002
c              - added centered difference vs. 1-sided difference option
c              - improved output format for readability
c              - added control variable hFacC
c              heimbach@mit.edu 24-Feb-2003
c              - added tangent linear gradient checks
c              - fixes for multiproc. gradient checks
c              - added more control variables
c
c     ==================================================================
c     SUBROUTINE grdchk_main
c     ==================================================================
C     \ev

C     !USES:
      implicit none

c     == global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "grdchk.h"
#include "cost.h"
#include "ctrl.h"
#ifdef ALLOW_TANGENTLINEAR_RUN
#include "g_cost.h"
#endif

C     !INPUT/OUTPUT PARAMETERS:
c     == routine arguments ==
      integer mythid

#ifdef ALLOW_GRDCHK
C     !LOCAL VARIABLES:
c     == local variables ==
      integer myiter
      _RL     mytime
      integer bi, itlo, ithi
      integer bj, jtlo, jthi
      integer i,  imin, imax
      integer j,  jmin, jmax
      integer k

      integer icomp
      integer ichknum
      integer icvrec
      integer jtile
      integer itile
      integer layer
      integer obcspos
      integer itilepos
      integer jtilepos
      integer icglo
      integer itest
      integer ierr
      integer ierr_grdchk
      _RL     gfd
      _RL     fcref
      _RL     fcpertplus, fcpertminus
      _RL     ratio_ad
      _RL     ratio_ftl
      _RL     xxmemo_ref
      _RL     xxmemo_pert
      _RL     adxxmemo
      _RL     ftlxxmemo
      _RL     localEps
      _RL     grdchk_epsfac

      _RL tmpplot1(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
      _RL tmpplot2(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
      _RL tmpplot3(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)

      CHARACTER*(MAX_LEN_MBUF) msgBuf

c     == end of interface ==
CEOP

c--   Set the loop ranges.
      jtlo = mybylo(mythid)
      jthi = mybyhi(mythid)
      itlo = mybxlo(mythid)
      ithi = mybxhi(mythid)
      jmin = 1
      jmax = sny
      imin = 1
      imax = snx

      print *, 'ph-check entering grdchk_main '

c--   initialise variables
      call grdchk_init( mythid )

c--   Compute the adjoint model gradients.
c--   Compute the unperturbed cost function.
cph   Gradient via adjoint has already been computed,
cph   and so has unperturbed cost function,
cph   assuming all xx_ fields are initialised to zero.

      ierr      = 0
      ierr_grdchk = 0
      adxxmemo  = 0.
      ftlxxmemo = 0.
#ifdef ALLOW_ADMTLM
      fcref = objf_state_final(idep,jdep,1,1,1)
#else
      fcref = fc
#endif

      print *, 'ph-check fcref = ', fcref

      do bj = jtlo, jthi
         do bi = itlo, ithi
            do k = 1, nr
               do j = jmin, jmax
                  do i = imin, imax
                     tmpplot1(i,j,k,bi,bj) = 0. _d 0
                     tmpplot2(i,j,k,bi,bj) = 0. _d 0
                     tmpplot3(i,j,k,bi,bj) = 0. _d 0
                  end do
               end do
            end do
         end do
      end do

      if ( useCentralDiff ) then
         grdchk_epsfac = 2. _d 0
      else
         grdchk_epsfac = 1. _d 0
      end if

      WRITE(standardmessageunit,'(A)')
     &    'grad-res -------------------------------'
      WRITE(standardmessageunit,'(2a)')
     &    ' grad-res  proc    #    i    j    k   bi   bj iobc',
     &    '               fc ref           fc + eps           fc - eps'
#ifdef ALLOW_TANGENTLINEAR_RUN
      WRITE(standardmessageunit,'(2a)')
     &    ' grad-res  proc    #    i    j    k   bi   bj iobc',
     &    '             tlm grad            fd grad         1 - fd/tlm'
#else
      WRITE(standardmessageunit,'(2a)')
     &    ' grad-res  proc    #    i    j    k   bi   bj iobc',
     &    '             adj grad            fd grad         1 - fd/adj'
#endif

c--   Compute the finite difference approximations.
c--   Cycle through all processes doing NINT(nend-nbeg+1)/nstep
c--   gradient checks.

      if ( nbeg .EQ. 0 )
     &     call grdchk_get_position( mythid )

      do icomp = nbeg, nend, nstep

         ichknum = (icomp - nbeg)/nstep + 1
         adxxmemo  = 0.

cph(
cph-print         print *, 'ph-grd _main: nbeg, icomp, ichknum ',
cph-print     &        nbeg, icomp, ichknum
cph)
         if (ichknum .le. maxgrdchecks ) then

c--         Determine the location of icomp on the grid.
            if ( myProcId .EQ. grdchkwhichproc ) then
               call grdchk_loc( icomp, ichknum,
     &              icvrec, itile, jtile, layer, obcspos,
     &              itilepos, jtilepos, icglo, itest, ierr,
     &              mythid )
cph(
cph-print               print *, 'ph-grd ----- back from loc -----',
cph-print     &             icvrec, itilepos, jtilepos, layer, obcspos
cph)
            else
              icvrec   = 0
              itile    = 0
              jtile    = 0
              layer    = 0
              obcspos  = 0
              itilepos = 0
              jtilepos = 0
              icglo    = 0
              itest    = 0
            endif

c make sure that all procs have correct file records, so that useSingleCpuIO works
      CALL GLOBAL_SUM_INT( icvrec , myThid )
      CALL GLOBAL_SUM_INT( layer , myThid )
      CALL GLOBAL_SUM_INT( ierr , myThid )

c******************************************************
c--   (A): get gradient component calculated via adjoint
c******************************************************

c--   get gradient component calculated via adjoint
               call grdchk_getadxx( icvrec,
     &              itile, jtile, layer,
     &              itilepos, jtilepos,
     &              adxxmemo, ierr, mythid )
C--   Add a global-sum call so that all proc will get the adjoint gradient
            _GLOBAL_SUM_RL( adxxmemo, myThid )

#ifdef ALLOW_TANGENTLINEAR_RUN
c******************************************************
c--   (B): Get gradient component g_fc from tangent linear run:
c******************************************************
c--
c--   1. perturb control vector component: xx(i)=1.

               localEps = 1. _d 0
               call grdchk_getxx( icvrec, TANGENT_SIMULATION,
     &              itile, jtile, layer,
     &              itilepos, jtilepos,
     &              xxmemo_ref, xxmemo_pert, localEps,
     &              ierr, mythid )

c--
c--   2. perform tangent linear run
            mytime = starttime
            myiter = niter0
#ifdef ALLOW_ADMTLM
            do k=1,4*Nr+1
             do j=1,sny
              do i=1,snx
               g_objf_state_final(i,j,1,1,k) = 0.
              enddo
             enddo
            enddo
#else
            g_fc = 0.
#endif

            call g_the_main_loop( mytime, myiter, mythid )
#ifdef ALLOW_ADMTLM
            ftlxxmemo = g_objf_state_final(idep,jdep,1,1,1)
#else
            ftlxxmemo = g_fc
#endif

c--
c--   3. reset control vector
               call grdchk_setxx( icvrec, TANGENT_SIMULATION,
     &              itile, jtile, layer,
     &              itilepos, jtilepos,
     &              xxmemo_ref, ierr, mythid )

#endif /* ALLOW_TANGENTLINEAR_RUN */


c******************************************************
c--   (C): Get gradient via finite difference perturbation
c******************************************************

c--   get control vector component from file
c--   perturb it and write back to file
c--   positive perturbation
            localEps = abs(grdchk_eps)
            call grdchk_getxx( icvrec, FORWARD_SIMULATION,
     &              itile, jtile, layer,
     &              itilepos, jtilepos,
     &              xxmemo_ref, xxmemo_pert, localEps,
     &              ierr, mythid )

c--   forward run with perturbed control vector
            mytime = starttime
            myiter = niter0
            call the_main_loop( mytime, myiter, mythid )
#ifdef ALLOW_ADMTLM
            fcpertplus = objf_state_final(idep,jdep,1,1,1)
#else
            fcpertplus = fc
#endif
            print *, 'ph-check fcpertplus  = ', fcpertplus

c--   Reset control vector.
            call grdchk_setxx( icvrec, FORWARD_SIMULATION,
     &              itile, jtile, layer,
     &              itilepos, jtilepos,
     &              xxmemo_ref, ierr, mythid )

            fcpertminus = fcref
            print *, 'ph-check fcpertminus = ', fcpertminus

            if ( useCentralDiff ) then

c--   get control vector component from file
c--   perturb it and write back to file
c--   repeat the proceedure for a negative perturbation
               localEps = - abs(grdchk_eps)
               call grdchk_getxx( icvrec, FORWARD_SIMULATION,
     &                 itile, jtile, layer,
     &                 itilepos, jtilepos,
     &                 xxmemo_ref, xxmemo_pert, localEps,
     &                 ierr, mythid )

c--   forward run with perturbed control vector
               mytime = starttime
               myiter = niter0
               call the_main_loop( mytime, myiter, mythid )
#ifdef ALLOW_ADMTLM
               fcpertminus = objf_state_final(idep,jdep,1,1,1)
#else
               fcpertminus = fc
#endif

c--   Reset control vector.
               call grdchk_setxx( icvrec, FORWARD_SIMULATION,
     &                 itile, jtile, layer,
     &                 itilepos, jtilepos,
     &                 xxmemo_ref, ierr, mythid )

c-- end of if useCentralDiff ...
            end if

c******************************************************
c--   (D): calculate relative differences between gradients
c******************************************************

            if ( grdchk_eps .eq. 0. ) then
               gfd = (fcpertplus-fcpertminus)
            else
               gfd = (fcpertplus-fcpertminus)
     &              /(grdchk_epsfac*grdchk_eps)
            endif

            if ( adxxmemo .eq. 0. ) then
               ratio_ad = abs( adxxmemo - gfd )
            else
               ratio_ad = 1. - gfd/adxxmemo
            endif

            if ( ftlxxmemo .eq. 0. ) then
               ratio_ftl = abs( ftlxxmemo - gfd )
            else
               ratio_ftl = 1. - gfd/ftlxxmemo
            endif

            if ( myProcId .EQ. grdchkwhichproc .AND.
     &           ierr .EQ. 0 ) then
               tmpplot1(itilepos,jtilepos,layer,itile,jtile)
     &              = gfd
               tmpplot2(itilepos,jtilepos,layer,itile,jtile)
     &              = ratio_ad
               tmpplot3(itilepos,jtilepos,layer,itile,jtile)
     &              = ratio_ftl
            endif

            if ( ierr .EQ. 0 ) then
               fcrmem      ( ichknum ) = fcref
               fcppmem     ( ichknum ) = fcpertplus
               fcpmmem     ( ichknum ) = fcpertminus
               xxmemref    ( ichknum ) = xxmemo_ref
               xxmempert   ( ichknum ) = xxmemo_pert
               gfdmem      ( ichknum ) = gfd
               adxxmem     ( ichknum ) = adxxmemo
               ftlxxmem    ( ichknum ) = ftlxxmemo
               ratioadmem  ( ichknum ) = ratio_ad
               ratioftlmem ( ichknum ) = ratio_ftl

               irecmem   ( ichknum ) = icvrec
               bimem     ( ichknum ) = itile
               bjmem     ( ichknum ) = jtile
               ilocmem   ( ichknum ) = itilepos
               jlocmem   ( ichknum ) = jtilepos
               klocmem   ( ichknum ) = layer
               iobcsmem  ( ichknum ) = obcspos
               icompmem  ( ichknum ) = icomp
               ichkmem   ( ichknum ) = ichknum
               itestmem  ( ichknum ) = itest
               ierrmem   ( ichknum ) = ierr
               icglomem  ( ichknum ) = icglo
            endif

            if ( myProcId .EQ. grdchkwhichproc .AND.
     &           ierr .EQ. 0 ) then

               WRITE(standardmessageunit,'(A)')
     &             'grad-res -------------------------------'
               WRITE(standardmessageunit,'(A,8I5,1x,1P3E19.11)')
     &              ' grad-res ',myprocid,ichknum,itilepos,jtilepos,
     &              layer,itile,jtile,obcspos,
     &              fcref, fcpertplus, fcpertminus
#ifdef ALLOW_TANGENTLINEAR_RUN
               WRITE(standardmessageunit,'(A,8I5,1x,1P3E19.11)')
     &              ' grad-res ',myprocid,ichknum,ichkmem(ichknum),
     &              icompmem(ichknum),itestmem(ichknum),
     &              bimem(ichknum),bjmem(ichknum),iobcsmem(ichknum),
     &              ftlxxmemo, gfd, ratio_ftl
#else
               WRITE(standardmessageunit,'(A,8I5,1x,1P3E19.11)')
     &              ' grad-res ',myprocid,ichknum,ichkmem(ichknum),
     &              icompmem(ichknum),itestmem(ichknum),
     &              bimem(ichknum),bjmem(ichknum),obcspos,
     &              adxxmemo, gfd, ratio_ad
#endif
            endif
#ifdef ALLOW_TANGENTLINEAR_RUN
            WRITE(msgBuf,'(A30,1PE22.14)')
     &              ' TLM  ref_cost_function      =', fcref
            CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                          SQUEEZE_RIGHT, myThid )
            WRITE(msgBuf,'(A30,1PE22.14)')
     &              ' TLM  tangent-lin_grad       =', ftlxxmemo
            CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                          SQUEEZE_RIGHT, myThid )
            WRITE(msgBuf,'(A30,1PE22.14)')
     &              ' TLM  finite-diff_grad       =', gfd
            CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                          SQUEEZE_RIGHT, myThid )
#else
            WRITE(msgBuf,'(A30,1PE22.14)')
     &              ' ADM  ref_cost_function      =', fcref
            CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                          SQUEEZE_RIGHT, myThid )
            WRITE(msgBuf,'(A30,1PE22.14)')
     &              ' ADM  adjoint_gradient       =', adxxmemo
            CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                          SQUEEZE_RIGHT, myThid )
            WRITE(msgBuf,'(A30,1PE22.14)')
     &              ' ADM  finite-diff_grad       =', gfd
            CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                          SQUEEZE_RIGHT, myThid )
#endif

            print *, 'ph-grd  ierr ---------------------------'
            print *, 'ph-grd  ierr = ', ierr, ', icomp = ', icomp,
     &           ', ichknum = ', ichknum

c-- else of if ( ichknum ...
         else
            ierr_grdchk = -1

c-- end of if ( ichknum ...
         endif

c-- end of do icomp = ...
      enddo

      if (myProcId .EQ. grdchkwhichproc .AND. .NOT.useSingleCpuIO) then
         CALL WRITE_REC_XYZ_RL(
     &        'grd_findiff'   , tmpplot1, 1, 0, myThid)
         CALL WRITE_REC_XYZ_RL(
     &        'grd_ratio_ad'  , tmpplot2, 1, 0, myThid)
         CALL WRITE_REC_XYZ_RL(
     &        'grd_ratio_ftl' , tmpplot3, 1, 0, myThid)
      endif

c--   Everyone has to wait for the component to be reset.
c     _BARRIER

c--   Print the results of the gradient check.
      call grdchk_print( ichknum, ierr_grdchk, mythid )

#endif /* ALLOW_GRDCHK */

      return
      end
1	gforget	1.39	C $Header: /u/gcmpack/MITgcm/pkg/grdchk/grdchk_main.F,v 1.38 2012/08/21 14:00:04 gforget Exp $
2	heimbach	1.11	C $Name: $
3	heimbach	1.2
4	jmc	1.31	#include "GRDCHK_OPTIONS.h"
5	jmc	1.36	#include "AD_CONFIG.h"
6	heimbach	1.2
7	heimbach	1.3	CBOI
8			C
9			C !TITLE: GRADIENT CHECK
10			C !AUTHORS: mitgcm developers ( support@mitgcm.org )
11			C !AFFILIATION: Massachussetts Institute of Technology
12			C !DATE:
13			C !INTRODUCTION: gradient check package
14			c \bv
15			c Compare the gradients calculated by the adjoint model with
16			c finite difference approximations.
17			c
18			C !CALLING SEQUENCE:
19			c
20			c the_model_main
21			c \|
22			c \|-- ctrl_unpack
23			c \|-- adthe_main_loop - unperturbed cost function and
24			c \|-- ctrl_pack adjoint gradient are computed here
25			c \|
26			c \|-- grdchk_main
27			c \|
28			c \|-- grdchk_init
29			c \|-- do icomp=... - loop over control vector elements
30			c \|
31			c \|-- grdchk_loc - determine location of icomp on grid
32			c \|
33			c \|-- grdchk_getxx - get control vector component from file
34			c \| perturb it and write back to file
35	jmc	1.31	c \|-- grdchk_getadxx - get gradient component calculated
36	heimbach	1.3	c \| via adjoint
37			c \|-- the_main_loop - forward run and cost evaluation
38			c \| with perturbed control vector element
39			c \|-- calculate ratio of adj. vs. finite difference gradient
40			c \|
41			c \|-- grdchk_setxx - Reset control vector element
42			c \|
43			c \|-- grdchk_print - print results
44			c \ev
45			CEOI
46
47			CBOP
48			C !ROUTINE: grdchk_main
49			C !INTERFACE:
50			subroutine grdchk_main( mythid )
51	heimbach	1.2
52	heimbach	1.3	C !DESCRIPTION: \bv
53	heimbach	1.2	c ==================================================================
54			c SUBROUTINE grdchk_main
55			c ==================================================================
56			c o Compare the gradients calculated by the adjoint model with
57			c finite difference approximations.
58			c started: Christian Eckert eckert@mit.edu 24-Feb-2000
59	heimbach	1.4	c continued&finished: heimbach@mit.edu: 13-Jun-2001
60			c changed: mlosch@ocean.mit.edu: 09-May-2002
61			c - added centered difference vs. 1-sided difference option
62			c - improved output format for readability
63			c - added control variable hFacC
64	heimbach	1.7	c heimbach@mit.edu 24-Feb-2003
65			c - added tangent linear gradient checks
66			c - fixes for multiproc. gradient checks
67			c - added more control variables
68	jmc	1.31	c
69	heimbach	1.2	c ==================================================================
70			c SUBROUTINE grdchk_main
71			c ==================================================================
72	heimbach	1.3	C \ev
73	heimbach	1.2
74	heimbach	1.3	C !USES:
75	heimbach	1.2	implicit none
76
77			c == global variables ==
78			#include "SIZE.h"
79			#include "EEPARAMS.h"
80			#include "PARAMS.h"
81			#include "grdchk.h"
82			#include "cost.h"
83	heimbach	1.21	#include "ctrl.h"
84	heimbach	1.9	#ifdef ALLOW_TANGENTLINEAR_RUN
85			#include "g_cost.h"
86			#endif
87	heimbach	1.2
88	heimbach	1.3	C !INPUT/OUTPUT PARAMETERS:
89	heimbach	1.2	c == routine arguments ==
90	jmc	1.31	integer mythid
91	heimbach	1.2
92	heimbach	1.11	#ifdef ALLOW_GRDCHK
93	heimbach	1.3	C !LOCAL VARIABLES:
94	heimbach	1.2	c == local variables ==
95			integer myiter
96	jmc	1.31	_RL mytime
97	heimbach	1.2	integer bi, itlo, ithi
98			integer bj, jtlo, jthi
99			integer i, imin, imax
100			integer j, jmin, jmax
101			integer k
102
103			integer icomp
104			integer ichknum
105			integer icvrec
106			integer jtile
107			integer itile
108			integer layer
109	heimbach	1.8	integer obcspos
110	heimbach	1.2	integer itilepos
111			integer jtilepos
112	heimbach	1.19	integer icglo
113	heimbach	1.2	integer itest
114			integer ierr
115			integer ierr_grdchk
116			_RL gfd
117			_RL fcref
118	heimbach	1.4	_RL fcpertplus, fcpertminus
119	heimbach	1.6	_RL ratio_ad
120			_RL ratio_ftl
121	heimbach	1.2	_RL xxmemo_ref
122			_RL xxmemo_pert
123			_RL adxxmemo
124	heimbach	1.6	_RL ftlxxmemo
125			_RL localEps
126			_RL grdchk_epsfac
127
128	heimbach	1.7	_RL tmpplot1(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
129			_RL tmpplot2(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
130			_RL tmpplot3(1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
131
132	heimbach	1.12	CHARACTER*(MAX_LEN_MBUF) msgBuf
133
134	heimbach	1.2	c == end of interface ==
135	heimbach	1.3	CEOP
136	heimbach	1.2
137			c-- Set the loop ranges.
138			jtlo = mybylo(mythid)
139			jthi = mybyhi(mythid)
140			itlo = mybxlo(mythid)
141			ithi = mybxhi(mythid)
142			jmin = 1
143			jmax = sny
144			imin = 1
145			imax = snx
146
147	heimbach	1.16	print *, 'ph-check entering grdchk_main '
148
149	heimbach	1.2	c-- initialise variables
150			call grdchk_init( mythid )
151
152	jmc	1.29	c-- Compute the adjoint model gradients.
153	heimbach	1.2	c-- Compute the unperturbed cost function.
154	heimbach	1.7	cph Gradient via adjoint has already been computed,
155			cph and so has unperturbed cost function,
156			cph assuming all xx_ fields are initialised to zero.
157	heimbach	1.2
158	heimbach	1.28	ierr = 0
159	heimbach	1.9	ierr_grdchk = 0
160	heimbach	1.27	adxxmemo = 0.
161			ftlxxmemo = 0.
162	heimbach	1.21	#ifdef ALLOW_ADMTLM
163			fcref = objf_state_final(idep,jdep,1,1,1)
164			#else
165	heimbach	1.2	fcref = fc
166	heimbach	1.21	#endif
167	heimbach	1.9
168			print *, 'ph-check fcref = ', fcref
169	heimbach	1.2
170			do bj = jtlo, jthi
171			do bi = itlo, ithi
172			do k = 1, nr
173			do j = jmin, jmax
174			do i = imin, imax
175			tmpplot1(i,j,k,bi,bj) = 0. _d 0
176			tmpplot2(i,j,k,bi,bj) = 0. _d 0
177	heimbach	1.6	tmpplot3(i,j,k,bi,bj) = 0. _d 0
178	heimbach	1.2	end do
179			end do
180			end do
181			end do
182			end do
183
184	heimbach	1.4	if ( useCentralDiff ) then
185			grdchk_epsfac = 2. _d 0
186			else
187			grdchk_epsfac = 1. _d 0
188			end if
189
190	heimbach	1.23	WRITE(standardmessageunit,'(A)')
191			& 'grad-res -------------------------------'
192			WRITE(standardmessageunit,'(2a)')
193	heimbach	1.19	& ' grad-res proc # i j k bi bj iobc',
194	heimbach	1.18	& ' fc ref fc + eps fc - eps'
195	heimbach	1.7	#ifdef ALLOW_TANGENTLINEAR_RUN
196	heimbach	1.23	WRITE(standardmessageunit,'(2a)')
197	heimbach	1.19	& ' grad-res proc # i j k bi bj iobc',
198	heimbach	1.18	& ' tlm grad fd grad 1 - fd/tlm'
199	heimbach	1.7	#else
200	heimbach	1.23	WRITE(standardmessageunit,'(2a)')
201	heimbach	1.19	& ' grad-res proc # i j k bi bj iobc',
202	heimbach	1.18	& ' adj grad fd grad 1 - fd/adj'
203	heimbach	1.7	#endif
204
205	heimbach	1.2	c-- Compute the finite difference approximations.
206			c-- Cycle through all processes doing NINT(nend-nbeg+1)/nstep
207			c-- gradient checks.
208	heimbach	1.14
209	jmc	1.31	if ( nbeg .EQ. 0 )
210	heimbach	1.17	& call grdchk_get_position( mythid )
211	heimbach	1.2
212	heimbach	1.7	do icomp = nbeg, nend, nstep
213	heimbach	1.2
214	heimbach	1.7	ichknum = (icomp - nbeg)/nstep + 1
215	jmc	1.32	adxxmemo = 0.
216	heimbach	1.2
217	heimbach	1.19	cph(
218	jmc	1.31	cph-print print *, 'ph-grd _main: nbeg, icomp, ichknum ',
219	heimbach	1.19	cph-print & nbeg, icomp, ichknum
220			cph)
221	heimbach	1.7	if (ichknum .le. maxgrdchecks ) then
222	heimbach	1.2
223	heimbach	1.7	c-- Determine the location of icomp on the grid.
224			if ( myProcId .EQ. grdchkwhichproc ) then
225	jmc	1.31	call grdchk_loc( icomp, ichknum,
226	heimbach	1.8	& icvrec, itile, jtile, layer, obcspos,
227	heimbach	1.19	& itilepos, jtilepos, icglo, itest, ierr,
228	heimbach	1.7	& mythid )
229	heimbach	1.18	cph(
230	heimbach	1.19	cph-print print *, 'ph-grd ----- back from loc -----',
231			cph-print & icvrec, itilepos, jtilepos, layer, obcspos
232	heimbach	1.18	cph)
233	jmc	1.34	else
234	jmc	1.35	icvrec = 0
235	jmc	1.34	itile = 0
236			jtile = 0
237			layer = 0
238	jmc	1.35	obcspos = 0
239	jmc	1.34	itilepos = 0
240			jtilepos = 0
241	jmc	1.35	icglo = 0
242			itest = 0
243	heimbach	1.7	endif
244	jmc	1.31
245	gforget	1.38	c make sure that all procs have correct file records, so that useSingleCpuIO works
246			CALL GLOBAL_SUM_INT( icvrec , myThid )
247			CALL GLOBAL_SUM_INT( layer , myThid )
248	gforget	1.39	CALL GLOBAL_SUM_INT( ierr , myThid )
249	gforget	1.38
250	heimbach	1.6	c******************************************************
251			c-- (A): get gradient component calculated via adjoint
252			c******************************************************
253	heimbach	1.7
254			c-- get gradient component calculated via adjoint
255			call grdchk_getadxx( icvrec,
256			& itile, jtile, layer,
257			& itilepos, jtilepos,
258	gforget	1.38	& adxxmemo, ierr, mythid )
259	jmc	1.32	C-- Add a global-sum call so that all proc will get the adjoint gradient
260			_GLOBAL_SUM_RL( adxxmemo, myThid )
261	heimbach	1.4
262	heimbach	1.6	#ifdef ALLOW_TANGENTLINEAR_RUN
263			c******************************************************
264			c-- (B): Get gradient component g_fc from tangent linear run:
265			c******************************************************
266			c--
267			c-- 1. perturb control vector component: xx(i)=1.
268
269	heimbach	1.7	localEps = 1. _d 0
270			call grdchk_getxx( icvrec, TANGENT_SIMULATION,
271			& itile, jtile, layer,
272			& itilepos, jtilepos,
273			& xxmemo_ref, xxmemo_pert, localEps,
274	gforget	1.38	& ierr, mythid )
275	heimbach	1.6
276			c--
277			c-- 2. perform tangent linear run
278	heimbach	1.7	mytime = starttime
279			myiter = niter0
280	heimbach	1.21	#ifdef ALLOW_ADMTLM
281			do k=1,4*Nr+1
282			do j=1,sny
283			do i=1,snx
284			g_objf_state_final(i,j,1,1,k) = 0.
285			enddo
286			enddo
287			enddo
288			#else
289	heimbach	1.7	g_fc = 0.
290	heimbach	1.21	#endif
291
292	heimbach	1.7	call g_the_main_loop( mytime, myiter, mythid )
293	heimbach	1.21	#ifdef ALLOW_ADMTLM
294			ftlxxmemo = g_objf_state_final(idep,jdep,1,1,1)
295			#else
296	heimbach	1.7	ftlxxmemo = g_fc
297	heimbach	1.21	#endif
298
299	heimbach	1.6	c--
300			c-- 3. reset control vector
301	heimbach	1.7	call grdchk_setxx( icvrec, TANGENT_SIMULATION,
302			& itile, jtile, layer,
303			& itilepos, jtilepos,
304	gforget	1.38	& xxmemo_ref, ierr, mythid )
305	heimbach	1.7
306			#endif /* ALLOW_TANGENTLINEAR_RUN */
307
308	heimbach	1.6
309			c******************************************************
310			c-- (C): Get gradient via finite difference perturbation
311			c******************************************************
312
313	heimbach	1.2	c-- get control vector component from file
314	heimbach	1.7	c-- perturb it and write back to file
315	heimbach	1.6	c-- positive perturbation
316	heimbach	1.7	localEps = abs(grdchk_eps)
317	gforget	1.38	call grdchk_getxx( icvrec, FORWARD_SIMULATION,
318	heimbach	1.7	& itile, jtile, layer,
319			& itilepos, jtilepos,
320			& xxmemo_ref, xxmemo_pert, localEps,
321	gforget	1.38	& ierr, mythid )
322	jmc	1.31
323	heimbach	1.4	c-- forward run with perturbed control vector
324	heimbach	1.7	mytime = starttime
325			myiter = niter0
326			call the_main_loop( mytime, myiter, mythid )
327	heimbach	1.21	#ifdef ALLOW_ADMTLM
328			fcpertplus = objf_state_final(idep,jdep,1,1,1)
329			#else
330	heimbach	1.7	fcpertplus = fc
331	heimbach	1.21	#endif
332	jmc	1.37	print *, 'ph-check fcpertplus = ', fcpertplus
333	jmc	1.31
334	heimbach	1.4	c-- Reset control vector.
335	gforget	1.38	call grdchk_setxx( icvrec, FORWARD_SIMULATION,
336	heimbach	1.7	& itile, jtile, layer,
337			& itilepos, jtilepos,
338	gforget	1.38	& xxmemo_ref, ierr, mythid )
339	heimbach	1.2
340	heimbach	1.7	fcpertminus = fcref
341	heimbach	1.13	print *, 'ph-check fcpertminus = ', fcpertminus
342	heimbach	1.4
343	heimbach	1.7	if ( useCentralDiff ) then
344	heimbach	1.4
345	heimbach	1.6	c-- get control vector component from file
346	heimbach	1.7	c-- perturb it and write back to file
347	heimbach	1.4	c-- repeat the proceedure for a negative perturbation
348	gforget	1.38	localEps = - abs(grdchk_eps)
349			call grdchk_getxx( icvrec, FORWARD_SIMULATION,
350	heimbach	1.7	& itile, jtile, layer,
351			& itilepos, jtilepos,
352			& xxmemo_ref, xxmemo_pert, localEps,
353	gforget	1.38	& ierr, mythid )
354	jmc	1.31
355	heimbach	1.2	c-- forward run with perturbed control vector
356	heimbach	1.7	mytime = starttime
357			myiter = niter0
358			call the_main_loop( mytime, myiter, mythid )
359	heimbach	1.21	#ifdef ALLOW_ADMTLM
360			fcpertminus = objf_state_final(idep,jdep,1,1,1)
361			#else
362	heimbach	1.7	fcpertminus = fc
363	heimbach	1.21	#endif
364	jmc	1.31
365	heimbach	1.4	c-- Reset control vector.
366	gforget	1.38	call grdchk_setxx( icvrec, FORWARD_SIMULATION,
367	heimbach	1.7	& itile, jtile, layer,
368			& itilepos, jtilepos,
369	gforget	1.38	& xxmemo_ref, ierr, mythid )
370	heimbach	1.7
371			c-- end of if useCentralDiff ...
372			end if
373	heimbach	1.4
374	heimbach	1.6	c******************************************************
375			c-- (D): calculate relative differences between gradients
376			c******************************************************
377
378	jmc	1.33	if ( grdchk_eps .eq. 0. ) then
379			gfd = (fcpertplus-fcpertminus)
380			else
381			gfd = (fcpertplus-fcpertminus)
382			& /(grdchk_epsfac*grdchk_eps)
383			endif
384	heimbach	1.2
385	jmc	1.33	if ( adxxmemo .eq. 0. ) then
386			ratio_ad = abs( adxxmemo - gfd )
387			else
388			ratio_ad = 1. - gfd/adxxmemo
389			endif
390	jmc	1.31
391	jmc	1.33	if ( ftlxxmemo .eq. 0. ) then
392			ratio_ftl = abs( ftlxxmemo - gfd )
393			else
394			ratio_ftl = 1. - gfd/ftlxxmemo
395			endif
396	heimbach	1.7
397	jmc	1.33	if ( myProcId .EQ. grdchkwhichproc .AND.
398			& ierr .EQ. 0 ) then
399	heimbach	1.7	tmpplot1(itilepos,jtilepos,layer,itile,jtile)
400			& = gfd
401			tmpplot2(itilepos,jtilepos,layer,itile,jtile)
402			& = ratio_ad
403			tmpplot3(itilepos,jtilepos,layer,itile,jtile)
404			& = ratio_ftl
405	jmc	1.34	endif
406	heimbach	1.7
407	jmc	1.34	if ( ierr .EQ. 0 ) then
408	heimbach	1.7	fcrmem ( ichknum ) = fcref
409			fcppmem ( ichknum ) = fcpertplus
410			fcpmmem ( ichknum ) = fcpertminus
411			xxmemref ( ichknum ) = xxmemo_ref
412			xxmempert ( ichknum ) = xxmemo_pert
413			gfdmem ( ichknum ) = gfd
414			adxxmem ( ichknum ) = adxxmemo
415			ftlxxmem ( ichknum ) = ftlxxmemo
416			ratioadmem ( ichknum ) = ratio_ad
417			ratioftlmem ( ichknum ) = ratio_ftl
418
419			irecmem ( ichknum ) = icvrec
420			bimem ( ichknum ) = itile
421			bjmem ( ichknum ) = jtile
422			ilocmem ( ichknum ) = itilepos
423			jlocmem ( ichknum ) = jtilepos
424			klocmem ( ichknum ) = layer
425	heimbach	1.8	iobcsmem ( ichknum ) = obcspos
426	heimbach	1.7	icompmem ( ichknum ) = icomp
427			ichkmem ( ichknum ) = ichknum
428			itestmem ( ichknum ) = itest
429			ierrmem ( ichknum ) = ierr
430	heimbach	1.19	icglomem ( ichknum ) = icglo
431	jmc	1.34	endif
432
433			if ( myProcId .EQ. grdchkwhichproc .AND.
434			& ierr .EQ. 0 ) then
435	heimbach	1.19
436	heimbach	1.23	WRITE(standardmessageunit,'(A)')
437			& 'grad-res -------------------------------'
438	jmc	1.32	WRITE(standardmessageunit,'(A,8I5,1x,1P3E19.11)')
439	heimbach	1.23	& ' grad-res ',myprocid,ichknum,itilepos,jtilepos,
440	heimbach	1.19	& layer,itile,jtile,obcspos,
441	heimbach	1.7	& fcref, fcpertplus, fcpertminus
442			#ifdef ALLOW_TANGENTLINEAR_RUN
443	jmc	1.32	WRITE(standardmessageunit,'(A,8I5,1x,1P3E19.11)')
444	heimbach	1.23	& ' grad-res ',myprocid,ichknum,ichkmem(ichknum),
445	heimbach	1.19	& icompmem(ichknum),itestmem(ichknum),
446			& bimem(ichknum),bjmem(ichknum),iobcsmem(ichknum),
447	heimbach	1.7	& ftlxxmemo, gfd, ratio_ftl
448			#else
449	jmc	1.32	WRITE(standardmessageunit,'(A,8I5,1x,1P3E19.11)')
450	heimbach	1.23	& ' grad-res ',myprocid,ichknum,ichkmem(ichknum),
451	heimbach	1.19	& icompmem(ichknum),itestmem(ichknum),
452			& bimem(ichknum),bjmem(ichknum),obcspos,
453	heimbach	1.7	& adxxmemo, gfd, ratio_ad
454	jmc	1.32	#endif
455			endif
456			#ifdef ALLOW_TANGENTLINEAR_RUN
457	jmc	1.37	WRITE(msgBuf,'(A30,1PE22.14)')
458			& ' TLM ref_cost_function =', fcref
459			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
460			& SQUEEZE_RIGHT, myThid )
461			WRITE(msgBuf,'(A30,1PE22.14)')
462			& ' TLM tangent-lin_grad =', ftlxxmemo
463			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
464			& SQUEEZE_RIGHT, myThid )
465			WRITE(msgBuf,'(A30,1PE22.14)')
466			& ' TLM finite-diff_grad =', gfd
467			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
468			& SQUEEZE_RIGHT, myThid )
469	jmc	1.32	#else
470	jmc	1.33	WRITE(msgBuf,'(A30,1PE22.14)')
471			& ' ADM ref_cost_function =', fcref
472			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
473			& SQUEEZE_RIGHT, myThid )
474			WRITE(msgBuf,'(A30,1PE22.14)')
475			& ' ADM adjoint_gradient =', adxxmemo
476			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
477			& SQUEEZE_RIGHT, myThid )
478			WRITE(msgBuf,'(A30,1PE22.14)')
479			& ' ADM finite-diff_grad =', gfd
480			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
481			& SQUEEZE_RIGHT, myThid )
482	heimbach	1.7	#endif
483
484			print *, 'ph-grd ierr ---------------------------'
485			print *, 'ph-grd ierr = ', ierr, ', icomp = ', icomp,
486			& ', ichknum = ', ichknum
487
488			c-- else of if ( ichknum ...
489			else
490			ierr_grdchk = -1
491
492	jmc	1.31	c-- end of if ( ichknum ...
493	heimbach	1.2	endif
494
495	jmc	1.31	c-- end of do icomp = ...
496	heimbach	1.7	enddo
497	heimbach	1.2
498	gforget	1.38	if (myProcId .EQ. grdchkwhichproc .AND. .NOT.useSingleCpuIO) then
499	jmc	1.31	CALL WRITE_REC_XYZ_RL(
500	heimbach	1.7	& 'grd_findiff' , tmpplot1, 1, 0, myThid)
501	jmc	1.31	CALL WRITE_REC_XYZ_RL(
502	heimbach	1.7	& 'grd_ratio_ad' , tmpplot2, 1, 0, myThid)
503	jmc	1.31	CALL WRITE_REC_XYZ_RL(
504	heimbach	1.7	& 'grd_ratio_ftl' , tmpplot3, 1, 0, myThid)
505			endif
506	heimbach	1.2
507	heimbach	1.7	c-- Everyone has to wait for the component to be reset.
508	jmc	1.37	c _BARRIER
509	heimbach	1.2
510			c-- Print the results of the gradient check.
511			call grdchk_print( ichknum, ierr_grdchk, mythid )
512
513	heimbach	1.11	#endif /* ALLOW_GRDCHK */
514	heimbach	1.2
515	jmc	1.31	return
516	heimbach	1.2	end