/[MITgcm]/MITgcm/model/src/the_main_loop.F
ViewVC logotype

Contents of /MITgcm/model/src/the_main_loop.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.106 - (show annotations) (download)
Wed Apr 28 08:36:09 2010 UTC (14 years, 1 month ago) by mlosch
Branch: MAIN
CVS Tags: checkpoint62g, checkpoint62f, checkpoint62k, checkpoint62j, checkpoint62i, checkpoint62h
Changes since 1.105: +10 -6 lines
adjust store directives for seaice evp and multicategory according to
pkg/ecco/the_main_loop.F

1 C $Header: /u/gcmpack/MITgcm/model/src/the_main_loop.F,v 1.105 2009/10/15 05:21:12 heimbach Exp $
2 C $Name: $
3
4 #include "PACKAGES_CONFIG.h"
5 #include "CPP_OPTIONS.h"
6 #ifdef ALLOW_OBCS
7 # include "OBCS_OPTIONS.h"
8 #endif
9 #ifdef ALLOW_SEAICE
10 # include "SEAICE_OPTIONS.h"
11 #endif
12 #ifdef ALLOW_GMREDI
13 # include "GMREDI_OPTIONS.h"
14 #endif
15
16 CBOP
17 C !ROUTINE: THE_MAIN_LOOP
18 C !INTERFACE:
19 SUBROUTINE THE_MAIN_LOOP( myTime, myIter, myThid )
20
21 C !DESCRIPTION: \bv
22 C *================================================================*
23 C | SUBROUTINE the_main_loop
24 C | o Run the ocean model and evaluate the specified cost function.
25 C *================================================================*
26 C |
27 C | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and
28 C | Adjoint Model Compiler (TAMC).
29 C | For this purpose the initialization
30 C | of the model was split into two parts. Those parameters that do
31 C | not depend on a specific model run are set in INITIALISE_FIXED,
32 C | whereas those that do depend on the specific realization are
33 C | initialized in INITIALISE_VARIA.
34 C | This routine is to be used in conjuction with the MITgcmuv
35 C | checkpoint 37.
36 C *================================================================*
37 C \ev
38
39 C !USES:
40 IMPLICIT NONE
41 C == Global variables ==
42 #include "SIZE.h"
43 #include "EEPARAMS.h"
44 #include "PARAMS.h"
45
46 c**************************************
47 #ifdef ALLOW_AUTODIFF
48 # ifndef ALLOW_AUTODIFF_OPENAD
49
50 c These includes are needed for
51 c AD-checkpointing.
52 c They provide the fields to be stored.
53
54 # include "AUTODIFF_MYFIELDS.h"
55 # include "GRID.h"
56 # include "DYNVARS.h"
57 # include "SURFACE.h"
58 # include "FFIELDS.h"
59 # include "EOS.h"
60 # include "AUTODIFF.h"
61
62 # ifdef ALLOW_GENERIC_ADVDIFF
63 # include "GAD.h"
64 # endif
65 # ifdef ALLOW_MOM_FLUXFORM
66 # include "MOM_FLUXFORM.h"
67 # endif
68 # ifdef ALLOW_CD_CODE
69 # include "CD_CODE_VARS.h"
70 # endif
71 # ifdef ALLOW_PTRACERS
72 # include "PTRACERS_SIZE.h"
73 # include "PTRACERS_FIELDS.h"
74 # endif
75 # ifdef ALLOW_GCHEM
76 # include "GCHEM_FIELDS.h"
77 # endif
78 # ifdef ALLOW_CFC
79 # include "CFC.h"
80 # endif
81 # ifdef ALLOW_DIC
82 # include "DIC_VARS.h"
83 # include "DIC_LOAD.h"
84 # include "DIC_ATMOS.h"
85 # include "DIC_CTRL.h"
86 # include "DIC_COST.h"
87 # endif
88 # ifdef ALLOW_OBCS
89 # include "OBCS.h"
90 # ifdef ALLOW_PTRACERS
91 # include "OBCS_PTRACERS.h"
92 # endif
93 # endif
94 # ifdef ALLOW_EXF
95 # include "EXF_FIELDS.h"
96 # ifdef ALLOW_BULKFORMULAE
97 # include "EXF_CONSTANTS.h"
98 # endif
99 # endif /* ALLOW_EXF */
100 # ifdef ALLOW_SEAICE
101 # include "SEAICE.h"
102 # include "SEAICE_PARAMS.h"
103 # include "SEAICE_COST.h"
104 # endif
105 # ifdef ALLOW_SALT_PLUME
106 # include "SALT_PLUME.h"
107 # endif
108 # ifdef ALLOW_THSICE
109 # include "THSICE_SIZE.h"
110 # include "THSICE_PARAMS.h"
111 # include "THSICE_VARS.h"
112 # endif
113 # ifdef ALLOW_EBM
114 # include "EBM.h"
115 # endif
116 # ifdef ALLOW_RBCS
117 # include "RBCS.h"
118 # endif
119 # ifdef ALLOW_OFFLINE
120 # include "OFFLINE.h"
121 # endif
122 # ifdef ALLOW_DIVIDED_ADJOINT_MPI
123 # include "mpif.h"
124 # endif
125
126 # include "tamc.h"
127 # endif /* undef ALLOW_AUTODIFF_OPENAD */
128
129 # include "ctrl.h"
130 # include "ctrl_dummy.h"
131 # include "cost.h"
132
133 #endif /* ALLOW_AUTODIFF */
134 c**************************************
135
136 C !INPUT/OUTPUT PARAMETERS:
137 C == Routine arguments ==
138 C note: under the multi-threaded model myiter and
139 C mytime are local variables passed around as routine
140 C arguments. Although this is fiddly it saves the need to
141 C impose additional synchronisation points when they are
142 C updated.
143 C myIter - iteration counter for this thread
144 C myTime - time counter for this thread
145 C myThid - thread number for this instance of the routine.
146 INTEGER myThid
147 INTEGER myIter
148 _RL myTime
149
150 C !FUNCTIONS:
151 C == Functions ==
152
153 C !LOCAL VARIABLES:
154 C == Local variables ==
155 integer iloop
156 #ifdef ALLOW_AUTODIFF_TAMC
157 # ifdef ALLOW_AUTODIFF_OPENAD
158 integer uCheckLev1, uCheckLev2, uCheckLev3,uCheckLev4
159 integer ilev_4
160 integer theCurrentStep
161 # endif
162 #endif
163
164 CEOP
165
166 #ifdef ALLOW_DEBUG
167 IF (debugMode) CALL DEBUG_ENTER('THE_MAIN_LOOP',myThid)
168 #endif
169
170 #ifdef ALLOW_AUTODIFF_TAMC
171 c-- Initialize storage for the cost function evaluation.
172 CADJ INIT dummytape = common, 1
173 c-- Initialize storage for the outermost loop.
174 CADJ INIT tapelev_ini_bibj_k = USER
175 CADJ INIT tapelev_init = USER
176 c
177 # if (defined (AUTODIFF_2_LEVEL_CHECKPOINT))
178 CADJ INIT tapelev2 = USER
179 # elif (defined (AUTODIFF_4_LEVEL_CHECKPOINT))
180 CADJ INIT tapelev4 = USER
181 # else
182 CADJ INIT tapelev3 = USER
183 # endif
184 #endif
185
186 #ifdef ALLOW_AUTODIFF
187 nIter0 = NINT( (startTime-baseTime)/deltaTClock )
188 ikey_dynamics = 1
189 #endif
190
191 #ifdef ALLOW_AUTODIFF_TAMC
192 # ifdef NONLIN_FRSURF
193 CADJ STORE hFacC = tapelev_init, key = 1
194 # endif
195 #endif
196
197 #ifdef ALLOW_AUTODIFF_OPENAD
198 # ifdef ALLOW_THETA0_CONTROL
199 c$openad INDEPENDENT(xx_theta)
200 # endif
201 # ifdef ALLOW_SALT0_CONTROL
202 c$openad INDEPENDENT(xx_salt)
203 # endif
204 # ifdef ALLOW_HFLUX0_CONTROL
205 c$openad INDEPENDENT(xx_hflux0)
206 # endif
207 # ifdef ALLOW_SFLUX0_CONTROL
208 c$openad INDEPENDENT(xx_sflux0)
209 # endif
210 # ifdef ALLOW_TAUU0_CONTROL
211 c$openad INDEPENDENT(xx_tauu0)
212 # endif
213 # ifdef ALLOW_TAUV0_CONTROL
214 c$openad INDEPENDENT(xx_tauv0)
215 # endif
216 # ifdef ALLOW_DIFFKR_CONTROL
217 c$openad INDEPENDENT(xx_diffkr)
218 # endif
219 # ifdef ALLOW_ KAPGM_CONTROL
220 c$openad INDEPENDENT(xx_kapgm)
221 # endif
222 #endif
223
224 #ifdef ALLOW_DEBUG
225 IF (debugMode) CALL DEBUG_CALL('INITIALISE_VARIA',myThid)
226 #endif
227 C-- Set initial conditions (variable arrays)
228 CALL TIMER_START('INITIALISE_VARIA [THE_MAIN_LOOP]', mythid)
229 CALL INITIALISE_VARIA( mythid )
230 CALL TIMER_STOP ('INITIALISE_VARIA [THE_MAIN_LOOP]', mythid)
231
232 #ifdef ALLOW_SHOWFLOPS
233 CALL TIMER_START('SHOWFLOPS_INIT [THE_MAIN_LOOP]', mythid)
234 CALL SHOWFLOPS_INIT( myThid )
235 CALL TIMER_STOP('SHOWFLOPS_INIT [THE_MAIN_LOOP]', mythid)
236 #endif
237
238 c-- Do the model integration.
239 CALL TIMER_START('MAIN LOOP [THE_MAIN_LOOP]', mythid)
240
241 c >>>>>>>>>>>>>>>>>>>>>>>>>>> LOOP <<<<<<<<<<<<<<<<<<<<<<<<<<<<
242 c >>>>>>>>>>>>>>>>>>>>>>>>>>> STARTS <<<<<<<<<<<<<<<<<<<<<<<<<<<<
243
244 c++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
245 #ifndef ALLOW_AUTODIFF_OPENAD
246 c++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
247 # ifdef ALLOW_AUTODIFF
248 # ifdef ALLOW_TAMC_CHECKPOINTING
249
250 max_lev4=nTimeSteps/(nchklev_1*nchklev_2*nchklev_3)+1
251 max_lev3=nTimeSteps/(nchklev_1*nchklev_2)+1
252 max_lev2=nTimeSteps/nchklev_1+1
253
254 c**************************************
255 # ifdef ALLOW_DIVIDED_ADJOINT
256 CADJ loop = divided
257 # endif
258 c**************************************
259
260 # ifdef AUTODIFF_4_LEVEL_CHECKPOINT
261 do ilev_4 = 1,nchklev_4
262 if(ilev_4.le.max_lev4) then
263 c**************************************
264 CALL AUTODIFF_STORE( myThid )
265 #include "checkpoint_lev4_directives.h"
266 CALL AUTODIFF_RESTORE( myThid )
267 c**************************************
268 c-- Initialise storage for the middle loop.
269 CADJ INIT tapelev3 = USER
270 # endif /* AUTODIFF_4_LEVEL_CHECKPOINT */
271
272 # ifndef AUTODIFF_2_LEVEL_CHECKPOINT
273 do ilev_3 = 1,nchklev_3
274 if(ilev_3.le.max_lev3) then
275 c**************************************
276 CALL AUTODIFF_STORE( myThid )
277 #include "checkpoint_lev3_directives.h"
278 CALL AUTODIFF_RESTORE( myThid )
279 c**************************************
280 c-- Initialise storage for the middle loop.
281 CADJ INIT tapelev2 = USER
282 # endif /* AUTODIFF_2_LEVEL_CHECKPOINT */
283
284 do ilev_2 = 1,nchklev_2
285 if(ilev_2.le.max_lev2) then
286 c**************************************
287 CALL AUTODIFF_STORE( myThid )
288 #include "checkpoint_lev2_directives.h"
289 CALL AUTODIFF_RESTORE( myThid )
290 c**************************************
291
292 c**************************************
293 c--
294 c-- Initialize storage for the innermost loop.
295 c-- Always check common block sizes for the checkpointing!
296 c--
297 CADJ INIT comlev1 = COMMON,nchklev_1
298 CADJ INIT comlev1_bibj = COMMON,nchklev_1*nsx*nsy*nthreads_chkpt
299 CADJ INIT comlev1_bibj_k = COMMON,nchklev_1*nsx*nsy*nr*nthreads_chkpt
300 c--
301 # ifdef ALLOW_KPP
302 CADJ INIT comlev1_kpp = COMMON,nchklev_1*nsx*nsy
303 CADJ INIT comlev1_kpp_k = COMMON,nchklev_1*nsx*nsy*nr
304 # endif /* ALLOW_KPP */
305 c--
306 # ifdef ALLOW_GMREDI
307 CADJ INIT comlev1_gmredi_k_gad
308 CADJ & = COMMON,nchklev_1*nsx*nsy*nr*nthreads_chkpt*maxpass
309 # endif /* ALLOW_GMREDI */
310 c--
311 # ifdef ALLOW_PTRACERS
312 CADJ INIT comlev1_bibj_ptracers = COMMON,
313 CADJ & nchklev_1*nsx*nsy*nthreads_chkpt*PTRACERS_num
314 CADJ INIT comlev1_bibj_k_ptracers = COMMON,
315 CADJ & nchklev_1*nsx*nsy*nthreads_chkpt*PTRACERS_num*nr
316 # endif /* ALLOW_PTRACERS */
317 c--
318 # ifndef DISABLE_MULTIDIM_ADVECTION
319 CADJ INIT comlev1_bibj_k_gad = COMMON,
320 CADJ & nchklev_1*nsx*nsy*nr*nthreads_chkpt*maxpass
321 CADJ INIT comlev1_bibj_k_gad_pass = COMMON,
322 CADJ & nchklev_1*nsx*nsy*nr*nthreads_chkpt*maxpass*maxpass
323 # endif /* DISABLE_MULTIDIM_ADVECTION */
324 c--
325 # ifdef ALLOW_MOM_COMMON
326 # ifndef AUTODIFF_DISABLE_LEITH
327 CADJ INIT comlev1_mom_ijk_loop
328 CADJ & = COMMON,nchklev_1*
329 CADJ & (snx+2*olx)*nsx*(sny+2*oly)*nsy*nr*nthreads_chkpt
330 # endif /* AUTODIFF_DISABLE_LEITH */
331 # endif /* ALLOW_MOM_COMMON */
332 c--
333 # if (defined (ALLOW_EXF) && defined (ALLOW_BULKFORMULAE))
334 CADJ INIT comlev1_exf_1
335 CADJ & = COMMON,nchklev_1*snx*nsx*sny*nsy*nthreads_chkpt
336 CADJ INIT comlev1_exf_2
337 CADJ & = COMMON,niter_bulk*nchklev_1*snx*nsx*sny*nsy*nthreads_chkpt
338 # endif /* ALLOW_BULKFORMULAE */
339 c--
340 # ifdef ALLOW_SEAICE
341 # ifdef SEAICE_ALLOW_DYNAMICS
342 cphCADJ INIT comlev1_lsr = COMMON,nchklev_1*2
343 CADJ INIT comlev1_dynsol = COMMON,nchklev_1*MPSEUDOTIMESTEPS
344 # endif
345 # ifdef SEAICE_ALLOW_EVP
346 CADJ INIT comlev1_evp = COMMON,nEVPstepMax*nchklev_1
347 # endif
348 # ifdef SEAICE_MULTICATEGORY
349 CADJ INIT comlev1_multdim
350 CADJ & = COMMON,nchklev_1*nsx*nsy*nthreads_chkpt*multdim
351 # endif
352 # endif /* ALLOW_SEAICE */
353 c--
354 # ifdef ALLOW_THSICE
355 CADJ INIT comlev1_thsice_1
356 CADJ & = COMMON,nchklev_1*snx*nsx*sny*nsy*nthreads_chkpt
357 CADJ INIT comlev1_thsice_2
358 CADJ & = COMMON,nchklev_1*snx*nsx*sny*nsy*nlyr*nthreads_chkpt
359 CADJ INIT comlev1_thsice_3
360 CADJ & = COMMON,nchklev_1*snx*nsx*sny*nsy*MaxTsf*nthreads_chkpt
361 CADJ INIT comlev1_thsice_4
362 CADJ & = COMMON,nchklev_1*nsx*nsy*maxpass*nthreads_chkpt
363 # endif /* ALLOW_THSICE */
364 c--
365 # ifdef ALLOW_DEPTH_CONTROL
366 CADJ INIT comlev1_cg2d
367 CADJ & = COMMON,nchklev_1*nthreads_chkpt
368 CADJ INIT comlev1_cg2d_iter
369 CADJ & = COMMON,nchklev_1*nthreads_chkpt*numItersMax
370 # endif
371 c--
372 c**************************************
373
374 do ilev_1 = 1,nchklev_1
375
376 c-- The if-statement below introduces a some flexibility in the
377 c-- choice of the 3-tupel ( nchklev_1, nchklev_2, nchklev_3 ).
378
379 iloop = (ilev_2 - 1)*nchklev_1 + ilev_1
380 # ifndef AUTODIFF_2_LEVEL_CHECKPOINT
381 & + (ilev_3 - 1)*nchklev_2*nchklev_1
382 # endif
383 # ifdef AUTODIFF_4_LEVEL_CHECKPOINT
384 & + (ilev_4 - 1)*nchklev_3*nchklev_2*nchklev_1
385 # endif
386
387 if ( iloop .le. nTimeSteps ) then
388
389 # else /* ALLOW_TAMC_CHECKPOINTING undefined */
390 c-- Initialise storage for reference trajectory without TAMC check-
391 c-- pointing.
392 CADJ INIT history = USER
393 CADJ INIT comlev1_bibj = COMMON,nchklev_0*nsx*nsy*nthreads_chkpt
394 CADJ INIT comlev1_bibj_k = COMMON,nchklev_0*nsx*nsy*nr*nthreads_chkpt
395 CADJ INIT comlev1_kpp = COMMON,nchklev_0*nsx*nsy
396
397 c-- Check the choice of the checkpointing parameters in relation
398 c-- to nTimeSteps: (nchklev_0 .ge. nTimeSteps)
399 if (nchklev_0 .lt. nTimeSteps) then
400 print*
401 print*, ' the_main_loop: TAMC checkpointing parameter ',
402 & 'nchklev_0 = ', nchklev_0
403 print*, ' not consistent with nTimeSteps = ',
404 & nTimeSteps
405 stop ' ... stopped in the_main_loop.'
406 endif
407
408 DO iloop = 1, nTimeSteps
409
410 # endif /* ALLOW_TAMC_CHECKPOINTING */
411 # endif /* ALLOW_AUTODIFF */
412
413 #endif /* undef ALLOW_AUTODIFF_OPENAD */
414
415 #ifdef ALLOW_AUTODIFF_OPENAD
416 call openad_checkpointinit(uCheckLev1,
417 + uCheckLev2,
418 + uCheckLev3,
419 + uCheckLev4 )
420
421 theCurrentStep=0
422
423 if (uCheckLev4 .gt. 0 ) then
424 do ilev_4 = 1, uCheckLev4
425
426 #endif
427
428 #ifndef ALLOW_AUTODIFF
429
430 c-- Start the main loop of adjoint_Objfunc. Automatic differentiation
431 c-- NOT enabled.
432 DO iloop = 1, nTimeSteps
433
434 #endif /* ALLOW_AUTODIFF */
435
436 c-- >>> Loop body start <<<
437
438 #ifdef ALLOW_AUTODIFF_TAMC
439 nIter0 = NINT( (startTime-baseTime)/deltaTClock )
440 ikey_dynamics = ilev_1
441 #endif
442
443 #ifdef ALLOW_DEBUG
444 IF (debugMode) CALL DEBUG_CALL('FORWARD_STEP',myThid)
445 #endif
446
447 #ifdef ALLOW_ATM2D
448 CALL TIMER_START('FORWARD_STEP_ATM2D [THE_MAIN_LOOP]',mythid)
449 CALL FORWARD_STEP_ATM2D( iloop, mytime, myiter, mythid )
450 CALL TIMER_STOP ('FORWARD_STEP_ATM2D [THE_MAIN_LOOP]',mythid)
451 #else
452 CALL TIMER_START('FORWARD_STEP [THE_MAIN_LOOP]',mythid)
453 # ifdef ALLOW_AUTODIFF_OPENAD
454 CALL THE_FOURTH_LEVEL_LOOP( ilev_4,
455 +uCheckLev1, uCheckLev2, uCheckLev3,uCheckLev4,
456 +theCurrentStep,
457 +myTime, myIter, myThid )
458 # else
459 CALL FORWARD_STEP( iloop, mytime, myiter, mythid )
460 # endif
461 CALL TIMER_STOP ('FORWARD_STEP [THE_MAIN_LOOP]',mythid)
462 #endif
463
464 c-- >>> Loop body end <<<
465 #ifdef ALLOW_AUTODIFF
466 # ifndef ALLOW_AUTODIFF_OPENAD
467
468 # ifdef ALLOW_TAMC_CHECKPOINTING
469 endif
470 enddo
471 endif
472 enddo
473 # ifndef AUTODIFF_2_LEVEL_CHECKPOINT
474 endif
475 enddo
476 # endif
477 # ifdef AUTODIFF_4_LEVEL_CHECKPOINT
478 endif
479 enddo
480 # endif
481 # else /* ndef ALLOW_TAMC_CHECKPOINTING */
482 enddo
483 # endif /* ALLOW_TAMC_CHECKPOINTING */
484 # else /* ALLOW_AUTODIFF_OPENAD */
485 end do
486 else
487 CALL THE_FOURTH_LEVEL_PLAIN(
488 +uCheckLev1, uCheckLev2, uCheckLev3,uCheckLev4,
489 +theCurrentStep,
490 +myTime, myIter, myThid )
491 end if
492 # endif /* ALLOW_AUTODIFF_OPENAD */
493 #else /* ALLOW_AUTODIFF */
494 enddo
495 #endif /* ALLOW_AUTODIFF */
496
497 #ifdef ALLOW_PROFILES
498 c-- Accumulate in-situ time averages of temperature, salinity, SSH.
499 CALL TIMER_START('PROFILES_INLOOP [THE_MAIN_LOOP]', mythid)
500 CALL PROFILES_INLOOP( mytime, mythid )
501 CALL TIMER_STOP ('PROFILES_INLOOP [THE_MAIN_LOOP]', mythid)
502 #endif
503
504 #ifdef ALLOW_COST
505 c-- Sum all cost function contributions.
506 CALL TIMER_START('COST_FINAL [ADJOINT SPIN-DOWN]', mythid)
507 CALL COST_FINAL ( mythid )
508 CALL TIMER_STOP ('COST_FINAL [ADJOINT SPIN-DOWN]', mythid)
509
510 # ifdef ALLOW_AUTODIFF_OPENAD
511 c$openad DEPENDENT(fc)
512 # endif /* ALLOW_AUTODIFF_OPENAD */
513
514 #endif /* ALLOW_COST */
515
516 _BARRIER
517 CALL TIMER_STOP ('MAIN LOOP [THE_MAIN_LOOP]', mythid)
518
519 #ifdef ALLOW_DEBUG
520 IF (debugMode) CALL DEBUG_LEAVE('THE_MAIN_LOOP',myThid)
521 #endif
522
523 END
524

  ViewVC Help
Powered by ViewVC 1.1.22