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

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

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


Revision 1.4 - (show annotations) (download)
Sat Feb 23 15:42:09 2013 UTC (11 years, 2 months ago) by jmc
Branch: MAIN
Changes since 1.3: +6 -7 lines
fix previous modif (ilev_4 declared multiple times)

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

  ViewVC Help
Powered by ViewVC 1.1.22