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

Annotation of /MITgcm/model/src/forward_step.F

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


Revision 1.127 - (hide annotations) (download)
Thu Dec 8 15:44:34 2005 UTC (18 years, 6 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint57y_post, checkpoint58, checkpoint57z_post
Changes since 1.126: +38 -2 lines
First step for a NLFS adjoint
o initially suppress rStar (new flag DISABLE_RSTAR_CODE)
o new init. routines for calc_r_star, calc_surf_dr
o still need to deal with ini_masks_etc
o testreport seemed happy

1 heimbach 1.127 C $Header: /u/gcmpack/MITgcm/model/src/forward_step.F,v 1.126 2005/12/08 00:15:52 stephd Exp $
2 adcroft 1.15 C $Name: $
3 adcroft 1.1
4 edhill 1.64 #include "PACKAGES_CONFIG.h"
5 adcroft 1.1 #include "CPP_OPTIONS.h"
6 edhill 1.64
7 stephd 1.101 #ifdef ALLOW_OFFLINE
8     # include "OFFLINE_OPTIONS.h"
9     #endif
10 heimbach 1.104 #ifdef ALLOW_GMREDI
11     # include "GMREDI_OPTIONS.h"
12     #endif
13 adcroft 1.1
14 cnh 1.22 CBOP
15     C !ROUTINE: FORWARD_STEP
16     C !INTERFACE:
17 adcroft 1.13 SUBROUTINE FORWARD_STEP( iloop, myTime, myIter, myThid )
18 heimbach 1.12
19 cnh 1.22 C !DESCRIPTION: \bv
20     C *==================================================================
21     C | SUBROUTINE forward_step
22     C | o Run the ocean model and, optionally, evaluate a cost function.
23     C *==================================================================
24     C |
25     C | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and
26     C | Adjoint Model Compiler (TAMC). For this purpose the initialization
27     C | of the model was split into two parts. Those parameters that do
28     C | not depend on a specific model run are set in INITIALISE_FIXED,
29     C | whereas those that do depend on the specific realization are
30     C | initialized in INITIALISE_VARIA.
31     C |
32     C *==================================================================
33     C \ev
34 adcroft 1.1
35 cnh 1.22 C !USES:
36     IMPLICIT NONE
37     C == Global variables ==
38 adcroft 1.1 #include "SIZE.h"
39     #include "EEPARAMS.h"
40     #include "PARAMS.h"
41     #include "DYNVARS.h"
42    
43 edhill 1.121 #ifdef ALLOW_MNC
44     #include "MNC_PARAMS.h"
45     EXTERNAL DIFFERENT_MULTIPLE
46     LOGICAL DIFFERENT_MULTIPLE
47     #endif
48    
49 edhill 1.125 #ifdef HAVE_SIGREG
50     #include "SIGREG.h"
51     #endif
52    
53 jmc 1.27 #ifdef ALLOW_SHAP_FILT
54 jmc 1.91 # include "SHAP_FILT.h"
55 jmc 1.27 #endif
56     #ifdef ALLOW_ZONAL_FILT
57 jmc 1.91 # include "ZONAL_FILT.h"
58 jmc 1.27 #endif
59 jmc 1.93 #ifdef COMPONENT_MODULE
60     # include "CPL_PARAMS.h"
61     #endif
62 jmc 1.27
63 heimbach 1.12 #ifdef ALLOW_AUTODIFF_TAMC
64 jmc 1.91 # include "FFIELDS.h"
65    
66 heimbach 1.30 # include "tamc.h"
67     # include "ctrl.h"
68     # include "ctrl_dummy.h"
69     # include "cost.h"
70 heimbach 1.37 # include "EOS.h"
71 heimbach 1.127 # ifdef NONLIN_FRSURF
72     # include "GRID.h"
73     # endif
74 edhill 1.69 # ifdef ALLOW_EXF
75 heimbach 1.30 # include "exf_fields.h"
76 heimbach 1.85 # include "exf_clim_fields.h"
77 jmc 1.63 # ifdef ALLOW_BULKFORMULAE
78 heimbach 1.30 # include "exf_constants.h"
79     # endif
80     # endif
81     # ifdef ALLOW_OBCS
82     # include "OBCS.h"
83     # endif
84 heimbach 1.56 # ifdef ALLOW_PTRACERS
85 jmc 1.99 # include "PTRACERS_SIZE.h"
86 heimbach 1.56 # include "PTRACERS.h"
87 heimbach 1.82 # endif
88     # ifdef ALLOW_CD_CODE
89     # include "CD_CODE_VARS.h"
90 heimbach 1.56 # endif
91 heimbach 1.92 # ifdef ALLOW_EBM
92     # include "EBM.h"
93     # endif
94 heimbach 1.102 # ifdef EXACT_CONSERV
95     # include "SURFACE.h"
96     # endif
97 heimbach 1.104 # ifdef ALLOW_KPP
98     # include "KPP.h"
99     # endif
100     # ifdef ALLOW_GMREDI
101     # include "GMREDI.h"
102     # endif
103 heimbach 1.56 #endif /* ALLOW_AUTODIFF_TAMC */
104 heimbach 1.12
105 cnh 1.22 C !LOCAL VARIABLES:
106     C == Routine arguments ==
107 adcroft 1.13 C note: under the multi-threaded model myiter and
108     C mytime are local variables passed around as routine
109     C arguments. Although this is fiddly it saves the need to
110     C impose additional synchronisation points when they are
111     C updated.
112 jmc 1.93 C myIter - iteration counter for this thread
113     C myTime - time counter for this thread
114     C myThid - thread number for this instance of the routine.
115     INTEGER iloop
116     INTEGER myThid
117     INTEGER myIter
118     _RL myTime
119 molod 1.83
120 jmc 1.93 C == Local variables ==
121 jmc 1.123 #ifdef COMPONENT_MODULE
122 jmc 1.93 INTEGER myItP1
123 jmc 1.123 #endif
124 cnh 1.22 CEOP
125 heimbach 1.12
126 edhill 1.71 #ifdef ALLOW_DEBUG
127 heimbach 1.57 IF ( debugLevel .GE. debLevB )
128     & CALL DEBUG_ENTER('FORWARD_STEP',myThid)
129 adcroft 1.53 #endif
130    
131 heimbach 1.12 #ifdef ALLOW_AUTODIFF_TAMC
132 dimitri 1.45 C-- Reset the model iteration counter and the model time.
133 jmc 1.114 myIter = nIter0 + (iloop-1)
134     myTime = startTime + float(iloop-1)*deltaTclock
135 heimbach 1.12 #endif
136    
137 heimbach 1.28 #ifdef ALLOW_AUTODIFF_TAMC
138     c**************************************
139     #include "checkpoint_lev1_directives.h"
140     c**************************************
141 heimbach 1.23 #endif
142 cheisey 1.38
143 jmc 1.111 C-- Switch on/off diagnostics for snap-shot output:
144     #ifdef ALLOW_DIAGNOSTICS
145     IF ( useDiagnostics ) THEN
146 jmc 1.115 CALL DIAGNOSTICS_SWITCH_ONOFF( myTime, myIter, myThid )
147 jmc 1.111 ENDIF
148     #endif
149    
150 jmc 1.112 C-- State-variables diagnostics
151     IF ( usediagnostics ) THEN
152     CALL TIMER_START('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid)
153     CALL DO_STATEVARS_DIAGS( myTime, 0, myIter, myThid )
154     CALL TIMER_STOP ('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid)
155     ENDIF
156    
157 heimbach 1.37 C-- Call external forcing package
158 cheisey 1.40 #ifdef ALLOW_BULK_FORCE
159 jmc 1.76 IF ( useBulkForce ) THEN
160 edhill 1.71 #ifdef ALLOW_DEBUG
161 jmc 1.58 IF ( debugLevel .GE. debLevB )
162 heimbach 1.57 & CALL DEBUG_CALL('BULKF_FIELDS_LOAD',myThid)
163 adcroft 1.53 #endif
164 jmc 1.76 CALL TIMER_START('BULKF_FORCING [FORWARD_STEP]',mythid)
165     C- load all forcing fields at current time
166     CALL BULKF_FIELDS_LOAD( myTime, myIter, myThid )
167     C- calculate qnet and empmr (and wind stress)
168     CALL BULKF_FORCING( myTime, myIter, myThid )
169     CALL TIMER_STOP ('BULKF_FORCING [FORWARD_STEP]',mythid)
170 jmc 1.63 ELSE
171 jmc 1.58 #endif /* ALLOW_BULK_FORCE */
172 jmc 1.63
173 edhill 1.64 # ifdef ALLOW_EXF
174 heimbach 1.72 # ifdef ALLOW_DEBUG
175 heimbach 1.57 IF ( debugLevel .GE. debLevB )
176     & CALL DEBUG_CALL('EXF_GETFORCING',myThid)
177 heimbach 1.72 # endif
178 dimitri 1.45 CALL TIMER_START('EXF_GETFORCING [FORWARD_STEP]',mythid)
179     CALL EXF_GETFORCING( mytime, myiter, mythid )
180     CALL TIMER_STOP ('EXF_GETFORCING [FORWARD_STEP]',mythid)
181 edhill 1.64 # else /* ALLOW_EXF undef */
182 heimbach 1.49 cph The following IF-statement creates an additional dependency
183     cph for the forcing fields requiring additional storing.
184     cph Therefore, the IF-statement will be put between CPP-OPTIONS,
185     cph assuming that ALLOW_SEAICE has not yet been differentiated.
186 heimbach 1.92 # if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM))
187     IF ( .NOT. useSEAICE .AND. .NOT. useEBM ) THEN
188 heimbach 1.49 # endif
189 edhill 1.71 #ifdef ALLOW_DEBUG
190 heimbach 1.57 IF ( debugLevel .GE. debLevB )
191     & CALL DEBUG_CALL('EXTERNAL_FIELDS_LOAD',myThid)
192 adcroft 1.53 #endif
193 dimitri 1.45 CALL TIMER_START('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)
194     CALL EXTERNAL_FIELDS_LOAD( mytime, myiter, mythid )
195     CALL TIMER_STOP ('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)
196 heimbach 1.92 # if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM))
197 dimitri 1.45 ENDIF
198 heimbach 1.49 # endif
199 edhill 1.64 # endif /* ALLOW_EXF */
200 jmc 1.63 #ifdef ALLOW_BULK_FORCE
201     C-- end of if/else block useBulfforce --
202     ENDIF
203     #endif /* ALLOW_BULK_FORCE */
204 heimbach 1.49
205 heimbach 1.68 #ifdef ALLOW_AUTODIFF
206 heimbach 1.49 c-- Add control vector for forcing and parameter fields
207     if ( myiter .EQ. nIter0 )
208     & CALL CTRL_MAP_FORCING (mythid)
209     #endif
210 cheisey 1.38
211 heimbach 1.106 #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))
212     C Include call to a dummy routine. Its adjoint will be
213     C called at the proper place in the adjoint code.
214     C The adjoint routine will print out adjoint values
215     C if requested. The location of the call is important,
216     C it has to be after the adjoint of the exchanges
217     C (DO_GTERM_BLOCKING_EXCHANGES).
218     CALL DUMMY_IN_STEPPING( myTime, myIter, myThid )
219     cph I've commented this line since it may conflict with MITgcm's adjoint
220     cph However, need to check whether that's still consistent
221     cph with the ecco-branch (it should).
222     cph CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )
223     #endif
224    
225 heimbach 1.49 # ifdef ALLOW_SEAICE
226 dimitri 1.45 C-- Call sea ice model to compute forcing/external data fields. In
227     C addition to computing prognostic sea-ice variables and diagnosing the
228     C forcing/external data fields that drive the ocean model, SEAICE_MODEL
229     C also sets theta to the freezing point under sea-ice. The implied
230     C surface heat flux is then stored in variable surfaceTendencyTice,
231     C which is needed by KPP package (kpp_calc.F and kpp_transport_t.F)
232     C to diagnose surface buoyancy fluxes and for the non-local transport
233     C term. Because this call precedes model thermodynamics, temperature
234     C under sea-ice may not be "exactly" at the freezing point by the time
235     C theta is dumped or time-averaged.
236     IF ( useSEAICE ) THEN
237 edhill 1.71 #ifdef ALLOW_DEBUG
238 heimbach 1.57 IF ( debugLevel .GE. debLevB )
239     & CALL DEBUG_CALL('SEAICE_MODEL',myThid)
240 adcroft 1.53 #endif
241 heimbach 1.36 CALL TIMER_START('SEAICE_MODEL [FORWARD_STEP]',myThid)
242 jmc 1.41 CALL SEAICE_MODEL( myTime, myIter, myThid )
243 heimbach 1.36 CALL TIMER_STOP ('SEAICE_MODEL [FORWARD_STEP]',myThid)
244 dimitri 1.45 ENDIF
245 dimitri 1.50 # endif /* ALLOW_SEAICE */
246 dimitri 1.73
247 heimbach 1.56 #ifdef ALLOW_AUTODIFF_TAMC
248     # ifdef ALLOW_PTRACERS
249     cph this replaces _bibj storing of ptracer within thermodynamics
250     CADJ STORE ptracer = comlev1, key = ikey_dynamics
251     # endif
252     #endif
253 stephd 1.62
254 stephd 1.101 #ifdef ALLOW_OFFLINE
255     call OFFLINE_FIELDS_LOAD( myTime, myIter, myThid )
256     #endif
257    
258 stephd 1.62 #ifdef ALLOW_PTRACERS
259     # ifdef ALLOW_GCHEM
260 mlosch 1.108 IF ( useGCHEM ) THEN
261 mlosch 1.113 #ifdef ALLOW_DEBUG
262     IF ( debugLevel .GE. debLevB )
263     & CALL DEBUG_CALL('GCHEM_FIELDS_LOAD',myThid)
264     #endif /* ALLOW_DEBUG */
265 stephd 1.62 CALL GCHEM_FIELDS_LOAD( mytime, myiter, mythid )
266 mlosch 1.108 ENDIF
267 stephd 1.62 # endif
268     #endif
269 jmc 1.78
270 stephd 1.126 #ifdef ALLOW_RBCS
271     IF ( useRBCS ) THEN
272     CALL RBCS_FIELDS_LOAD( mytime, myiter, mythid )
273     ENDIF
274     #endif
275    
276 jmc 1.78 #ifdef COMPONENT_MODULE
277 jmc 1.93 IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN
278 jmc 1.78 C Post coupling data that I export.
279     C Read in coupling data that I import.
280     CALL TIMER_START('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid)
281     CALL CPL_EXPORT_MY_DATA( myIter, myTime, myThid )
282     CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )
283     CALL TIMER_STOP ('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid)
284     ENDIF
285     #endif /* COMPONENT_MODULE */
286 stephd 1.62
287 heimbach 1.92 #ifdef ALLOW_EBM
288     IF ( useEBM ) THEN
289     # ifdef ALLOW_DEBUG
290     IF ( debugLevel .GE. debLevB )
291     & CALL DEBUG_CALL('EBM',myThid)
292     # endif
293     CALL TIMER_START('EBM [FORWARD_STEP]',mythid)
294     CALL EBM_DRIVER ( myTime, myIter, myThid )
295     CALL TIMER_STOP ('EBM [FORWARD_STEP]',mythid)
296     ENDIF
297     #endif
298 molod 1.79
299 jmc 1.97 C-- Step forward fields and calculate time tendency terms.
300    
301     #ifdef ALLOW_DEBUG
302     IF ( debugLevel .GE. debLevB )
303     & CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)
304     #endif
305     CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)
306     CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )
307     CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)
308    
309 heimbach 1.104 #ifdef ALLOW_AUTODIFF_TAMC
310     CADJ STORE theta = comlev1, key = ikey_dynamics
311     CADJ STORE salt = comlev1, key = ikey_dynamics
312     CADJ STORE totphihyd = comlev1, key = ikey_dynamics
313     CADJ STORE surfaceforcingtice = comlev1, key = ikey_dynamics
314     # ifdef ALLOW_KPP
315     CADJ STORE uvel = comlev1, key = ikey_dynamics
316     CADJ STORE vvel = comlev1, key = ikey_dynamics
317     # endif
318     # ifdef EXACT_CONSERV
319 heimbach 1.105 CADJ STORE empmr = comlev1, key = ikey_dynamics
320 heimbach 1.104 CADJ STORE pmepr = comlev1, key = ikey_dynamics
321     # endif
322 heimbach 1.127 # ifdef NONLIN_FRSURF
323     cph-test
324     CADJ STORE hFac_surfC = comlev1, key = ikey_dynamics
325     CADJ STORE hfac_surfs = comlev1, key = ikey_dynamics
326     CADJ STORE hfac_surfw = comlev1, key = ikey_dynamics
327     CADJ STORE hFacC, hFacS, hFacW
328     CADJ & = comlev1, key = ikey_dynamics
329     CADJ STORE recip_hFacC, recip_hFacS, recip_hFacW
330     CADJ & = comlev1, key = ikey_dynamics
331     # endif
332 heimbach 1.104 #endif /* ALLOW_AUTODIFF_TAMC */
333    
334 stephd 1.101 #ifndef ALLOW_OFFLINE
335 edhill 1.71 #ifdef ALLOW_DEBUG
336 jmc 1.96 IF ( debugLevel .GE. debLevB )
337     & CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)
338     #endif
339     CALL TIMER_START('DO_OCEANIC_PHYS [FORWARD_STEP]',mythid)
340     CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )
341     CALL TIMER_STOP ('DO_OCEANIC_PHYS [FORWARD_STEP]',mythid)
342 stephd 1.101 #endif
343 jmc 1.96
344 mlosch 1.110 #ifdef ALLOW_GCHEM
345     C GCHEM package is an interface for any bio-geochemical or
346     C ecosystem model you would like to include.
347     C If GCHEM_SEPARATE_FORCING is not defined, you are
348     C responsible for computing tendency terms for passive
349     C tracers and storing them on a 3DxNumPtracers-array called
350     C gchemTendency in GCHEM_CALC_TENDENCY. This tendency is then added
351     C to gPtr in ptracers_forcing later-on.
352     C If GCHEM_SEPARATE_FORCING is defined, you are reponsible for
353     C UPDATING ptracers directly in GCHEM_FORCING_SEP. This amounts
354     C to a completely separate time step that you have to implement
355     C yourself (Eulerian seems to be fine in most cases).
356     CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
357     C CAVEAT: Up to now, when GCHEM is turned on the field ptracerForcingSurf,
358     C which is needed for KPP is not set properly. ptracerForcingSurf must
359     C be treated differently depending on whether GCHEM_SEPARATE_FORCING
360     C is define or not. TBD.
361     CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
362 mlosch 1.113 IF ( useGCHEM ) THEN
363 mlosch 1.110 #ifdef ALLOW_DEBUG
364 mlosch 1.113 IF ( debugLevel .GE. debLevB )
365     & CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid)
366 mlosch 1.110 #endif
367     CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
368     CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid )
369     CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
370     ENDIF
371     #endif /* ALLOW_GCHEM */
372 mlosch 1.109
373 heimbach 1.104 #ifdef ALLOW_AUTODIFF_TAMC
374     cph needed to be moved here from do_oceanic_physics
375     cph to be visible down the road
376     c
377     CADJ STORE surfaceForcingS = comlev1, key = ikey_dynamics
378     CADJ STORE surfaceForcingT = comlev1, key = ikey_dynamics
379     CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics
380     ctest(
381 heimbach 1.105 CADJ STORE IVDConvCount = comlev1, key = ikey_dynamics
382     ctest)
383     # ifdef ALLOW_PTRACERS
384     CADJ STORE surfaceForcingPtr = comlev1, key = ikey_dynamics
385 heimbach 1.104 # endif
386     c
387     # ifdef ALLOW_GMREDI
388     CADJ STORE Kwx = comlev1, key = ikey_dynamics
389     CADJ STORE Kwy = comlev1, key = ikey_dynamics
390     CADJ STORE Kwz = comlev1, key = ikey_dynamics
391     # ifdef GM_BOLUS_ADVEC
392     CADJ STORE GM_PsiX = comlev1, key = ikey_dynamics
393     CADJ STORE GM_PsiY = comlev1, key = ikey_dynamics
394     # endif
395     # endif
396     c
397     # ifdef ALLOW_KPP
398     CADJ STORE KPPghat = comlev1, key = ikey_dynamics
399     CADJ STORE KPPfrac = comlev1, key = ikey_dynamics
400 heimbach 1.105 CADJ STORE KPPdiffKzS = comlev1, key = ikey_dynamics
401     CADJ STORE KPPdiffKzT = comlev1, key = ikey_dynamics
402 heimbach 1.104 # endif
403 heimbach 1.127 c
404     # ifdef NONLIN_FRSURF
405     cph-test
406     CADJ STORE etaN = comlev1, key = ikey_dynamics
407     CADJ STORE etaH = comlev1, key = ikey_dynamics
408     CADJ STORE uVel = comlev1, key = ikey_dynamics
409     CADJ STORE vVel = comlev1, key = ikey_dynamics
410     # ifdef ALLOW_CD_CODE
411     CADJ STORE etanm1 = comlev1, key = ikey_dynamics
412     # endif
413     # endif
414 heimbach 1.104 #endif /* ALLOW_AUTODIFF_TAMC */
415    
416 jmc 1.96 IF ( .NOT.staggerTimeStep ) THEN
417     #ifdef ALLOW_DEBUG
418     IF ( debugLevel .GE. debLevB )
419 heimbach 1.57 & CALL DEBUG_CALL('THERMODYNAMICS',myThid)
420 adcroft 1.53 #endif
421 heimbach 1.36 CALL TIMER_START('THERMODYNAMICS [FORWARD_STEP]',mythid)
422 adcroft 1.15 CALL THERMODYNAMICS( myTime, myIter, myThid )
423 heimbach 1.36 CALL TIMER_STOP ('THERMODYNAMICS [FORWARD_STEP]',mythid)
424 jmc 1.96 C-- if not staggerTimeStep: end
425 dimitri 1.45 ENDIF
426 jmc 1.93
427     #ifdef COMPONENT_MODULE
428     IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN
429     C Post coupling data that I export.
430     C Read in coupling data that I import.
431     myItP1 = myIter + 1
432     CALL TIMER_START('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid)
433     CALL CPL_EXPORT_MY_DATA( myItP1, myTime, myThid )
434     CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )
435     CALL TIMER_STOP ('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid)
436     # ifndef ALLOW_AIM
437     IF ( useRealFreshWaterFlux ) THEN
438     CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )
439     ENDIF
440     # endif
441     ENDIF
442     #endif /* COMPONENT_MODULE */
443 heimbach 1.12
444 dimitri 1.45 C-- Step forward fields and calculate time tendency terms.
445 stephd 1.101 #ifndef ALLOW_OFFLINE
446 heimbach 1.61 #ifndef ALLOW_AUTODIFF_TAMC
447 dimitri 1.45 IF ( momStepping ) THEN
448 heimbach 1.61 #endif
449 edhill 1.71 #ifdef ALLOW_DEBUG
450 heimbach 1.57 IF ( debugLevel .GE. debLevB )
451     & CALL DEBUG_CALL('DYNAMICS',myThid)
452 adcroft 1.53 #endif
453 heimbach 1.36 CALL TIMER_START('DYNAMICS [FORWARD_STEP]',mythid)
454 heimbach 1.12 CALL DYNAMICS( myTime, myIter, myThid )
455 heimbach 1.36 CALL TIMER_STOP ('DYNAMICS [FORWARD_STEP]',mythid)
456 heimbach 1.61 #ifndef ALLOW_AUTODIFF_TAMC
457 dimitri 1.45 ENDIF
458 heimbach 1.61 #endif
459 stephd 1.101 #endif
460 heimbach 1.12
461 jmc 1.96 C-- Update time-counter
462     myIter = nIter0 + iLoop
463     myTime = startTime + deltaTClock * float(iLoop)
464    
465 edhill 1.119 #ifdef ALLOW_MNC
466     C Update the default next iter for MNC
467     IF ( useMNC ) THEN
468 jmc 1.120 CALL MNC_CW_CITER_SETG( 1, 1, -1, myIter , myThid )
469 edhill 1.119
470     C TODO: Logic should be added here so that users can specify, on
471     C a per-citer-group basis, when it is time to update the
472     C "current" (and not just the "next") iteration
473 edhill 1.121
474     C TODO: the following is just a temporary band-aid (mostly, for
475     C Baylor) until someone writes a routine that better handles time
476     C boundaries such as weeks, months, years, etc.
477     IF ( mnc_filefreq .GT. 0 ) THEN
478     IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock))
479     & THEN
480     CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid )
481     ENDIF
482     ENDIF
483 edhill 1.119 ENDIF
484     #endif
485    
486 jmc 1.96 C-- Update geometric factors:
487 jmc 1.18 #ifdef NONLIN_FRSURF
488 jmc 1.96 C- update hfacC,W,S and recip_hFac according to etaH(n+1) :
489 jmc 1.18 IF ( nonlinFreeSurf.GT.0) THEN
490 jmc 1.48 IF ( select_rStar.GT.0 ) THEN
491 heimbach 1.127 # ifndef DISABLE_RSTAR_CODE
492 jmc 1.48 CALL TIMER_START('UPDATE_R_STAR [FORWARD_STEP]',myThid)
493     CALL UPDATE_R_STAR( myTime, myIter, myThid )
494     CALL TIMER_STOP ('UPDATE_R_STAR [FORWARD_STEP]',myThid)
495 heimbach 1.127 # endif /* DISABLE_RSTAR_CODE */
496 jmc 1.48 ELSE
497 heimbach 1.127 #ifdef ALLOW_AUTODIFF_TAMC
498     cph-test
499     CADJ STORE hFac_surfC, hFac_surfS, hFac_surfW
500     CADJ & = comlev1, key = ikey_dynamics
501     #endif
502 dimitri 1.45 CALL TIMER_START('UPDATE_SURF_DR [FORWARD_STEP]',myThid)
503 jmc 1.18 CALL UPDATE_SURF_DR( myTime, myIter, myThid )
504 heimbach 1.36 CALL TIMER_STOP ('UPDATE_SURF_DR [FORWARD_STEP]',myThid)
505 jmc 1.48 ENDIF
506 jmc 1.18 ENDIF
507     C- update also CG2D matrix (and preconditioner)
508 jmc 1.33 IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN
509 dimitri 1.45 CALL TIMER_START('UPDATE_CG2D [FORWARD_STEP]',myThid)
510 jmc 1.18 CALL UPDATE_CG2D( myTime, myIter, myThid )
511 jmc 1.47 CALL TIMER_STOP ('UPDATE_CG2D [FORWARD_STEP]',myThid)
512 adcroft 1.19 ENDIF
513 heimbach 1.127 #endif /* NONLIN_FRSURF */
514 adcroft 1.1
515 jmc 1.27 C-- Apply Filters to u*,v* before SOLVE_FOR_PRESSURE
516     #ifdef ALLOW_SHAP_FILT
517     IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN
518 jmc 1.122 CALL TIMER_START('SHAP_FILT_UV [FORWARD_STEP]',myThid)
519 jmc 1.27 IF (implicDiv2Dflow.LT.1.) THEN
520     C-- Explicit+Implicit part of the Barotropic Flow Divergence
521     C => Filtering of uVel,vVel is necessary
522 jmc 1.59 CALL SHAP_FILT_APPLY_UV( uVel,vVel,
523 jmc 1.96 & myTime, myIter, myThid )
524 jmc 1.27 ENDIF
525 jmc 1.96 CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)
526 jmc 1.122 CALL TIMER_STOP ('SHAP_FILT_UV [FORWARD_STEP]',myThid)
527 jmc 1.27 ENDIF
528     #endif
529     #ifdef ALLOW_ZONAL_FILT
530     IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN
531 jmc 1.122 CALL TIMER_START('ZONAL_FILT_UV [FORWARD_STEP]',myThid)
532 jmc 1.27 IF (implicDiv2Dflow.LT.1.) THEN
533     C-- Explicit+Implicit part of the Barotropic Flow Divergence
534     C => Filtering of uVel,vVel is necessary
535     CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )
536     ENDIF
537 jmc 1.59 CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )
538 jmc 1.122 CALL TIMER_STOP ('ZONAL_FILT_UV [FORWARD_STEP]',myThid)
539 jmc 1.27 ENDIF
540     #endif
541 heimbach 1.12
542 adcroft 1.1 C-- Solve elliptic equation(s).
543     C Two-dimensional only for conventional hydrostatic or
544     C three-dimensional for non-hydrostatic and/or IGW scheme.
545 stephd 1.101 #ifndef ALLOW_OFFLINE
546 adcroft 1.19 IF ( momStepping ) THEN
547 jmc 1.96 CALL TIMER_START('SOLVE_FOR_PRESSURE [FORWARD_STEP]',myThid)
548     CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)
549     CALL TIMER_STOP ('SOLVE_FOR_PRESSURE [FORWARD_STEP]',myThid)
550     ENDIF
551 stephd 1.101 #endif
552 jmc 1.96
553     C-- Correct divergence in flow field and cycle time-stepping momentum
554     c IF ( momStepping ) THEN
555 stephd 1.101 #ifndef ALLOW_OFFLINE
556 jmc 1.122 CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
557 jmc 1.96 CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)
558 jmc 1.122 CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
559 stephd 1.101 #endif
560 jmc 1.96 c ENDIF
561    
562     #ifdef EXACT_CONSERV
563     IF (exactConserv) THEN
564     C-- Update etaH(n+1) :
565 jmc 1.122 CALL TIMER_START('UPDATE_ETAH [FORWARD_STEP]',mythid)
566 jmc 1.96 CALL UPDATE_ETAH( myTime, myIter, myThid )
567 jmc 1.122 CALL TIMER_STOP ('UPDATE_ETAH [FORWARD_STEP]',mythid)
568 adcroft 1.19 ENDIF
569 jmc 1.96 #endif /* EXACT_CONSERV */
570    
571     #ifdef NONLIN_FRSURF
572     IF ( select_rStar.NE.0 ) THEN
573 heimbach 1.127 # ifndef DISABLE_RSTAR_CODE
574 jmc 1.96 C-- r* : compute the future level thickness according to etaH(n+1)
575     CALL TIMER_START('CALC_R_STAR [FORWARD_STEP]',mythid)
576     CALL CALC_R_STAR(etaH, myTime, myIter, myThid )
577     CALL TIMER_STOP ('CALC_R_STAR [FORWARD_STEP]',mythid)
578 heimbach 1.127 # endif /* DISABLE_RSTAR_CODE */
579 jmc 1.96 ELSEIF ( nonlinFreeSurf.GT.0) THEN
580     C-- compute the future surface level thickness according to etaH(n+1)
581 heimbach 1.127 #ifdef ALLOW_AUTODIFF_TAMC
582     CADJ STORE etaH = comlev1, key = ikey_dynamics
583     #endif
584 jmc 1.96 CALL TIMER_START('CALC_SURF_DR [FORWARD_STEP]',mythid)
585     CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )
586     CALL TIMER_STOP ('CALC_SURF_DR [FORWARD_STEP]',mythid)
587     ENDIF
588     #endif /* NONLIN_FRSURF */
589    
590     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
591     IF ( staggerTimeStep ) THEN
592 jmc 1.98 C-- do exchanges of U,V (needed for multiDim) when using stagger time-step :
593     #ifdef ALLOW_DEBUG
594     IF ( debugLevel .GE. debLevB )
595     & CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)
596     #endif
597     CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid)
598     CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
599     CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid)
600 jmc 1.96
601 jmc 1.112 C-- State-variables diagnostics
602     IF ( usediagnostics ) THEN
603     CALL TIMER_START('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid)
604     CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid )
605     CALL TIMER_STOP ('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid)
606     ENDIF
607    
608 jmc 1.96 #ifdef ALLOW_DEBUG
609     IF ( debugLevel .GE. debLevB )
610     & CALL DEBUG_CALL('THERMODYNAMICS',myThid)
611     #endif
612     CALL TIMER_START('THERMODYNAMICS [FORWARD_STEP]',mythid)
613     CALL THERMODYNAMICS( myTime, myIter, myThid )
614     CALL TIMER_STOP ('THERMODYNAMICS [FORWARD_STEP]',mythid)
615    
616     C-- if staggerTimeStep: end
617     ENDIF
618     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
619 adcroft 1.1
620 heimbach 1.37 #ifdef ALLOW_AUTODIFF_TAMC
621     cph This is needed because convective_adjustment calls
622     cph find_rho which may use pressure()
623 heimbach 1.51 CADJ STORE totphihyd = comlev1, key = ikey_dynamics
624 heimbach 1.37 #endif
625 jmc 1.96 C-- Cycle time-stepping Tracers arrays (T,S,+pTracers)
626 jmc 1.122 CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
627 jmc 1.96 CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)
628 jmc 1.122 CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
629 adcroft 1.5
630 mlosch 1.110 #ifdef ALLOW_GCHEM
631 mlosch 1.109 C Add separate timestepping of chemical/biological/forcing
632     C of ptracers here in GCHEM_FORCING_SEP
633 mlosch 1.113 IF ( useGCHEM ) THEN
634 mlosch 1.109 #ifdef ALLOW_DEBUG
635 mlosch 1.113 IF ( debugLevel .GE. debLevB )
636     & CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid)
637 mlosch 1.109 #endif /* ALLOW_DEBUG */
638     CALL TIMER_START('GCHEM_FORCING_SEP [FORWARD_STEP]',myThid)
639 mlosch 1.108 CALL GCHEM_FORCING_SEP( myTime,myIter,myThid )
640 mlosch 1.109 CALL TIMER_STOP ('GCHEM_FORCING_SEP [FORWARD_STEP]',myThid)
641 mlosch 1.108 ENDIF
642 mlosch 1.107 #endif /* ALLOW_GCHEM */
643    
644 adcroft 1.1 C-- Do "blocking" sends and receives for tendency "overlap" terms
645 heimbach 1.36 c CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid)
646 jmc 1.7 c CALL DO_GTERM_BLOCKING_EXCHANGES( myThid )
647 heimbach 1.36 c CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid)
648 adcroft 1.5
649     C-- Do "blocking" sends and receives for field "overlap" terms
650 heimbach 1.36 CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid)
651 adcroft 1.5 CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )
652 heimbach 1.36 CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid)
653 stephd 1.54
654 molod 1.83
655     C AMM
656     #ifdef ALLOW_GRIDALT
657 molod 1.88 if (useGRIDALT) then
658     CALL GRIDALT_UPDATE(myThid)
659 molod 1.89 endif
660 molod 1.83 #endif
661     C AMM
662 stephd 1.54
663 molod 1.79 C AMM
664     #ifdef ALLOW_FIZHI
665 molod 1.88 if( useFIZHI) then
666 molod 1.90 CALL TIMER_START('FIZHI [FORWARD_STEP]',mythid)
667 molod 1.88 CALL STEP_FIZHI_CORR ( myTime, myIter, myThid )
668 molod 1.90 CALL TIMER_STOP('FIZHI [FORWARD_STEP]',mythid)
669 molod 1.88 endif
670 molod 1.79 #endif
671     C AMM
672 adcroft 1.20
673     #ifdef ALLOW_FLT
674     C-- Calculate float trajectories
675     IF (useFLT) THEN
676 heimbach 1.36 CALL TIMER_START('FLOATS [FORWARD_STEP]',myThid)
677 adcroft 1.20 CALL FLT_MAIN(myIter,myTime, myThid)
678 heimbach 1.36 CALL TIMER_STOP ('FLOATS [FORWARD_STEP]',myThid)
679 adcroft 1.20 ENDIF
680     #endif
681 heimbach 1.12
682 jmc 1.112 C-- State-variables time-averaging
683     CALL TIMER_START('DO_STATEVARS_TAVE [FORWARD_STEP]',myThid)
684     CALL DO_STATEVARS_TAVE( myTime, myIter, myThid )
685     CALL TIMER_STOP ('DO_STATEVARS_TAVE [FORWARD_STEP]',myThid)
686 jmc 1.97
687 stephd 1.101 #ifndef ALLOW_OFFLINE
688 edhill 1.70 #ifdef ALLOW_MONITOR
689 heimbach 1.12 C-- Check status of solution (statistics, cfl, etc...)
690 dimitri 1.45 CALL TIMER_START('MONITOR [FORWARD_STEP]',myThid)
691 heimbach 1.12 CALL MONITOR( myIter, myTime, myThid )
692 heimbach 1.36 CALL TIMER_STOP ('MONITOR [FORWARD_STEP]',myThid)
693 edhill 1.70 #endif /* ALLOW_MONITOR */
694 stephd 1.101 #endif
695 molod 1.86
696 heimbach 1.103 #ifdef ALLOW_COST
697     C-- compare model with data and compute cost function
698     C-- this is done after exchanges to allow interpolation
699     CALL TIMER_START('COST_TILE [FORWARD_STEP]',myThid)
700     CALL COST_TILE ( mytime, myiter, myThid )
701     CALL TIMER_STOP ('COST_TILE [FORWARD_STEP]',myThid)
702     #endif
703    
704 jmc 1.7 C-- Do IO if needed.
705 stephd 1.101 #ifdef ALLOW_OFFLINE
706 heimbach 1.103 CALL TIMER_START('OFFLINE_MODEL_IO [FORWARD_STEP]',myThid)
707 stephd 1.101 CALL OFFLINE_MODEL_IO( myTime, myIter, myThid )
708 heimbach 1.103 CALL TIMER_STOP ('OFFLINE_MODEL_IO [FORWARD_STEP]',myThid)
709 stephd 1.101 #else
710 heimbach 1.36 CALL TIMER_START('DO_THE_MODEL_IO [FORWARD_STEP]',myThid)
711 heimbach 1.12 CALL DO_THE_MODEL_IO( myTime, myIter, myThid )
712 heimbach 1.36 CALL TIMER_STOP ('DO_THE_MODEL_IO [FORWARD_STEP]',myThid)
713 stephd 1.101 #endif
714 adcroft 1.1
715 edhill 1.125 #ifdef HAVE_SIGREG
716     IF ( useSIGREG ) THEN
717     IF ( i_got_signal .GT. 0 ) THEN
718     CALL PACKAGES_WRITE_PICKUP(
719     I .TRUE., myTime, myIter, myThid )
720     #ifndef ALLOW_OFFLINE
721     CALL WRITE_CHECKPOINT(
722     I .TRUE., myTime, myIter, myThid )
723     #endif
724     STOP 'Checkpoint completed -- killed by signal handler'
725     ENDIF
726     ENDIF
727     #endif
728    
729 adcroft 1.1 C-- Save state for restarts
730 heimbach 1.36 CALL TIMER_START('WRITE_CHECKPOINT [FORWARD_STEP]',myThid)
731 jmc 1.77 CALL PACKAGES_WRITE_PICKUP(
732     I .FALSE., myTime, myIter, myThid )
733 stephd 1.101 #ifndef ALLOW_OFFLINE
734 adcroft 1.1 CALL WRITE_CHECKPOINT(
735 jmc 1.77 I .FALSE., myTime, myIter, myThid )
736 stephd 1.101 #endif
737 heimbach 1.36 CALL TIMER_STOP ('WRITE_CHECKPOINT [FORWARD_STEP]',myThid)
738 adcroft 1.53
739 edhill 1.71 #ifdef ALLOW_DEBUG
740 heimbach 1.57 IF ( debugLevel .GE. debLevB )
741     & CALL DEBUG_LEAVE('FORWARD_STEP',myThid)
742 adcroft 1.53 #endif
743 adcroft 1.1
744 jmc 1.77 RETURN
745 adcroft 1.1 END

  ViewVC Help
Powered by ViewVC 1.1.22