pkg/autodiff/adjoint_model.F_template


CBOI
C
C !TITLE: ADJOINT CODE
C !AUTHORS: mitgcm developers ( support@mitgcm.org )
C !AFFILIATION: Massachussetts Institute of Technology
C !DATE:
C !INTRODUCTION: adjoint code collection
c \bv
c Top level routine for adjoint code generation is the_main_loop.
c Adjoint code is generated via the makefile in adjoint/
c 0. make restore:
c    Re-instate header or adjoint_model.F from template
c 1. make:
c    All .f files are concatenated into one file
c    tamc_code_ecco.f
c 2. make adtaf:
c    This makefiles contains a list of all routines which must be
c    differentiated (i.e. analyzed by TAMC/TAF) and those which
c    must not be differentiated. For the latter, files containing
c    flow directives are given.
c    The code generated by TAMC/TAF is written to
c    tamc_code_ecco_ad.f
c 3. make adchange:
c    To maintain the multi-threading index mythid,
c    the adjoint code must be post-processed.
c    All parameter lists of active I/O routines 
c    (active read/write open/close) are augmented by mythid.
c    The resulting code is copied to
c    tamc_code_ecco_sed_ad.f
c    and concatenated to adjoint_model.F
c
c     Documentation:
c     ==============
c     For a documentation of TAMC see:
c     http://puddle.mit.edu/~ralf/tamc/tamc.html
c     For more info on TAF see:
c     http://www.fastopt.de
C \ev
CBOI

#include "CPP_OPTIONS.h"

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

C     !DESCRIPTION: \bv
c     ==================================================================
c     SUBROUTINE adjoint_model
c     ==================================================================
c     o This is just a place holder for the TAMC generated adjoint code
c       of the MITgcmuv and related routines. Below you find a short
c       description of some topics pertaining to the adjoint model.
c       This routine will be overwritten as soon as TAMC will have
c       generated the adjoint model. If you want to keep it copy it
c       to another place.
c     started: Christian Eckert eckert@mit.edu 21-Jul-1999
c     ==================================================================
c     SUBROUTINE adjoint_model
c     ==================================================================
C     \ev

C     !USES:
      implicit none

c     == routine arguments ==

      integer mythid

c     == end of interface ==
CEOP

      return
      end
1	heimbach	1.1
2	heimbach	1.2	CBOI
3			C
4			C !TITLE: ADJOINT CODE
5			C !AUTHORS: mitgcm developers ( support@mitgcm.org )
6			C !AFFILIATION: Massachussetts Institute of Technology
7			C !DATE:
8			C !INTRODUCTION: adjoint code collection
9			c \bv
10			c Top level routine for adjoint code generation is the_main_loop.
11			c Adjoint code is generated via the makefile in adjoint/
12			c 0. make restore:
13			c Re-instate header or adjoint_model.F from template
14			c 1. make:
15			c All .f files are concatenated into one file
16			c tamc_code_ecco.f
17			c 2. make adtaf:
18			c This makefiles contains a list of all routines which must be
19			c differentiated (i.e. analyzed by TAMC/TAF) and those which
20			c must not be differentiated. For the latter, files containing
21			c flow directives are given.
22			c The code generated by TAMC/TAF is written to
23			c tamc_code_ecco_ad.f
24			c 3. make adchange:
25			c To maintain the multi-threading index mythid,
26			c the adjoint code must be post-processed.
27			c All parameter lists of active I/O routines
28			c (active read/write open/close) are augmented by mythid.
29			c The resulting code is copied to
30			c tamc_code_ecco_sed_ad.f
31			c and concatenated to adjoint_model.F
32			c
33			c Documentation:
34			c ==============
35			c For a documentation of TAMC see:
36			c http://puddle.mit.edu/~ralf/tamc/tamc.html
37			c For more info on TAF see:
38			c http://www.fastopt.de
39			C \ev
40			CBOI
41
42	heimbach	1.1	#include "CPP_OPTIONS.h"
43
44	heimbach	1.2	CBOP
45			C !ROUTINE: adjoint_model
46			C !INTERFACE:
47			subroutine adjoint_model(mythid )
48	heimbach	1.1
49	heimbach	1.2	C !DESCRIPTION: \bv
50	heimbach	1.1	c ==================================================================
51			c SUBROUTINE adjoint_model
52			c ==================================================================
53			c o This is just a place holder for the TAMC generated adjoint code
54			c of the MITgcmuv and related routines. Below you find a short
55			c description of some topics pertaining to the adjoint model.
56			c This routine will be overwritten as soon as TAMC will have
57			c generated the adjoint model. If you want to keep it copy it
58			c to another place.
59			c started: Christian Eckert eckert@mit.edu 21-Jul-1999
60			c ==================================================================
61			c SUBROUTINE adjoint_model
62			c ==================================================================
63	heimbach	1.2	C \ev
64	heimbach	1.1
65	heimbach	1.2	C !USES:
66	heimbach	1.1	implicit none
67
68			c == routine arguments ==
69
70			integer mythid
71
72			c == end of interface ==
73	heimbach	1.2	CEOP
74	heimbach	1.1
75			return
76			end