pkg/autodiff/adopen_adclose.F


#include "CPP_OPTIONS.h"

c     ==================================================================
c
c     adopen_adclose.F: Routines to handle the I/O of the TAMC generated
c                       code. All files are direct access files.
c     Routines:
c
c     o  adopen  - Open file  (here a dummy routine).
c     o  adclose - Close file (here a dummy routine).
c
c
c     The following input veriables are used throughout in the argument
c     lists:
c
c     name   -  character 
c                 On entry, name is the extended tape name.
c     len    -  integer 
c                 On entry, len is the number of characters in name.
c     tid    -  integer 
c                 On entry, tid identifies the tape.
c     vid    -  integer
c                 On entry, vid identifies the variable to be stored on
c                 the tape.
c     var    -  real array of dimension length 
c                 On entry, var contains the values to be stored.
c                           var must not be changed.
c     size   -  integer 
c                 On entry, size is the size in bytes of the type of
c                           variable var.
c     length -  integer 
c                 On entry, length is the dimension of the variable
c                           stored on the tape.
c     irec   -  integer 
c                 On entry, irec is the record number to be written.
c     mythid -  integer
c                 On entry, mythid is the number of the thread or
c                           instance of the program.
c     myiter -  integer
c                 On entry, myiter is the current iteration step during
c                           the integration.
c
c     For further details on this see the TAMC Users Manual, Appendix B,
c     User defined Storage Subroutines.
c
c     TAMC does not provide the two leading arguments mythid and myiter
c     when compiling the MITgcmUV code. Instead the is a sed script avail-
c     able that does change the TAMC-generated adjoint code.
c
c     Only the master thread is allowed to write data and only gobal
c     model arrays are allowed to be written be the subsequent routines.
c     Tiled data are to be stored in common blocks. This implies that at
c     least a two level checkpointing for the adjoint code has to be
c     available.
c
c     ==================================================================


CBOP
C     !ROUTINE: adopen
C     !INTERFACE:
      subroutine adopen(
     I                   mythid,
cph(
cph     I                   myiter,
cph)
     I                   name,
     I                   len,
     I                   tid,
     I                   vid,
     I                   size,
     I                   length
     &                 )

C     !DESCRIPTION: \bv
c     ==================================================================
c     SUBROUTINE adopen
c     ==================================================================
c     o Dummy routine expected to be available by TAMC I/O.
c     This routine is simply a dummy routine expected to be available by
c     the Tangent Linear and Adjoint Model Compiler(TAMC). Files are
c     opened and closed by the routines that are called by *adread* and
c     *adwrite*.
c     started: Christian Eckert eckert@mit.edu 30-Jun-1999
c     ==================================================================
c     SUBROUTINE adopen
c     ==================================================================
C     \ev

C     !USES:
      implicit none

c     == global variables ==

C     !INPUT/OUTPUT PARAMETERS:
c     == routine arguments ==
c     name   -  extended tape name.
c     len    -  number of characters in name.
c     tid    -  tape identifier.
c     vid    -  identifies the variable to be stored on tape.
c     size   -  size in bytes of the type of variable var.
c     length -  dimension of the variable stored on the tape.
c     mythid -  number of the thread or instance of the program.

      integer mythid
cph(
cph      integer myiter
cph)
      character*(*) name
      integer len
      integer tid
      integer vid
      integer size
      integer length

C     !LOCAL VARIABLES:
c     == local variables ==

c     == end of interface ==
CEOP

      return
      end


CBOP
C     !ROUTINE: adclose
C     !INTERFACE:
      subroutine adclose(
     I                    mythid,
cph(
cph     I                    myiter,
cph)
     I                    name,
     I                    len,
     I                    tid,
     I                    vid,
     I                    size,
     I                    length
     &                  )


C     !DESCRIPTION: \bv
c     ==================================================================
c     SUBROUTINE adclose
c     ==================================================================
c     o Dummy routine expected to be available by TAMC I/O.
c     This routine is simply a dummy routine expected to be available by
c     the Tangent Linear and Adjoint Model Compiler(TAMC). Files are
c     opened and closed by the routines that are called by *adread* and
c     *adwrite*.
c     started: Christian Eckert eckert@mit.edu 30-Jun-1999
c     ==================================================================
c     SUBROUTINE adclose
c     ==================================================================
C     \ev

C     !USES:
      implicit none

c     == global variables ==

C     !INPUT/OUTPUT PARAMETERS:
c     == routine arguments ==
c     name   -  extended tape name.
c     len    -  number of characters in name.
c     tid    -  tape identifier.
c     vid    -  identifies the variable to be stored on tape.
c     size   -  size in bytes of the type of variable var.
c     length -  dimension of the variable stored on the tape.
c     mythid -  number of the thread or instance of the program.

      integer mythid
cph(
cph      integer myiter
cph)
      character*(*) name
      integer len
      integer tid
      integer vid
      integer size
      integer length

C     !LOCAL VARIABLES:
c     == local variables ==

c     == end of interface ==
CEOP

      return
      end
1	heimbach	1.1
2			#include "CPP_OPTIONS.h"
3
4			c ==================================================================
5			c
6			c adopen_adclose.F: Routines to handle the I/O of the TAMC generated
7			c code. All files are direct access files.
8			c Routines:
9			c
10			c o adopen - Open file (here a dummy routine).
11			c o adclose - Close file (here a dummy routine).
12			c
13			c
14			c The following input veriables are used throughout in the argument
15			c lists:
16			c
17			c name - character
18			c On entry, name is the extended tape name.
19			c len - integer
20			c On entry, len is the number of characters in name.
21			c tid - integer
22			c On entry, tid identifies the tape.
23			c vid - integer
24			c On entry, vid identifies the variable to be stored on
25			c the tape.
26			c var - real array of dimension length
27			c On entry, var contains the values to be stored.
28			c var must not be changed.
29			c size - integer
30			c On entry, size is the size in bytes of the type of
31			c variable var.
32			c length - integer
33			c On entry, length is the dimension of the variable
34			c stored on the tape.
35			c irec - integer
36			c On entry, irec is the record number to be written.
37			c mythid - integer
38			c On entry, mythid is the number of the thread or
39			c instance of the program.
40			c myiter - integer
41			c On entry, myiter is the current iteration step during
42			c the integration.
43			c
44			c For further details on this see the TAMC Users Manual, Appendix B,
45			c User defined Storage Subroutines.
46			c
47			c TAMC does not provide the two leading arguments mythid and myiter
48			c when compiling the MITgcmUV code. Instead the is a sed script avail-
49			c able that does change the TAMC-generated adjoint code.
50			c
51			c Only the master thread is allowed to write data and only gobal
52			c model arrays are allowed to be written be the subsequent routines.
53			c Tiled data are to be stored in common blocks. This implies that at
54			c least a two level checkpointing for the adjoint code has to be
55			c available.
56			c
57			c ==================================================================
58
59
60	heimbach	1.2	CBOP
61			C !ROUTINE: adopen
62			C !INTERFACE:
63	heimbach	1.1	subroutine adopen(
64			I mythid,
65			cph(
66			cph I myiter,
67			cph)
68			I name,
69			I len,
70			I tid,
71			I vid,
72			I size,
73			I length
74			& )
75
76	heimbach	1.2	C !DESCRIPTION: \bv
77	heimbach	1.1	c ==================================================================
78			c SUBROUTINE adopen
79			c ==================================================================
80			c o Dummy routine expected to be available by TAMC I/O.
81			c This routine is simply a dummy routine expected to be available by
82			c the Tangent Linear and Adjoint Model Compiler(TAMC). Files are
83			c opened and closed by the routines that are called by adread and
84			c adwrite.
85			c started: Christian Eckert eckert@mit.edu 30-Jun-1999
86			c ==================================================================
87			c SUBROUTINE adopen
88			c ==================================================================
89	heimbach	1.2	C \ev
90	heimbach	1.1
91	heimbach	1.2	C !USES:
92	heimbach	1.1	implicit none
93
94			c == global variables ==
95
96	heimbach	1.2	C !INPUT/OUTPUT PARAMETERS:
97	heimbach	1.1	c == routine arguments ==
98	heimbach	1.2	c name - extended tape name.
99			c len - number of characters in name.
100			c tid - tape identifier.
101			c vid - identifies the variable to be stored on tape.
102			c size - size in bytes of the type of variable var.
103			c length - dimension of the variable stored on the tape.
104			c mythid - number of the thread or instance of the program.
105	heimbach	1.1
106			integer mythid
107			cph(
108			cph integer myiter
109			cph)
110			character() name
111			integer len
112			integer tid
113			integer vid
114			integer size
115			integer length
116
117	heimbach	1.2	C !LOCAL VARIABLES:
118	heimbach	1.1	c == local variables ==
119
120			c == end of interface ==
121	heimbach	1.2	CEOP
122	heimbach	1.1
123			return
124			end
125
126
127	heimbach	1.2	CBOP
128			C !ROUTINE: adclose
129			C !INTERFACE:
130	heimbach	1.1	subroutine adclose(
131			I mythid,
132			cph(
133			cph I myiter,
134			cph)
135			I name,
136			I len,
137			I tid,
138			I vid,
139			I size,
140			I length
141			& )
142
143
144	heimbach	1.2	C !DESCRIPTION: \bv
145	heimbach	1.1	c ==================================================================
146			c SUBROUTINE adclose
147			c ==================================================================
148			c o Dummy routine expected to be available by TAMC I/O.
149			c This routine is simply a dummy routine expected to be available by
150			c the Tangent Linear and Adjoint Model Compiler(TAMC). Files are
151			c opened and closed by the routines that are called by adread and
152			c adwrite.
153			c started: Christian Eckert eckert@mit.edu 30-Jun-1999
154			c ==================================================================
155			c SUBROUTINE adclose
156			c ==================================================================
157	heimbach	1.2	C \ev
158	heimbach	1.1
159	heimbach	1.2	C !USES:
160	heimbach	1.1	implicit none
161
162			c == global variables ==
163
164	heimbach	1.2	C !INPUT/OUTPUT PARAMETERS:
165	heimbach	1.1	c == routine arguments ==
166	heimbach	1.2	c name - extended tape name.
167			c len - number of characters in name.
168			c tid - tape identifier.
169			c vid - identifies the variable to be stored on tape.
170			c size - size in bytes of the type of variable var.
171			c length - dimension of the variable stored on the tape.
172			c mythid - number of the thread or instance of the program.
173	heimbach	1.1
174			integer mythid
175			cph(
176			cph integer myiter
177			cph)
178			character() name
179			integer len
180			integer tid
181			integer vid
182			integer size
183			integer length
184
185	heimbach	1.2	C !LOCAL VARIABLES:
186	heimbach	1.1	c == local variables ==
187
188			c == end of interface ==
189	heimbach	1.2	CEOP
190	heimbach	1.1
191			return
192			end