/[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.111 - (hide annotations) (download)
Mon Dec 20 01:55:37 2004 UTC (19 years, 5 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint57b_post, checkpoint57c_post, checkpoint57c_pre
Changes since 1.110: +8 -1 lines
call diagnostics_switch_onoff at the beginning of the time-step

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

  ViewVC Help
Powered by ViewVC 1.1.22