/[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.9 - (show annotations) (download)
Sat Apr 13 20:47:18 2013 UTC (11 years, 1 month ago) by heimbach
Branch: MAIN
Changes since 1.8: +4 -1 lines
Add headers for THSICE adjoint.

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

  ViewVC Help
Powered by ViewVC 1.1.22