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

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

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

revision 1.103 by heimbach, Mon Sep 27 18:00:19 2004 UTC revision 1.162 by heimbach, Mon Oct 27 20:33:35 2008 UTC
# Line 4  C $Name$ Line 4  C $Name$
4  #include "PACKAGES_CONFIG.h"  #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7  #ifdef ALLOW_GCHEM  #ifdef ALLOW_GMREDI
8  # include "GCHEM_OPTIONS.h"  # include "GMREDI_OPTIONS.h"
9  #endif  #endif
10  #ifdef ALLOW_OFFLINE  #ifdef ALLOW_OBCS
11  # include "OFFLINE_OPTIONS.h"  # include "OBCS_OPTIONS.h"
12    #endif
13    #ifdef ALLOW_SEAICE
14    # include "SEAICE_OPTIONS.h"
15  #endif  #endif
   
16    
17  CBOP  CBOP
18  C     !ROUTINE: FORWARD_STEP  C     !ROUTINE: FORWARD_STEP
# Line 26  C     | Line 28  C     |
28  C     | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and  C     | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and
29  C     | Adjoint Model Compiler (TAMC). For this purpose the initialization  C     | Adjoint Model Compiler (TAMC). For this purpose the initialization
30  C     | of the model was split into two parts. Those parameters that do  C     | of the model was split into two parts. Those parameters that do
31  C     | not depend on a specific model run are set in INITIALISE_FIXED,    C     | not depend on a specific model run are set in INITIALISE_FIXED,
32  C     | whereas those that do depend on the specific realization are  C     | whereas those that do depend on the specific realization are
33  C     | initialized in INITIALISE_VARIA.    C     | initialized in INITIALISE_VARIA.
34  C     |  C     |
35  C     *==================================================================  C     *==================================================================
36  C     \ev  C     \ev
# Line 41  C     == Global variables == Line 43  C     == Global variables ==
43  #include "PARAMS.h"  #include "PARAMS.h"
44  #include "DYNVARS.h"  #include "DYNVARS.h"
45    
46    #ifdef ALLOW_MNC
47    #include "MNC_PARAMS.h"
48    #endif
49    
50    #ifdef HAVE_SIGREG
51    #include "SIGREG.h"
52    #endif
53    
54  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
55  # include "SHAP_FILT.h"  # include "SHAP_FILT.h"
56  #endif  #endif
# Line 53  C     == Global variables == Line 63  C     == Global variables ==
63    
64  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
65  # include "FFIELDS.h"  # include "FFIELDS.h"
66    # include "SURFACE.h"
 # ifdef ALLOW_NONHYDROSTATIC  
 #  include "CG3D.h"  
 # endif  
67    
68  # include "tamc.h"  # include "tamc.h"
69  # include "ctrl.h"  # include "ctrl.h"
70  # include "ctrl_dummy.h"  # include "ctrl_dummy.h"
71  # include "cost.h"  # include "cost.h"
72  # include "EOS.h"  # include "EOS.h"
73    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
74    #  include "GRID.h"
75    # endif
76  # ifdef ALLOW_EXF  # ifdef ALLOW_EXF
77  #  include "exf_fields.h"  #  include "EXF_FIELDS.h"
 #  include "exf_clim_fields.h"  
78  #  ifdef ALLOW_BULKFORMULAE  #  ifdef ALLOW_BULKFORMULAE
79  #   include "exf_constants.h"  #   include "EXF_CONSTANTS.h"
80  #  endif  #  endif
81  # endif  # endif
 # ifdef ALLOW_OBCS  
 #  include "OBCS.h"  
 # endif  
82  # ifdef ALLOW_PTRACERS  # ifdef ALLOW_PTRACERS
83  #  include "PTRACERS_SIZE.h"  #  include "PTRACERS_SIZE.h"
84  #  include "PTRACERS.h"  #  include "PTRACERS_FIELDS.h"
85    # endif
86    # ifdef ALLOW_GCHEM
87    #  include "GCHEM_FIELDS.h"
88    # endif
89    # ifdef ALLOW_CFC
90    #  include "CFC.h"
91    # endif
92    # ifdef ALLOW_DIC
93    #  include "DIC_VARS.h"
94    #  include "DIC_LOAD.h"
95    #  include "DIC_ATMOS.h"
96    # endif
97    # ifdef ALLOW_OBCS
98    #  include "OBCS.h"
99    #  ifdef ALLOW_PTRACERS
100    #   include "OBCS_PTRACERS.h"
101    #  endif
102  # endif  # endif
103  # ifdef ALLOW_CD_CODE  # ifdef ALLOW_CD_CODE
104  #  include "CD_CODE_VARS.h"  #  include "CD_CODE_VARS.h"
105  # endif  # endif
106    # ifdef ALLOW_THSICE
107    #  include "THSICE_VARS.h"
108    # endif
109    # ifdef ALLOW_SEAICE
110    #  include "SEAICE.h"
111    # endif
112    # ifdef ALLOW_SALT_PLUME
113    #  include "SALT_PLUME.h"
114    # endif
115  # ifdef ALLOW_EBM  # ifdef ALLOW_EBM
116  #  include "EBM.h"  #  include "EBM.h"
117  # endif  # endif
118  # ifdef EXACT_CONSERV  # ifdef ALLOW_KPP
119  #  include "SURFACE.h"  #  include "KPP.h"
120    # endif
121    # ifdef ALLOW_GMREDI
122    #  include "GMREDI.h"
123    # endif
124    # ifdef ALLOW_RBCS
125    #  include "RBCS.h"
126  # endif  # endif
127  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
128    
129  C     !LOCAL VARIABLES:  #ifdef ALLOW_MNC
130          EXTERNAL DIFFERENT_MULTIPLE
131          LOGICAL  DIFFERENT_MULTIPLE
132    #endif
133    
134    
135    C     !INPUT/OUTPUT PARAMETERS:
136  C     == Routine arguments ==  C     == Routine arguments ==
137  C     note: under the multi-threaded model myiter and  C     note: under the multi-threaded model myIter and
138  C           mytime are local variables passed around as routine  C           myTime are local variables passed around as routine
139  C           arguments. Although this is fiddly it saves the need to  C           arguments. Although this is fiddly it saves the need to
140  C           impose additional synchronisation points when they are  C           impose additional synchronisation points when they are
141  C           updated.  C           updated.
142  C     myIter - iteration counter for this thread  C     myTime :: time counter for this thread
143  C     myTime - time counter for this thread  C     myIter :: iteration counter for this thread
144  C     myThid - thread number for this instance of the routine.  C     myThid :: thread number for this instance of the routine.
145        INTEGER iloop        INTEGER iloop
       INTEGER myThid  
       INTEGER myIter  
146        _RL     myTime        _RL     myTime
147          INTEGER myIter
148          INTEGER myThid
149    
150    C     !LOCAL VARIABLES:
151  C     == Local variables ==  C     == Local variables ==
152    C     modelEnd  :: true if reaching the end of the run
153          LOGICAL modelEnd
154    #ifdef COMPONENT_MODULE
155        INTEGER myItP1        INTEGER myItP1
156    #endif
157  CEOP  CEOP
158    
159  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
160        IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
161       &    CALL DEBUG_ENTER('FORWARD_STEP',myThid)       &    CALL DEBUG_ENTER('FORWARD_STEP',myThid)
162  #endif  #endif
163    
164  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
165  C--   Reset the model iteration counter and the model time.        CALL AUTODIFF_INADMODE_UNSET( myThid )
       myiter = nIter0 + (iloop-1)  
       mytime = startTime + float(iloop-1)*deltaTclock  
166  #endif  #endif
167    
168  #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))  #ifdef ALLOW_AUTODIFF_TAMC
169  C     Include call to a dummy routine. Its adjoint will be  C--   Reset the model iteration counter and the model time.
170  C     called at the proper place in the adjoint code.        myIter = nIter0 + (iloop-1)
171  C     The adjoint routine will print out adjoint values        myTime = startTime + float(iloop-1)*deltaTclock
 C     if requested. The location of the call is important,  
 C     it has to be after the adjoint of the exchanges  
 C     (DO_GTERM_BLOCKING_EXCHANGES).  
       CALL DUMMY_IN_STEPPING( myTime, myIter, myThid )  
 cph   I've commented this line since it may conflict with MITgcm's adjoint  
 cph   However, need to check whether that's still consistent  
 cph   with the ecco-branch (it should).  
 cph      CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )  
172  #endif  #endif
173    
174  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
175  c**************************************  c**************************************
176  #include "checkpoint_lev1_directives.h"  #include "checkpoint_lev1_directives.h"
177    #include "checkpoint_lev1_template.h"
178  c**************************************  c**************************************
179  #endif  #endif
180    
181  C--   Call external forcing package  C--   Switch on/off diagnostics for snap-shot output:
182  #ifdef ALLOW_BULK_FORCE  #ifdef ALLOW_DIAGNOSTICS
183        IF ( useBulkForce ) THEN        IF ( useDiagnostics ) THEN
184            CALL DIAGNOSTICS_SWITCH_ONOFF( myTime, myIter, myThid )
185    C--   State-variables diagnostics
186            CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
187            CALL DO_STATEVARS_DIAGS( myTime, 0, myIter, myThid )
188            CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
189          ENDIF
190    #endif
191    
192    #ifdef ALLOW_PROFILES
193  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
194         IF ( debugLevel .GE. debLevB )        IF (debugMode) CALL DEBUG_CALL('',myThid)
195       &    CALL DEBUG_CALL('BULKF_FIELDS_LOAD',myThid)  #endif
196    c--     Accumulate in-situ time averages of theta, salt, and SSH.
197            CALL TIMER_START('PROFILES_INLOOP    [THE_MAIN_LOOP]', mythid)
198            CALL PROFILES_INLOOP( mytime, mythid )
199            CALL TIMER_STOP ('PROFILES_INLOOP    [THE_MAIN_LOOP]', mythid)
200  #endif  #endif
        CALL TIMER_START('BULKF_FORCING      [FORWARD_STEP]',mythid)  
 C-    load all forcing fields at current time  
        CALL BULKF_FIELDS_LOAD( myTime, myIter, myThid )  
 C-    calculate qnet and empmr (and wind stress)  
        CALL BULKF_FORCING( myTime, myIter, myThid )  
        CALL TIMER_STOP ('BULKF_FORCING      [FORWARD_STEP]',mythid)  
       ELSE  
 #endif /* ALLOW_BULK_FORCE */  
201    
202  # ifdef ALLOW_EXF  C--   Call driver to load external forcing fields from file
 #  ifdef ALLOW_DEBUG  
       IF ( debugLevel .GE. debLevB )  
      &    CALL DEBUG_CALL('EXF_GETFORCING',myThid)  
 #  endif  
       CALL TIMER_START('EXF_GETFORCING     [FORWARD_STEP]',mythid)  
       CALL EXF_GETFORCING( mytime, myiter, mythid )  
       CALL TIMER_STOP ('EXF_GETFORCING     [FORWARD_STEP]',mythid)  
 # else /* ALLOW_EXF undef */  
 cph The following IF-statement creates an additional dependency  
 cph for the forcing fields requiring additional storing.  
 cph Therefore, the IF-statement will be put between CPP-OPTIONS,  
 cph assuming that ALLOW_SEAICE has not yet been differentiated.  
 #  if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM))  
       IF ( .NOT. useSEAICE .AND. .NOT. useEBM ) THEN  
 #  endif  
203  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
204         IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
205       &    CALL DEBUG_CALL('EXTERNAL_FIELDS_LOAD',myThid)       & CALL DEBUG_CALL('LOAD_FIELDS_DRIVER',myThid)
206  #endif  #endif
207         CALL TIMER_START('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)  #ifdef ALLOW_AUTODIFF_TAMC
208         CALL EXTERNAL_FIELDS_LOAD( mytime, myiter, mythid )  cph Important STORE that avoids hidden recomp. of load_fields_driver
209         CALL TIMER_STOP ('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)  CADJ STORE theta      = comlev1, key = ikey_dynamics
210  #  if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM))  # ifdef ALLOW_SALT_PLUME
211        ENDIF  CADJ STORE uvel, vvel = comlev1, key = ikey_dynamics
212  #  endif  # endif
213  # endif /* ALLOW_EXF */  #endif
214          CALL TIMER_START('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
215          CALL LOAD_FIELDS_DRIVER( myTime, myIter, myThid )
216          CALL TIMER_STOP ('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
217    
218    C--   Call Bulk-Formulae forcing package
219  #ifdef ALLOW_BULK_FORCE  #ifdef ALLOW_BULK_FORCE
220  C--   end of if/else block useBulfforce --        IF ( useBulkForce ) THEN
221    #ifdef ALLOW_DEBUG
222            IF ( debugLevel .GE. debLevB )
223         &   CALL DEBUG_CALL('BULKF_FORCING',myThid)
224    #endif
225            CALL TIMER_START('BULKF_FORCING       [FORWARD_STEP]',myThid)
226    C-    calculate qnet and empmr (and wind stress)
227            CALL BULKF_FORCING( myTime, myIter, myThid )
228            CALL TIMER_STOP ('BULKF_FORCING       [FORWARD_STEP]',myThid)
229        ENDIF        ENDIF
230  #endif /* ALLOW_BULK_FORCE */  #endif /* ALLOW_BULK_FORCE */
231    
232  #ifdef ALLOW_AUTODIFF  C--   Call external chepaml forcing package
233  c--   Add control vector for forcing and parameter fields  #ifdef ALLOW_CHEAPAML
234        if ( myiter .EQ. nIter0 )        IF ( useCheapAML  ) THEN
235       &     CALL CTRL_MAP_FORCING (mythid)  #ifdef ALLOW_DEBUG
236  #endif         IF ( debugLevel .GE. debLevB )
237         &    CALL DEBUG_CALL('CHEAPAML_FIELDS_LOAD',myThid)
238  # ifdef ALLOW_SEAICE  #endif
239  C--   Call sea ice model to compute forcing/external data fields.  In         CALL TIMER_START('CHEAPAML      [FORWARD_STEP]',mythid)
240  C     addition to computing prognostic sea-ice variables and diagnosing the  C-    calculate qnet (and wind stress)
241  C     forcing/external data fields that drive the ocean model, SEAICE_MODEL         CALL CHEAPAML( myTime, myIter,myThid )
242  C     also sets theta to the freezing point under sea-ice.  The implied         CALL TIMER_STOP ('CHEAPAML      [FORWARD_STEP]',mythid)
 C     surface heat flux is then stored in variable surfaceTendencyTice,  
 C     which is needed by KPP package (kpp_calc.F and kpp_transport_t.F)  
 C     to diagnose surface buoyancy fluxes and for the non-local transport  
 C     term.  Because this call precedes model thermodynamics, temperature  
 C     under sea-ice may not be "exactly" at the freezing point by the time  
 C     theta is dumped or time-averaged.  
       IF ( useSEAICE ) THEN  
 #ifdef ALLOW_DEBUG  
          IF ( debugLevel .GE. debLevB )  
      &    CALL DEBUG_CALL('SEAICE_MODEL',myThid)  
 #endif  
          CALL TIMER_START('SEAICE_MODEL       [FORWARD_STEP]',myThid)  
          CALL SEAICE_MODEL( myTime, myIter, myThid )  
          CALL TIMER_STOP ('SEAICE_MODEL       [FORWARD_STEP]',myThid)  
243        ENDIF        ENDIF
244  # endif /* ALLOW_SEAICE */  #endif /*ALLOW_CHEAPAML */
245    
 #ifdef ALLOW_AUTODIFF_TAMC  
 # ifdef ALLOW_PTRACERS  
 cph this replaces _bibj storing of ptracer within thermodynamics  
 CADJ STORE ptracer  = comlev1, key = ikey_dynamics  
 # endif  
 #endif  
246    
247  #ifdef ALLOW_OFFLINE  #ifdef ALLOW_AUTODIFF
248          call OFFLINE_FIELDS_LOAD( myTime, myIter, myThid )  c--   Add control vector for forcing and parameter fields
249          IF ( myIter .EQ. nIter0 )
250         &     CALL CTRL_MAP_FORCING (myThid)
251  #endif  #endif
252    
253  #ifdef ALLOW_PTRACERS  #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))
254  # ifdef ALLOW_GCHEM        CALL DUMMY_IN_STEPPING( myTime, myIter, myThid )
          CALL GCHEM_FIELDS_LOAD( mytime, myiter, mythid )  
 # endif  
255  #endif  #endif
256    
257  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
258         IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN
259  C      Post coupling data that I export.  C      Post coupling data that I export.
260  C      Read in coupling data that I import.  C      Read in coupling data that I import.
261           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
262           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )
263           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )
264           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
265         ENDIF        ENDIF
266  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
267    
268  #ifdef ALLOW_EBM  #ifdef ALLOW_EBM
269          IF ( useEBM ) THEN        IF ( useEBM ) THEN
270  # ifdef ALLOW_DEBUG  # ifdef ALLOW_DEBUG
271           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
272       &    CALL DEBUG_CALL('EBM',myThid)       &    CALL DEBUG_CALL('EBM',myThid)
273  # endif  # endif
274           CALL TIMER_START('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_START('EBM                [FORWARD_STEP]',myThid)
275           CALL EBM_DRIVER ( myTime, myIter, myThid )           CALL EBM_DRIVER ( myTime, myIter, myThid )
276           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',myThid)
277          ENDIF        ENDIF
278  #endif  #endif /* ALLOW_EBM */
279    
280  C--     Step forward fields and calculate time tendency terms.  C--     Step forward fields and calculate time tendency terms.
281    
282  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
283         IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
284       &    CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)       & CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)
285  #endif  #endif
286         CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
287         CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )        CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )
288         CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
289    
290  #ifndef ALLOW_OFFLINE  #ifdef ALLOW_AUTODIFF_TAMC
291    CADJ STORE surfaceforcingtice    = comlev1, key = ikey_dynamics
292    # ifdef ALLOW_KPP
293    CADJ STORE uvel               = comlev1, key = ikey_dynamics
294    CADJ STORE vvel               = comlev1, key = ikey_dynamics
295    # endif
296    # ifdef EXACT_CONSERV
297    cphCADJ STORE empmr              = comlev1, key = ikey_dynamics
298    cphCADJ STORE pmepr              = comlev1, key = ikey_dynamics
299    # endif
300    # ifdef ALLOW_PTRACERS
301    CADJ STORE ptracer               = comlev1, key = ikey_dynamics
302    # endif
303    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
304    cph-test
305    CADJ STORE hFacC                 = comlev1, key = ikey_dynamics
306    #  ifndef DISABLE_RSTAR_CODE
307    CADJ STORE rstarexpc             = comlev1, key = ikey_dynamics
308    #  endif
309    # endif
310    #endif /* ALLOW_AUTODIFF_TAMC */
311    
312    #ifndef ALLOW_AUTODIFF_TAMC
313          IF ( .NOT. useOffLine ) THEN
314    #endif
315  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
316         IF ( debugLevel .GE. debLevB )         IF ( debugLevel .GE. debLevB )
317       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)
318  #endif  #endif
319         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
320         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )
321         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
322    #ifdef ALLOW_AUTODIFF_TAMC
323    CADJ STORE EmPmR    = comlev1, key = ikey_dynamics
324    # ifdef EXACT_CONSERV
325    CADJ STORE pmepr    = comlev1, key = ikey_dynamics
326    # endif
327    #else
328          ENDIF
329  #endif  #endif
330    
331    #ifdef ALLOW_AUTODIFF_TAMC
332    # ifdef NONLIN_FRSURF
333    cph-test
334    CADJ STORE hFac_surfC         = comlev1, key = ikey_dynamics
335    CADJ STORE hfac_surfs         = comlev1, key = ikey_dynamics
336    CADJ STORE hfac_surfw         = comlev1, key = ikey_dynamics
337    # endif
338    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
339    CADJ STORE hFacC, hFacS, hFacW
340    CADJ &     = comlev1, key = ikey_dynamics
341    CADJ STORE recip_hFacC, recip_hFacS, recip_hFacW
342    CADJ &     = comlev1, key = ikey_dynamics
343    c
344    CADJ STORE surfaceforcingu = comlev1, key = ikey_dynamics
345    CADJ STORE surfaceforcingv = comlev1, key = ikey_dynamics
346    # endif
347    #endif /* ALLOW_AUTODIFF_TAMC */
348    
349    #ifdef ALLOW_GCHEM
350    #ifdef ALLOW_AUTODIFF_TAMC
351    CADJ STORE ptracer  = comlev1, key = ikey_dynamics
352    CADJ STORE theta  = comlev1, key = ikey_dynamics
353    CADJ STORE salt  = comlev1, key = ikey_dynamics
354    #endif
355          IF ( useGCHEM ) THEN
356    #ifdef ALLOW_DEBUG
357            IF ( debugLevel .GE. debLevB )
358         &       CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid)
359    #endif
360            CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
361            CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid )
362            CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
363          ENDIF
364    #endif /* ALLOW_GCHEM */
365    
366    #ifdef ALLOW_AUTODIFF_TAMC
367    cph needed to be moved here from do_oceanic_physics
368    cph to be visible down the road
369    c
370    CADJ STORE rhoInSitu          = comlev1, key = ikey_dynamics
371    CADJ STORE surfaceForcingS    = comlev1, key = ikey_dynamics
372    CADJ STORE surfaceForcingT    = comlev1, key = ikey_dynamics
373    CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics
374    ctest(
375    CADJ STORE IVDConvCount       = comlev1, key = ikey_dynamics
376    ctest)
377    # ifdef ALLOW_PTRACERS
378    CADJ STORE surfaceForcingPTr  = comlev1, key = ikey_dynamics
379    # endif
380    c
381    # ifdef ALLOW_GMREDI
382    CADJ STORE Kwx                = comlev1, key = ikey_dynamics
383    CADJ STORE Kwy                = comlev1, key = ikey_dynamics
384    CADJ STORE Kwz                = comlev1, key = ikey_dynamics
385    #  ifdef GM_BOLUS_ADVEC
386    CADJ STORE GM_PsiX            = comlev1, key = ikey_dynamics
387    CADJ STORE GM_PsiY            = comlev1, key = ikey_dynamics
388    #  endif
389    # endif
390    c
391    # ifdef ALLOW_KPP
392    CADJ STORE KPPghat            = comlev1, key = ikey_dynamics
393    CADJ STORE KPPfrac            = comlev1, key = ikey_dynamics
394    CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics
395    CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics
396    # endif
397    c
398    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
399    CADJ STORE theta,salt,wvel          = comlev1, key = ikey_dynamics
400    CADJ STORE etaH               = comlev1, key = ikey_dynamics
401    #  ifdef ALLOW_CD_CODE
402    CADJ STORE etanm1             = comlev1, key = ikey_dynamics
403    #  endif
404    #  ifndef DISABLE_RSTAR_CODE
405    cph-test
406    CADJ STORE rstarexpc = comlev1, key = ikey_dynamics
407    #  endif
408    # endif
409    #endif /* ALLOW_AUTODIFF_TAMC */
410    
411        IF ( .NOT.staggerTimeStep ) THEN        IF ( .NOT.staggerTimeStep ) THEN
412  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
413          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
414       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)
415  #endif  #endif
416          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)  cph-adj-test(
417    CADJ STORE salt               = comlev1, key = ikey_dynamics
418    cph-adj-test)
419            CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
420          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
421          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
422  C--    if not staggerTimeStep: end  C--    if not staggerTimeStep: end
423        ENDIF        ENDIF
424    c #ifdef ALLOW_NONHYDROSTATIC
425          IF ( implicitIntGravWave ) THEN
426            CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
427            CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
428            CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
429          ENDIF
430    c #endif
431    
432  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
433         IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN
434  C      Post coupling data that I export.  C      Post coupling data that I export.
435  C      Read in coupling data that I import.  C      Read in coupling data that I import.
436           myItP1 = myIter + 1           myItP1 = myIter + 1
# Line 294  C      Read in coupling data that I impo Line 438  C      Read in coupling data that I impo
438           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )
439           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )
440           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
441  # ifndef ALLOW_AIM  # ifdef ALLOW_OCN_COMPON_INTERF
442          IF ( useRealFreshWaterFlux ) THEN          IF ( useRealFreshWaterFlux ) THEN
443           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )
444          ENDIF          ENDIF
445  # endif  # endif /* ALLOW_OCN_COMPON_INTERF */
446         ENDIF        ENDIF
447  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
448    
449    #ifdef ALLOW_AUTODIFF_TAMC
450    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
451    CADJ STORE hFacC          = comlev1, key = ikey_dynamics
452    CADJ STORE hFacS          = comlev1, key = ikey_dynamics
453    CADJ STORE hFacW          = comlev1, key = ikey_dynamics
454    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
455    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
456    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
457    CADJ STORE etaN           = comlev1, key = ikey_dynamics
458    c
459    #  ifndef DISABLE_RSTAR_CODE
460    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics
461    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics
462    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics
463    c
464    CADJ STORE h0facc,h0facs,h0facw  
465    CADJ &     = comlev1, key = ikey_dynamics
466    CADJ STORE rstardhcdt,rstardhsdt,rstardhwdt
467    CADJ &     = comlev1, key = ikey_dynamics
468    CADJ STORE rstarexpc,rstarexps,rstarexpw
469    CADJ &     = comlev1, key = ikey_dynamics
470    #  endif
471    # endif
472    #endif
473  C--   Step forward fields and calculate time tendency terms.  C--   Step forward fields and calculate time tendency terms.
 #ifndef ALLOW_OFFLINE  
474  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
475        IF ( momStepping ) THEN        IF ( momStepping ) THEN
476  #endif  #endif
477  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
478          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
479       &    CALL DEBUG_CALL('DYNAMICS',myThid)       &    CALL DEBUG_CALL('DYNAMICS',myThid)
480  #endif  #endif
481          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',myThid)
482          CALL DYNAMICS( myTime, myIter, myThid )          CALL DYNAMICS( myTime, myIter, myThid )
483          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',myThid)
484  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
485        ENDIF        ENDIF
486  #endif  #endif
 #endif  
487    
488  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_AUTODIFF_TAMC
489  C--   Step forward W field in N-H algorithm  # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
490        IF ( momStepping .AND. nonHydrostatic ) THEN  CADJ STORE gU, gV  = comlev1, key = ikey_dynamics
491  #ifdef ALLOW_DEBUG  # endif
           IF ( debugLevel .GE. debLevB )  
      &     CALL DEBUG_CALL('CALC_GW',myThid)  
 #endif  
          CALL TIMER_START('CALC_GW          [FORWARD_STEP]',myThid)  
          CALL CALC_GW(myThid)  
          CALL TIMER_STOP ('CALC_GW          [FORWARD_STEP]',myThid)  
       ENDIF  
492  #endif  #endif
493    
494  C--   Update time-counter  C--   Update time-counter
495        myIter = nIter0 + iLoop        myIter = nIter0 + iLoop
496        myTime = startTime + deltaTClock * float(iLoop)        myTime = startTime + deltaTClock * float(iLoop)
497    
498    #ifdef ALLOW_MNC
499    C     Update the default next iter for MNC
500          IF ( useMNC ) THEN
501             CALL MNC_CW_CITER_SETG( 1, 1, -1, myIter , myThid )
502    
503    C        TODO: Logic should be added here so that users can specify, on
504    C        a per-citer-group basis, when it is time to update the
505    C        "current" (and not just the "next") iteration
506    
507    C        TODO: the following is just a temporary band-aid (mostly, for
508    C        Baylor) until someone writes a routine that better handles time
509    C        boundaries such as weeks, months, years, etc.
510             IF ( mnc_filefreq .GT. 0 ) THEN
511               IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock))
512         &          THEN
513                 CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid )
514               ENDIF
515             ENDIF
516          ENDIF
517    #endif /* ALLOW_MNC */
518    
519  C--   Update geometric factors:  C--   Update geometric factors:
520  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
521  C-    update hfacC,W,S and recip_hFac according to etaH(n+1) :  C-    update hfacC,W,S and recip_hFac according to etaH(n+1) :
522        IF ( nonlinFreeSurf.GT.0) THEN        IF ( nonlinFreeSurf.GT.0) THEN
523         IF ( select_rStar.GT.0 ) THEN         IF ( select_rStar.GT.0 ) THEN
524          CALL TIMER_START('UPDATE_R_STAR      [FORWARD_STEP]',myThid)  # ifndef DISABLE_RSTAR_CODE
525    # ifdef ALLOW_AUTODIFF_TAMC
526    cph-test
527    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
528    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
529    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
530    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
531    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
532    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
533    c
534    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics
535    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics
536    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics
537    c
538    CADJ STORE h0facc,h0facs,h0facw  = comlev1, key = ikey_dynamics
539    # endif
540            CALL TIMER_START('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
541          CALL UPDATE_R_STAR( myTime, myIter, myThid )          CALL UPDATE_R_STAR( myTime, myIter, myThid )
542          CALL TIMER_STOP ('UPDATE_R_STAR      [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
543    # ifdef ALLOW_AUTODIFF_TAMC
544    cph-test
545    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
546    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
547    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
548    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
549    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
550    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
551    # endif
552    # endif /* DISABLE_RSTAR_CODE */
553         ELSE         ELSE
554          CALL TIMER_START('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)  #ifdef ALLOW_AUTODIFF_TAMC
555    CADJ STORE hFac_surfC, hFac_surfS, hFac_surfW
556    CADJ &     = comlev1, key = ikey_dynamics
557    #endif
558            CALL TIMER_START('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
559          CALL UPDATE_SURF_DR( myTime, myIter, myThid )          CALL UPDATE_SURF_DR( myTime, myIter, myThid )
560          CALL TIMER_STOP ('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
561         ENDIF         ENDIF
562        ENDIF        ENDIF
563    # ifdef ALLOW_AUTODIFF_TAMC
564    cph-test
565    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
566    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
567    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
568    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
569    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
570    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
571    # endif
572  C-    update also CG2D matrix (and preconditioner)  C-    update also CG2D matrix (and preconditioner)
573        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN
574          CALL TIMER_START('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_START('UPDATE_CG2D         [FORWARD_STEP]',myThid)
575          CALL UPDATE_CG2D( myTime, myIter, myThid )          CALL UPDATE_CG2D( myTime, myIter, myThid )
576          CALL TIMER_STOP ('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_CG2D         [FORWARD_STEP]',myThid)
577        ENDIF        ENDIF
578  #endif  #endif /* NONLIN_FRSURF */
579    
580  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE
581  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
582        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN
583          CALL TIMER_START('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_START('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
584          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
585  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
586  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
# Line 369  C      => Filtering of uVel,vVel is nece Line 588  C      => Filtering of uVel,vVel is nece
588       &                             myTime, myIter, myThid )       &                             myTime, myIter, myThid )
589          ENDIF          ENDIF
590          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)
591          CALL TIMER_STOP ('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
592        ENDIF        ENDIF
593  #endif  #endif
594  #ifdef ALLOW_ZONAL_FILT  #ifdef ALLOW_ZONAL_FILT
595        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN
596          CALL TIMER_START('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_START('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
597          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
598  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
599  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
600            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )
601          ENDIF          ENDIF
602          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )
603          CALL TIMER_STOP ('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
604        ENDIF        ENDIF
605  #endif    #endif
606    
607  C--   Solve elliptic equation(s).  C--   Solve elliptic equation(s).
608  C     Two-dimensional only for conventional hydrostatic or  C     Two-dimensional only for conventional hydrostatic or
609  C     three-dimensional for non-hydrostatic and/or IGW scheme.  C     three-dimensional for non-hydrostatic and/or IGW scheme.
 #ifndef ALLOW_OFFLINE  
610        IF ( momStepping ) THEN        IF ( momStepping ) THEN
611    #ifdef ALLOW_AUTODIFF_TAMC
612    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
613    CADJ STORE uvel, vvel
614    CADJ &     = comlev1, key = ikey_dynamics
615    CADJ STORE empmr,hfacs,hfacw
616    CADJ &     = comlev1, key = ikey_dynamics
617    # endif
618    #endif
619          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
620          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)
621          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
622        ENDIF        ENDIF
 #endif  
623    
624  C--   Correct divergence in flow field and cycle time-stepping momentum  C--   Correct divergence in flow field and cycle time-stepping momentum
625  c     IF ( momStepping ) THEN  #ifndef ALLOW_AUTODIFF_TAMC
626  #ifndef ALLOW_OFFLINE        IF ( momStepping ) THEN
627          CALL TIMER_START('UV_CORRECTION_STEP  [FORWARD_STEP]',myThid)  #endif
628    #ifdef ALLOW_AUTODIFF_TAMC
629    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
630    #  ifndef DISABLE_RSTAR_CODE
631    cph-test
632    cph not clear, why this one
633    CADJ STORE h0facc = comlev1, key = ikey_dynamics
634    #  endif
635    # endif
636    # ifdef ALLOW_DEPTH_CONTROL
637    CADJ STORE etan, uvel,vvel
638    CADJ &     = comlev1, key = ikey_dynamics
639    # endif
640    #endif
641            CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
642          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)
643          CALL TIMER_STOP ('UV_CORRECTION_STEP  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
644    #ifndef ALLOW_AUTODIFF_TAMC
645          ENDIF
646  #endif  #endif
 c     ENDIF  
647    
648  #ifdef EXACT_CONSERV  #ifdef EXACT_CONSERV
649        IF (exactConserv) THEN        IF (exactConserv) THEN
650  C--   Update etaH(n+1) :  C--   Update etaH(n+1) :
651          CALL TIMER_START('UPDATE_ETAH        [FORWARD_STEP]',mythid)          CALL TIMER_START('UPDATE_ETAH         [FORWARD_STEP]',myThid)
652          CALL UPDATE_ETAH( myTime, myIter, myThid )          CALL UPDATE_ETAH( myTime, myIter, myThid )
653          CALL TIMER_STOP ('UPDATE_ETAH        [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('UPDATE_ETAH         [FORWARD_STEP]',myThid)
654        ENDIF        ENDIF
655  #endif /* EXACT_CONSERV */  #endif /* EXACT_CONSERV */
656    
657  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
658        IF ( select_rStar.NE.0 ) THEN        IF ( select_rStar.NE.0 ) THEN
659  C--   r* : compute the future level thickness according to etaH(n+1)  # ifndef DISABLE_RSTAR_CODE
660          CALL TIMER_START('CALC_R_STAR       [FORWARD_STEP]',mythid)  #  ifdef ALLOW_AUTODIFF_TAMC
661    cph-test
662    CADJ STORE rstarfacc,rstarfacs,rstarfacw = comlev1, key = ikey_dynamics
663    #  endif
664    C--   r* : compute the future level thickness according to etaH(n+1)
665            CALL TIMER_START('CALC_R_STAR         [FORWARD_STEP]',myThid)
666          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )
667          CALL TIMER_STOP ('CALC_R_STAR       [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_R_STAR         [FORWARD_STEP]',myThid)
668    # endif /* DISABLE_RSTAR_CODE */
669        ELSEIF ( nonlinFreeSurf.GT.0) THEN        ELSEIF ( nonlinFreeSurf.GT.0) THEN
670  C--   compute the future surface level thickness according to etaH(n+1)  C--   compute the future surface level thickness according to etaH(n+1)
671          CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',mythid)  # ifdef ALLOW_AUTODIFF_TAMC
672    CADJ STORE etaH          = comlev1, key = ikey_dynamics
673    # endif
674            CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',myThid)
675          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )
676          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',myThid)
677        ENDIF        ENDIF
678    # ifdef ALLOW_AUTODIFF_TAMC
679    CADJ STORE hFac_surfC       = comlev1, key = ikey_dynamics
680    CADJ STORE salt,theta,vvel  = comlev1, key = ikey_dynamics
681    # endif
682  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
683    
684  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
# Line 433  C---+----1----+----2----+----3----+----4 Line 686  C---+----1----+----2----+----3----+----4
686  C--   do exchanges of U,V (needed for multiDim) when using stagger time-step :  C--   do exchanges of U,V (needed for multiDim) when using stagger time-step :
687  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
688          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
689       &    CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)       &   CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)
690  #endif  #endif
691          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
692          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
693          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
694    
695    #ifdef ALLOW_DIAGNOSTICS
696    C--   State-variables diagnostics
697            IF ( useDiagnostics ) THEN
698              CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
699              CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid )
700              CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
701            ENDIF
702    #endif
703    
704  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
705          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
706       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &   CALL DEBUG_CALL('THERMODYNAMICS',myThid)
707  #endif  #endif
708          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
709          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
710          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
711    
712  C--    if staggerTimeStep: end  C--    if staggerTimeStep: end
713        ENDIF        ENDIF
714  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+--------+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
715    
716  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
717  cph This is needed because convective_adjustment calls  cph This is needed because convective_adjustment calls
# Line 457  cph find_rho which may use pressure() Line 719  cph find_rho which may use pressure()
719  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics
720  #endif  #endif
721  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)
722          CALL TIMER_START('TS_CORRECTION_STEP  [FORWARD_STEP]',myThid)        CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
723          CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)        CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)
724          CALL TIMER_STOP ('TS_CORRECTION_STEP  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
725    
726    #ifdef ALLOW_GCHEM
727    C     Add separate timestepping of chemical/biological/forcing
728    C     of ptracers here in GCHEM_FORCING_SEP
729    #ifdef ALLOW_AUTODIFF_TAMC
730    CADJ STORE ptracer  = comlev1, key = ikey_dynamics
731    CADJ STORE theta  = comlev1, key = ikey_dynamics
732    CADJ STORE salt  = comlev1, key = ikey_dynamics
733    #endif
734          IF ( useGCHEM ) THEN
735    #ifdef ALLOW_DEBUG
736             IF ( debugLevel .GE. debLevB )
737         &    CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid)
738    #endif /* ALLOW_DEBUG */
739             CALL TIMER_START('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
740             CALL GCHEM_FORCING_SEP( myTime,myIter,myThid )
741             CALL TIMER_STOP ('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
742          ENDIF
743    #endif /* ALLOW_GCHEM */
744    
745  C--   Do "blocking" sends and receives for tendency "overlap" terms  C--   Do "blocking" sends and receives for tendency "overlap" terms
746  c     CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)  c     CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
# Line 471  C--   Do "blocking" sends and receives f Line 752  C--   Do "blocking" sends and receives f
752        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )
753        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
754    
755  cswdptr -- add for seperate timestepping of chemical/biological/forcing  #ifdef ALLOW_DIAGNOSTICS
756  cswdptr    of ptracers ---        IF ( useDiagnostics ) THEN
757  #ifdef ALLOW_GCHEM         CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
758  ceh3 This is broken -- this ifdef should not be visible!         CALL DO_STATEVARS_DIAGS( myTime, 2, myIter, myThid )
759  #ifdef PTRACERS_SEPARATE_FORCING         CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
760  ceh3 needs an IF ( use GCHEM ) THEN        ENDIF
761          call GCHEM_FORCING_SEP( myTime,myIter,myThid )  #endif
 #endif /* PTRACERS_SEPARATE_FORCING */  
 #endif /* ALLOW_GCHEM */  
 cswdptr -- end add ---  
762    
 C AMM  
763  #ifdef ALLOW_GRIDALT  #ifdef ALLOW_GRIDALT
764          if (useGRIDALT) then        IF (useGRIDALT) THEN
765           CALL GRIDALT_UPDATE(myThid)           CALL GRIDALT_UPDATE(myThid)
766          endif        ENDIF
767  #endif  #endif
 C AMM  
768    
 C AMM  
769  #ifdef ALLOW_FIZHI  #ifdef ALLOW_FIZHI
770          if( useFIZHI) then        IF (useFIZHI) THEN
771           CALL TIMER_START('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_START('FIZHI               [FORWARD_STEP]',myThid)
772           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid )           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid, dTtracerLev(1) )
773           CALL TIMER_STOP('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('FIZHI               [FORWARD_STEP]',myThid)
774          endif        ENDIF
775  #endif  #endif
 C AMM  
776    
777  #ifdef ALLOW_FLT  #ifdef ALLOW_FLT
778  C--   Calculate float trajectories  C--   Calculate float trajectories
# Line 509  C--   Calculate float trajectories Line 783  C--   Calculate float trajectories
783        ENDIF        ENDIF
784  #endif  #endif
785    
786  C--   State-variables statistics (time-aver, diagnostics ...)  #ifdef ALLOW_TIMEAVE
787        CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)  C--   State-variables time-averaging
788        CALL DO_STATEVARS_DIAGS( myTime, myIter, myThid )        CALL TIMER_START('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
789        CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)        CALL DO_STATEVARS_TAVE( myTime, myIter, myThid )
790          CALL TIMER_STOP ('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
791    #endif
792    
 #ifndef ALLOW_OFFLINE  
793  #ifdef ALLOW_MONITOR  #ifdef ALLOW_MONITOR
794          IF ( .NOT.useOffLine ) THEN
795  C--   Check status of solution (statistics, cfl, etc...)  C--   Check status of solution (statistics, cfl, etc...)
796        CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)
797        CALL MONITOR( myIter, myTime, myThid )          CALL MONITOR( myIter, myTime, myThid )
798        CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)
799          ENDIF
800  #endif /* ALLOW_MONITOR */  #endif /* ALLOW_MONITOR */
 #endif  
801    
802  #ifdef ALLOW_COST  #ifdef ALLOW_COST
803  C--     compare model with data and compute cost function  C--     compare model with data and compute cost function
804  C--     this is done after exchanges to allow interpolation  C--     this is done after exchanges to allow interpolation
 ceh3 perhaps needs an IF ( useCOST ) THEN  
 CADJ STORE theta, uvel, vvel = comlev1, key = ikey_dynamics  
805        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)
806        CALL COST_TILE  ( mytime, myiter, myThid )        CALL COST_TILE  ( myTime, myIter, myThid )
807        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)
808  #endif  #endif
809    
810  C--   Do IO if needed.  C--   Do IO if needed.
 #ifdef ALLOW_OFFLINE  
       CALL TIMER_START('OFFLINE_MODEL_IO    [FORWARD_STEP]',myThid)  
       CALL OFFLINE_MODEL_IO( myTime, myIter, myThid )  
       CALL TIMER_STOP ('OFFLINE_MODEL_IO    [FORWARD_STEP]',myThid)  
 #else  
811        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
812        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )
813        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
814  #endif  
815          modelEnd = myTime.EQ.endTime .OR. myIter.EQ.nEndIter
816    #ifdef HAVE_SIGREG
817          IF ( useSIGREG ) THEN
818            modelEnd = modelEnd .OR. ( i_got_signal.GT.0 )
819          ENDIF
820    #endif /* HAVE_SIGREG */
821    
822  C--   Save state for restarts  C--   Save state for restarts
823        CALL TIMER_START('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
824        CALL PACKAGES_WRITE_PICKUP(        CALL DO_WRITE_PICKUP(
825       I               .FALSE., myTime, myIter, myThid )       I                      modelEnd, myTime, myIter, myThid )
826  #ifndef ALLOW_OFFLINE        CALL TIMER_STOP ('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
827        CALL WRITE_CHECKPOINT(  
828       I               .FALSE., myTime, myIter, myThid )    #ifdef HAVE_SIGREG
829          IF ( useSIGREG ) THEN
830            IF ( modelEnd .AND. i_got_signal.GT.0 ) THEN
831              STOP 'Checkpoint completed -- killed by signal handler'
832            ENDIF
833          ENDIF
834    #endif /* HAVE_SIGREG */
835    
836    #ifdef ALLOW_AUTODIFF_TAMC
837          CALL AUTODIFF_INADMODE_SET( myThid )
838    #endif
839    
840    #ifdef ALLOW_SHOWFLOPS
841          CALL TIMER_START('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
842          CALL SHOWFLOPS_INLOOP( iloop, mythid )
843          CALL TIMER_STOP ('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
844  #endif  #endif
       CALL TIMER_STOP ('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)  
845    
846  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
847        IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
848       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)
849  #endif  #endif
850    
Legend:
Removed from v.1.103  
changed lines
  Added in v.1.162
  ViewVC Help
Powered by ViewVC 1.1.22