model/src/main_do_loop.F

C $Header: /u/gcmpack/MITgcm/model/src/main_do_loop.F,v 1.22 2017/03/29 15:44:00 mmazloff Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"
#ifdef ALLOW_OPENAD
# include "OPENAD_OPTIONS.h"
#endif
c#ifdef ALLOW_AUTODIFF
c# include "AUTODIFF_OPTIONS.h"
c#endif
#ifdef ALLOW_GENERIC_ADVDIFF
# include "GAD_OPTIONS.h"
#endif
#ifdef ALLOW_GGL90
# include "GGL90_OPTIONS.h"
#endif
#ifdef ALLOW_GMREDI
# include "GMREDI_OPTIONS.h"
#endif
#ifdef ALLOW_OBCS
# include "OBCS_OPTIONS.h"
#endif
#ifdef ALLOW_SEAICE
# include "SEAICE_OPTIONS.h"
#endif
#ifdef ALLOW_GCHEM
# include "GCHEM_OPTIONS.h"
#endif
#ifdef ALLOW_DIC
# include "DIC_OPTIONS.h"
#endif
#ifdef ALLOW_EXF
# include "EXF_OPTIONS.h"
#endif
#ifdef ALLOW_STREAMICE
# include "STREAMICE_OPTIONS.h"
#endif
#ifdef ALLOW_COST
# include "COST_OPTIONS.h"
#endif
#ifdef ALLOW_CTRL
# include "CTRL_OPTIONS.h"
#endif
c#ifdef ALLOW_ECCO
c# include "ECCO_OPTIONS.h"
c#endif

CBOP
C     !ROUTINE: MAIN_DO_LOOP
C     !INTERFACE:
      SUBROUTINE MAIN_DO_LOOP( iloop, myTime, myIter, myThid )

C     !DESCRIPTION: \bv
C     *================================================================*
C     | SUBROUTINE the_loop_body
C     | o Run the ocean model and evaluate the specified cost function.
C     *================================================================*
C     |
C     | MAIN_DO_LOOP is the toplevel routine for the Tangent Linear and
C     | Adjoint Model Compiler (TAMC).
C     | For this purpose the initialization
C     | of the model was split into two parts. Those parameters that do
C     | not depend on a specific model run are set in INITIALISE_FIXED,
C     | whereas those that do depend on the specific realization are
C     | initialized in INITIALISE_VARIA.
C     | This routine is to be used in conjuction with the MITgcmuv
C     | checkpoint 37.
C     *================================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"

c**************************************
#ifdef ALLOW_OPENAD

# ifdef ALLOW_CTRL
#  include "CTRL_SIZE.h"
#  include "ctrl.h"
#  include "ctrl_dummy.h"
#  include "CTRL_GENARR.h"
#  include "CTRL_OBCS.h"
# endif
# ifdef ALLOW_COST
#  include "cost.h"
# endif

# ifdef ALLOW_PTRACERS
#  include "PTRACERS_SIZE.h"
#  include "PTRACERS_FIELDS.h"
#  include "PTRACERS_START.h"
# endif
# ifdef ALLOW_GCHEM
#  include "GCHEM_SIZE.h"
#  include "GCHEM_FIELDS.h"
# endif
# ifdef ALLOW_CFC
#  include "CFC.h"
# endif
# ifdef ALLOW_DIC
#  include "DIC_VARS.h"
#  include "DIC_LOAD.h"
#  include "DIC_ATMOS.h"
#  include "DIC_CTRL.h"
#  include "DIC_COST.h"
# endif
# ifdef ALLOW_BLING
#  include "BLING_VARS.h"
#  include "BLING_LOAD.h"
# endif
# ifdef ALLOW_OBCS
#  include "OBCS_PARAMS.h"
#  include "OBCS_FIELDS.h"
#  include "OBCS_SEAICE.h"
#  ifdef ALLOW_PTRACERS
#   include "OBCS_PTRACERS.h"
#  endif
# endif
# ifdef ALLOW_SHELFICE
#  include "SHELFICE.h"
#  include "SHELFICE_COST.h"
# endif
# ifdef ALLOW_STREAMICE
#  include "STREAMICE.h"
#  include "STREAMICE_ADV.h"
#  include "STREAMICE_BDRY.h"
#  include "STREAMICE_CG.h"
# endif

#endif /* ALLOW_OPENAD */
c**************************************

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     note: under the multi-threaded model myIter and
C           myTime are local variables passed around as routine
C           arguments. Although this is fiddly it saves the need to
C           impose additional synchronisation points when they are
C           updated.
C     myTime :: time counter for this thread
C     myIter :: iteration counter for this thread
C     myThid :: thread number for this instance of the routine.
      _RL     myTime
      INTEGER myIter
      INTEGER myThid

C     !FUNCTIONS:
C     == Functions ==

C     !LOCAL VARIABLES:
C     == Local variables ==
      INTEGER iloop
CEOP

#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_ENTER('MAIN_DO_LOOP',myThid)
#endif

#ifdef ALLOW_OPENAD
C     >>>>>>>>>>>>>>>>>>>>>>>>>>>   LOOP   <<<<<<<<<<<<<<<<<<<<<<<<<<<<
C     >>>>>>>>>>>>>>>>>>>>>>>>>>>  STARTS  <<<<<<<<<<<<<<<<<<<<<<<<<<<<
# ifdef ALLOW_OPENAD_DIVA
      DO iloop = 1, nTimeSteps_l2
# else
      DO iloop = 1, nTimeSteps
# endif

#endif /* ALLOW_OPENAD */

#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('FORWARD_STEP',myThid)
#endif

#ifndef ALLOW_OPENAD
# ifdef ALLOW_ATM2D
        CALL TIMER_START('FORWARD_STEP_ATM2D  [MAIN_DO_LOOP]',myThid)
        CALL FORWARD_STEP_ATM2D( iloop, myTime, myIter, myThid )
        CALL TIMER_STOP ('FORWARD_STEP_ATM2D  [MAIN_DO_LOOP]',myThid)
# else
        CALL TIMER_START('FORWARD_STEP        [MAIN_DO_LOOP]',myThid)
        CALL FORWARD_STEP( iloop, myTime, myIter, myThid )
        CALL TIMER_STOP ('FORWARD_STEP        [MAIN_DO_LOOP]',myThid)
# endif
#else
# ifdef ALLOW_OPENAD_DIVA
       CALL TIMER_START('INNER_DO_LOOP       [MAIN_DO_LOOP]',myThid)
       nTimeSteps_l2 = 2
       CALL INNER_DO_LOOP( iloop, myTime, myIter, myThid )
       CALL TIMER_STOP ('INNER_DO_LOOP       [MAIN_DO_LOOP]',myThid)
# else
       CALL TIMER_START('FORWARD_STEP        [MAIN_DO_LOOP]',myThid)
       nTimeSteps_l2 = 2
       CALL FORWARD_STEP( iloop, myTime, myIter, myThid )
       CALL TIMER_STOP ('FORWARD_STEP        [MAIN_DO_LOOP]',myThid)
# endif
#endif /* ndef ALLOW_OPENAD */

#ifdef ALLOW_OPENAD
      ENDDO
C     >>>>>>>>>>>>>>>>>>>>>>>>>>>   LOOP   <<<<<<<<<<<<<<<<<<<<<<<<<<<<
C     >>>>>>>>>>>>>>>>>>>>>>>>>>>  STOPS   <<<<<<<<<<<<<<<<<<<<<<<<<<<<
#endif /* ALLOW_OPENAD */

#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_LEAVE('MAIN_DO_LOOP',myThid)
#endif

      RETURN
      END
1	jmc	1.23	C $Header: /u/gcmpack/MITgcm/model/src/main_do_loop.F,v 1.22 2017/03/29 15:44:00 mmazloff Exp $
2	heimbach	1.1	C $Name: $
3
4			#include "PACKAGES_CONFIG.h"
5			#include "CPP_OPTIONS.h"
6	heimbach	1.20	#ifdef ALLOW_OPENAD
7			# include "OPENAD_OPTIONS.h"
8			#endif
9	jmc	1.16	c#ifdef ALLOW_AUTODIFF
10			c# include "AUTODIFF_OPTIONS.h"
11			c#endif
12	jmc	1.23	#ifdef ALLOW_GENERIC_ADVDIFF
13			# include "GAD_OPTIONS.h"
14			#endif
15			#ifdef ALLOW_GGL90
16			# include "GGL90_OPTIONS.h"
17			#endif
18			#ifdef ALLOW_GMREDI
19			# include "GMREDI_OPTIONS.h"
20			#endif
21	heimbach	1.1	#ifdef ALLOW_OBCS
22			# include "OBCS_OPTIONS.h"
23			#endif
24			#ifdef ALLOW_SEAICE
25			# include "SEAICE_OPTIONS.h"
26			#endif
27	jmc	1.23	#ifdef ALLOW_GCHEM
28			# include "GCHEM_OPTIONS.h"
29			#endif
30			#ifdef ALLOW_DIC
31			# include "DIC_OPTIONS.h"
32	heimbach	1.1	#endif
33	jmc	1.23	#ifdef ALLOW_EXF
34			# include "EXF_OPTIONS.h"
35	heimbach	1.1	#endif
36			#ifdef ALLOW_STREAMICE
37			# include "STREAMICE_OPTIONS.h"
38			#endif
39	jmc	1.16	#ifdef ALLOW_COST
40			# include "COST_OPTIONS.h"
41			#endif
42	heimbach	1.1	#ifdef ALLOW_CTRL
43			# include "CTRL_OPTIONS.h"
44			#endif
45	gforget	1.18	c#ifdef ALLOW_ECCO
46			c# include "ECCO_OPTIONS.h"
47			c#endif
48	heimbach	1.1
49			CBOP
50			C !ROUTINE: MAIN_DO_LOOP
51			C !INTERFACE:
52	heimbach	1.11	SUBROUTINE MAIN_DO_LOOP( iloop, myTime, myIter, myThid )
53	heimbach	1.1
54			C !DESCRIPTION: \bv
55			C ================================================================
56			C \| SUBROUTINE the_loop_body
57			C \| o Run the ocean model and evaluate the specified cost function.
58			C ================================================================
59			C \|
60			C \| MAIN_DO_LOOP is the toplevel routine for the Tangent Linear and
61			C \| Adjoint Model Compiler (TAMC).
62			C \| For this purpose the initialization
63			C \| of the model was split into two parts. Those parameters that do
64			C \| not depend on a specific model run are set in INITIALISE_FIXED,
65			C \| whereas those that do depend on the specific realization are
66			C \| initialized in INITIALISE_VARIA.
67			C \| This routine is to be used in conjuction with the MITgcmuv
68			C \| checkpoint 37.
69			C ================================================================
70			C \ev
71
72			C !USES:
73			IMPLICIT NONE
74			C == Global variables ==
75			#include "SIZE.h"
76			#include "EEPARAMS.h"
77			#include "PARAMS.h"
78
79			c**************************************
80	jmc	1.16	#ifdef ALLOW_OPENAD
81	heimbach	1.1
82			# ifdef ALLOW_CTRL
83	jmc	1.15	# include "CTRL_SIZE.h"
84			# include "ctrl.h"
85			# include "ctrl_dummy.h"
86			# include "CTRL_GENARR.h"
87	gforget	1.17	# include "CTRL_OBCS.h"
88	heimbach	1.1	# endif
89			# ifdef ALLOW_COST
90			# include "cost.h"
91			# endif
92
93	jmc	1.15	# ifdef ALLOW_PTRACERS
94			# include "PTRACERS_SIZE.h"
95			# include "PTRACERS_FIELDS.h"
96			# include "PTRACERS_START.h"
97			# endif
98	heimbach	1.8	# ifdef ALLOW_GCHEM
99	jmc	1.23	# include "GCHEM_SIZE.h"
100	heimbach	1.8	# include "GCHEM_FIELDS.h"
101			# endif
102			# ifdef ALLOW_CFC
103			# include "CFC.h"
104			# endif
105			# ifdef ALLOW_DIC
106			# include "DIC_VARS.h"
107			# include "DIC_LOAD.h"
108			# include "DIC_ATMOS.h"
109			# include "DIC_CTRL.h"
110			# include "DIC_COST.h"
111			# endif
112	jmc	1.21	# ifdef ALLOW_BLING
113			# include "BLING_VARS.h"
114			# include "BLING_LOAD.h"
115			# endif
116	heimbach	1.10	# ifdef ALLOW_OBCS
117			# include "OBCS_PARAMS.h"
118			# include "OBCS_FIELDS.h"
119			# include "OBCS_SEAICE.h"
120			# ifdef ALLOW_PTRACERS
121			# include "OBCS_PTRACERS.h"
122	heimbach	1.8	# endif
123	heimbach	1.10	# endif
124			# ifdef ALLOW_SHELFICE
125			# include "SHELFICE.h"
126			# include "SHELFICE_COST.h"
127			# endif
128			# ifdef ALLOW_STREAMICE
129			# include "STREAMICE.h"
130			# include "STREAMICE_ADV.h"
131			# include "STREAMICE_BDRY.h"
132			# include "STREAMICE_CG.h"
133			# endif
134	heimbach	1.8
135	jmc	1.16	#endif /* ALLOW_OPENAD */
136	heimbach	1.1	c**************************************
137
138			C !INPUT/OUTPUT PARAMETERS:
139			C == Routine arguments ==
140	jmc	1.13	C note: under the multi-threaded model myIter and
141			C myTime are local variables passed around as routine
142	heimbach	1.1	C arguments. Although this is fiddly it saves the need to
143			C impose additional synchronisation points when they are
144			C updated.
145			C myTime :: time counter for this thread
146			C myIter :: iteration counter for this thread
147			C myThid :: thread number for this instance of the routine.
148			_RL myTime
149			INTEGER myIter
150			INTEGER myThid
151
152			C !FUNCTIONS:
153			C == Functions ==
154
155			C !LOCAL VARIABLES:
156			C == Local variables ==
157	jmc	1.4	INTEGER iloop
158	heimbach	1.1	CEOP
159
160			#ifdef ALLOW_DEBUG
161			IF (debugMode) CALL DEBUG_ENTER('MAIN_DO_LOOP',myThid)
162			#endif
163
164	jmc	1.16	#ifdef ALLOW_OPENAD
165	jmc	1.14	C >>>>>>>>>>>>>>>>>>>>>>>>>>> LOOP <<<<<<<<<<<<<<<<<<<<<<<<<<<<
166			C >>>>>>>>>>>>>>>>>>>>>>>>>>> STARTS <<<<<<<<<<<<<<<<<<<<<<<<<<<<
167	heimbach	1.20	# ifdef ALLOW_OPENAD_DIVA
168	heimbach	1.19	DO iloop = 1, nTimeSteps_l2
169	heimbach	1.20	# else
170	utke	1.3	DO iloop = 1, nTimeSteps
171	heimbach	1.20	# endif
172	heimbach	1.1
173	heimbach	1.20	#endif /* ALLOW_OPENAD */
174	heimbach	1.19
175	heimbach	1.1	#ifdef ALLOW_DEBUG
176			IF (debugMode) CALL DEBUG_CALL('FORWARD_STEP',myThid)
177			#endif
178
179	heimbach	1.19	#ifndef ALLOW_OPENAD
180	heimbach	1.20	# ifdef ALLOW_ATM2D
181	jmc	1.13	CALL TIMER_START('FORWARD_STEP_ATM2D [MAIN_DO_LOOP]',myThid)
182			CALL FORWARD_STEP_ATM2D( iloop, myTime, myIter, myThid )
183			CALL TIMER_STOP ('FORWARD_STEP_ATM2D [MAIN_DO_LOOP]',myThid)
184	heimbach	1.20	# else
185	jmc	1.13	CALL TIMER_START('FORWARD_STEP [MAIN_DO_LOOP]',myThid)
186			CALL FORWARD_STEP( iloop, myTime, myIter, myThid )
187			CALL TIMER_STOP ('FORWARD_STEP [MAIN_DO_LOOP]',myThid)
188	heimbach	1.20	# endif
189	heimbach	1.19	#else
190	heimbach	1.20	# ifdef ALLOW_OPENAD_DIVA
191	heimbach	1.19	CALL TIMER_START('INNER_DO_LOOP [MAIN_DO_LOOP]',myThid)
192			nTimeSteps_l2 = 2
193			CALL INNER_DO_LOOP( iloop, myTime, myIter, myThid )
194			CALL TIMER_STOP ('INNER_DO_LOOP [MAIN_DO_LOOP]',myThid)
195	heimbach	1.20	# else
196	heimbach	1.19	CALL TIMER_START('FORWARD_STEP [MAIN_DO_LOOP]',myThid)
197			nTimeSteps_l2 = 2
198			CALL FORWARD_STEP( iloop, myTime, myIter, myThid )
199			CALL TIMER_STOP ('FORWARD_STEP [MAIN_DO_LOOP]',myThid)
200	heimbach	1.20	# endif
201			#endif /* ndef ALLOW_OPENAD */
202	heimbach	1.1
203	jmc	1.16	#ifdef ALLOW_OPENAD
204	jmc	1.4	ENDDO
205	jmc	1.14	C >>>>>>>>>>>>>>>>>>>>>>>>>>> LOOP <<<<<<<<<<<<<<<<<<<<<<<<<<<<
206			C >>>>>>>>>>>>>>>>>>>>>>>>>>> STOPS <<<<<<<<<<<<<<<<<<<<<<<<<<<<
207	heimbach	1.20	#endif /* ALLOW_OPENAD */
208	heimbach	1.1
209			#ifdef ALLOW_DEBUG
210			IF (debugMode) CALL DEBUG_LEAVE('MAIN_DO_LOOP',myThid)
211			#endif
212
213			RETURN
214			END