/[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.65 by edhill, Thu Oct 23 04:41:40 2003 UTC revision 1.165 by heimbach, Fri Feb 13 21:56:48 2009 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
 #include "AD_CONFIG.h"  
4  #include "PACKAGES_CONFIG.h"  #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7  cswdptr -- add --  #ifdef ALLOW_GMREDI
8  #ifdef ALLOW_GCHEM  # include "GMREDI_OPTIONS.h"
9  # include "GCHEM_OPTIONS.h"  #endif
10    #ifdef ALLOW_OBCS
11    # include "OBCS_OPTIONS.h"
12    #endif
13    #ifdef ALLOW_SEAICE
14    # include "SEAICE_OPTIONS.h"
15  #endif  #endif
 cswdptr -- end add ---  
16    
17  CBOP  CBOP
18  C     !ROUTINE: FORWARD_STEP  C     !ROUTINE: FORWARD_STEP
# Line 25  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 39  C     == Global variables == Line 42  C     == Global variables ==
42  #include "EEPARAMS.h"  #include "EEPARAMS.h"
43  #include "PARAMS.h"  #include "PARAMS.h"
44  #include "DYNVARS.h"  #include "DYNVARS.h"
 #include "FFIELDS.h"  
45    
46  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_MNC
47  #include "CG3D.h"  #include "MNC_PARAMS.h"
48    #endif
49    
50    #ifdef HAVE_SIGREG
51    #include "SIGREG.h"
52  #endif  #endif
53    
54  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
55  #include "SHAP_FILT.h"  # include "SHAP_FILT.h"
56  #endif  #endif
57  #ifdef ALLOW_ZONAL_FILT  #ifdef ALLOW_ZONAL_FILT
58  #include "ZONAL_FILT.h"  # include "ZONAL_FILT.h"
59    #endif
60    #ifdef COMPONENT_MODULE
61    # include "CPL_PARAMS.h"
62  #endif  #endif
63    
64  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
65    # include "FFIELDS.h"
66    # include "SURFACE.h"
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  # ifdef INCLUDE_EXTERNAL_FORCING_PACKAGE  # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
74  #  include "exf_fields.h"  #  include "GRID.h"
75    # endif
76    # ifdef ALLOW_EXF
77    #  include "EXF_FIELDS.h"
78  #  ifdef ALLOW_BULKFORMULAE  #  ifdef ALLOW_BULKFORMULAE
79  #   include "exf_constants.h"  #   include "EXF_CONSTANTS.h"
80  #  endif  #  endif
81  # endif  # endif
82    # ifdef ALLOW_PTRACERS
83    #  include "PTRACERS_SIZE.h"
84    #  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  # ifdef ALLOW_OBCS
98  #  include "OBCS.h"  #  include "OBCS.h"
99    #  ifdef ALLOW_PTRACERS
100    #   include "OBCS_PTRACERS.h"
101    #  endif
102  # endif  # endif
103  # ifdef ALLOW_PTRACERS  # ifdef ALLOW_CD_CODE
104  #  include "PTRACERS.h"  #  include "CD_CODE_VARS.h"
105    # 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
116    #  include "EBM.h"
117    # endif
118    # ifdef ALLOW_KPP
119    #  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
146        integer mythid        _RL     myTime
147        integer myiter        INTEGER myIter
148        _RL     mytime        INTEGER myThid
 #ifdef ALLOW_BULK_FORCE  
       INTEGER bi,bj  
 #endif  
149    
150    C     !LOCAL VARIABLES:
151    C     == Local variables ==
152    C     modelEnd  :: true if reaching the end of the run
153          LOGICAL modelEnd
154    #ifdef COMPONENT_MODULE
155          INTEGER myItP1
156    #endif
157  CEOP  CEOP
158    
159  #ifndef DISABLE_DEBUGMODE  #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    
 #ifdef EXACT_CONSERV  
       IF (exactConserv) THEN  
 C--   Update etaH(n+1) :  
          CALL TIMER_START('UPDATE_ETAH        [FORWARD_STEP]',mythid)  
          CALL UPDATE_ETAH( myTime, myIter, myThid )  
          CALL TIMER_STOP ('UPDATE_ETAH        [FORWARD_STEP]',mythid)  
       ENDIF  
 #endif /* EXACT_CONSERV */  
   
 #ifdef NONLIN_FRSURF  
       IF ( select_rStar.NE.0 ) THEN  
 C--   r* : compute the future level thickness according to etaH(n+1)  
           CALL TIMER_START('CALC_R_STAR       [FORWARD_STEP]',mythid)  
           CALL CALC_R_STAR(etaH, myTime, myIter, myThid )  
           CALL TIMER_STOP ('CALC_R_STAR       [FORWARD_STEP]',mythid)  
       ELSEIF ( nonlinFreeSurf.GT.0) THEN  
 C--   compute the future surface level thickness according to etaH(n+1)  
           CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',mythid)  
           CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )  
           CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',mythid)  
       ENDIF  
 #endif /* NONLIN_FRSURF */  
   
 C--   Load forcing/external data fields.  
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--   Switch on/off diagnostics for snap-shot output:
182    #ifdef ALLOW_DIAGNOSTICS
183          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  C--   Call external forcing package  #ifdef ALLOW_PROFILES
193  #ifdef ALLOW_BULK_FORCE  #ifdef ALLOW_DEBUG
194        IF ( useBulkforce ) THEN        IF (debugMode) CALL DEBUG_CALL('',myThid)
195  #ifndef DISABLE_DEBUGMODE  #endif
196         IF ( debugLevel .GE. debLevB )  c--     Accumulate in-situ time averages of theta, salt, and SSH.
197       &    CALL DEBUG_CALL('BULKF_FIELDS_LOAD',myThid)          CALL TIMER_START('PROFILES_INLOOP    [THE_MAIN_LOOP]', mythid)
198  #endif          CALL PROFILES_INLOOP( mytime, mythid )
199         CALL TIMER_START('BULKF_FIELDS_LOAD[THE_MAIN_LOOP]',mythid)          CALL TIMER_STOP ('PROFILES_INLOOP    [THE_MAIN_LOOP]', mythid)
200         CALL BULKF_FIELDS_LOAD( mytime, myiter, mythid )  #endif
201         CALL TIMER_STOP ('BULKF_FIELDS_LOAD[THE_MAIN_LOOP]',mythid)  
202  c calculate qnet and empmr (and wind stress)  C--   Call driver to load external forcing fields from file
203         DO bj=myByLo(myThid),myByHi(myThid)  #ifdef ALLOW_DEBUG
204           DO bi=myBxLo(myThid),myBxHi(myThid)        IF ( debugLevel .GE. debLevB )
205            CALL BULKF_FORCING( bi,bj, mytime, myiter, mythid )       & CALL DEBUG_CALL('LOAD_FIELDS_DRIVER',myThid)
206           ENDDO  #endif
207         ENDDO  #ifdef ALLOW_AUTODIFF_TAMC
208  c     Update the tile edges.  cph Important STORE that avoids hidden recomp. of load_fields_driver
209         _EXCH_XY_R8(Qnet,   mythid)  CADJ STORE theta      = comlev1, key = ikey_dynamics,
210         _EXCH_XY_R8(EmPmR,   mythid)  CADJ &     kind = isbyte
211         CALL EXCH_UV_XY_RS(fu, fv, .TRUE., myThid)  CADJ STORE uvel, vvel = comlev1, key = ikey_dynamics,
212  C       _EXCH_XY_R8(fu     , mythid)  CADJ &     kind = isbyte
213  C       _EXCH_XY_R8(fv     , mythid)  #endif
214        ELSE        CALL TIMER_START('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
215  #endif /* ALLOW_BULK_FORCE */        CALL LOAD_FIELDS_DRIVER( myTime, myIter, myThid )
216          CALL TIMER_STOP ('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
217    
218  # ifdef ALLOW_EXF  C--   Call Bulk-Formulae forcing package
 C     NOTE, that although the exf package is part of the  
 C     distribution, it is not currently maintained, i.e.  
 C     exf is disabled by default in genmake.  
 #ifndef DISABLE_DEBUGMODE  
       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.  
 #  ifdef ALLOW_SEAICE  
       IF ( .NOT. useSEAICE ) THEN  
 #  endif  
 #ifndef DISABLE_DEBUGMODE  
        IF ( debugLevel .GE. debLevB )  
      &    CALL DEBUG_CALL('EXTERNAL_FIELDS_LOAD',myThid)  
 #endif  
        CALL TIMER_START('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)  
        CALL EXTERNAL_FIELDS_LOAD( mytime, myiter, mythid )  
        CALL TIMER_STOP ('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)  
 #  ifdef ALLOW_SEAICE  
       ENDIF  
 #  endif  
 # endif /* ALLOW_EXF */  
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  #if (defined (ALLOW_ADJOINT_RUN) || defined (ALLOW_TANGENTLINEAR_RUN))  C--   Call external chepaml forcing package
233    #ifdef ALLOW_CHEAPAML
234          IF ( useCheapAML  ) THEN
235    #ifdef ALLOW_DEBUG
236           IF ( debugLevel .GE. debLevB )
237         &    CALL DEBUG_CALL('CHEAPAML_FIELDS_LOAD',myThid)
238    #endif
239           CALL TIMER_START('CHEAPAML      [FORWARD_STEP]',mythid)
240    C-    calculate qnet (and wind stress)
241           CALL CHEAPAML( myTime, myIter,myThid )
242           CALL TIMER_STOP ('CHEAPAML      [FORWARD_STEP]',mythid)
243          ENDIF
244    #endif /*ALLOW_CHEAPAML */
245    
246    
247    #ifdef ALLOW_AUTODIFF
248  c--   Add control vector for forcing and parameter fields  c--   Add control vector for forcing and parameter fields
249        if ( myiter .EQ. nIter0 )        IF ( myIter .EQ. nIter0 )
250       &     CALL CTRL_MAP_FORCING (mythid)       &     CALL CTRL_MAP_FORCING (myThid)
251  #endif  #endif
252    
253  # ifdef ALLOW_SEAICE  #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))
254  C--   Call sea ice model to compute forcing/external data fields.  In        CALL DUMMY_IN_STEPPING( myTime, myIter, myThid )
255  C     addition to computing prognostic sea-ice variables and diagnosing the  #endif
256  C     forcing/external data fields that drive the ocean model, SEAICE_MODEL  
257  C     also sets theta to the freezing point under sea-ice.  The implied  #ifdef COMPONENT_MODULE
258  C     surface heat flux is then stored in variable surfaceTendencyTice,        IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN
259  C     which is needed by KPP package (kpp_calc.F and kpp_transport_t.F)  C      Post coupling data that I export.
260  C     to diagnose surface buoyancy fluxes and for the non-local transport  C      Read in coupling data that I import.
261  C     term.  Because this call precedes model thermodynamics, temperature           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
262  C     under sea-ice may not be "exactly" at the freezing point by the time           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )
263  C     theta is dumped or time-averaged.           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )
264        IF ( useSEAICE ) THEN           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
265  #ifndef DISABLE_DEBUGMODE        ENDIF
266           IF ( debugLevel .GE. debLevB )  #endif /* COMPONENT_MODULE */
267       &    CALL DEBUG_CALL('SEAICE_MODEL',myThid)  
268  #endif  #ifdef ALLOW_EBM
269           CALL TIMER_START('SEAICE_MODEL       [FORWARD_STEP]',myThid)        IF ( useEBM ) THEN
270           CALL SEAICE_MODEL( myTime, myIter, myThid )  # ifdef ALLOW_DEBUG
271           CALL TIMER_STOP ('SEAICE_MODEL       [FORWARD_STEP]',myThid)           IF ( debugLevel .GE. debLevB )
272         &    CALL DEBUG_CALL('EBM',myThid)
273    # endif
274             CALL TIMER_START('EBM                [FORWARD_STEP]',myThid)
275             CALL EBM_DRIVER ( myTime, myIter, myThid )
276             CALL TIMER_STOP ('EBM                [FORWARD_STEP]',myThid)
277        ENDIF        ENDIF
278  # endif /* ALLOW_SEAICE */  #endif /* ALLOW_EBM */
279    
280    C--     Step forward fields and calculate time tendency terms.
281    
282    #ifdef ALLOW_DEBUG
283          IF ( debugLevel .GE. debLevB )
284         & CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)
285    #endif
286          CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
287          CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )
288          CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
289    
290  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
291    CADJ STORE surfaceforcingtice    = comlev1, key = ikey_dynamics,
292    CADJ &     kind = isbyte
293    # ifdef ALLOW_KPP
294    CADJ STORE uvel               = comlev1, key = ikey_dynamics,
295    CADJ &     kind = isbyte
296    CADJ STORE vvel               = comlev1, key = ikey_dynamics,
297    CADJ &     kind = isbyte
298    # endif
299    # ifdef EXACT_CONSERV
300    cphCADJ STORE empmr              = comlev1, key = ikey_dynamics
301    cphCADJ STORE pmepr              = comlev1, key = ikey_dynamics
302    # endif
303  # ifdef ALLOW_PTRACERS  # ifdef ALLOW_PTRACERS
304  cph this replaces _bibj storing of ptracer within thermodynamics  CADJ STORE ptracer               = comlev1, key = ikey_dynamics,
305  CADJ STORE ptracer  = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
306  # endif  # endif
307  #endif  # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
308    cph-test
309    CADJ STORE hFacC                 = comlev1, key = ikey_dynamics,
310    CADJ &     kind = isbyte
311    #  ifndef DISABLE_RSTAR_CODE
312    CADJ STORE rstarexpc             = comlev1, key = ikey_dynamics,
313    CADJ &     kind = isbyte
314    #  endif
315    # endif
316    #endif /* ALLOW_AUTODIFF_TAMC */
317    
318  #ifdef ALLOW_PTRACERS  #ifndef ALLOW_AUTODIFF_TAMC
319  # ifdef ALLOW_GCHEM        IF ( .NOT. useOffLine ) THEN
320           CALL GCHEM_FIELDS_LOAD( mytime, myiter, mythid )  #endif
321    #ifdef ALLOW_DEBUG
322           IF ( debugLevel .GE. debLevB )
323         &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)
324    #endif
325           CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
326           CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )
327           CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
328    #ifdef ALLOW_AUTODIFF_TAMC
329    CADJ STORE EmPmR    = comlev1, key = ikey_dynamics,
330    CADJ &     kind = isbyte
331    # ifdef EXACT_CONSERV
332    CADJ STORE pmepr    = comlev1, key = ikey_dynamics,
333    CADJ &     kind = isbyte
334  # endif  # endif
335    #else
336          ENDIF
337  #endif  #endif
338    
339  C--     Step forward fields and calculate time tendency terms.  #ifdef ALLOW_AUTODIFF_TAMC
340  #ifndef DISABLE_DEBUGMODE  # ifdef NONLIN_FRSURF
341        IF ( debugLevel .GE. debLevB )  cph-test
342    CADJ STORE hFac_surfC         = comlev1, key = ikey_dynamics,
343    CADJ &     kind = isbyte
344    CADJ STORE hfac_surfs         = comlev1, key = ikey_dynamics,
345    CADJ &     kind = isbyte
346    CADJ STORE hfac_surfw         = comlev1, key = ikey_dynamics,
347    CADJ &     kind = isbyte
348    # endif
349    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
350    CADJ STORE hFacC, hFacS, hFacW
351    CADJ &     = comlev1, key = ikey_dynamics,
352    CADJ &     kind = isbyte
353    CADJ STORE recip_hFacC, recip_hFacS, recip_hFacW
354    CADJ &     = comlev1, key = ikey_dynamics,
355    CADJ &     kind = isbyte
356    c
357    CADJ STORE surfaceforcingu = comlev1, key = ikey_dynamics,
358    CADJ &     kind = isbyte
359    CADJ STORE surfaceforcingv = comlev1, key = ikey_dynamics,
360    CADJ &     kind = isbyte
361    # endif
362    #endif /* ALLOW_AUTODIFF_TAMC */
363    
364    #ifdef ALLOW_GCHEM
365    #ifdef ALLOW_AUTODIFF_TAMC
366    CADJ STORE ptracer  = comlev1, key = ikey_dynamics,
367    CADJ &     kind = isbyte
368    CADJ STORE theta  = comlev1, key = ikey_dynamics,
369    CADJ &     kind = isbyte
370    CADJ STORE salt  = comlev1, key = ikey_dynamics,
371    CADJ &     kind = isbyte
372    #endif
373          IF ( useGCHEM ) THEN
374    #ifdef ALLOW_DEBUG
375            IF ( debugLevel .GE. debLevB )
376         &       CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid)
377    #endif
378            CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
379            CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid )
380            CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
381          ENDIF
382    #endif /* ALLOW_GCHEM */
383    
384    #ifdef ALLOW_AUTODIFF_TAMC
385    cph needed to be moved here from do_oceanic_physics
386    cph to be visible down the road
387    c
388    CADJ STORE rhoInSitu          = comlev1, key = ikey_dynamics,
389    CADJ &     kind = isbyte
390    CADJ STORE surfaceForcingS    = comlev1, key = ikey_dynamics,
391    CADJ &     kind = isbyte
392    CADJ STORE surfaceForcingT    = comlev1, key = ikey_dynamics,
393    CADJ &     kind = isbyte
394    CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics,
395    CADJ &     kind = isbyte
396    CADJ STORE IVDConvCount       = comlev1, key = ikey_dynamics,
397    CADJ &     kind = isbyte
398    # ifdef ALLOW_PTRACERS
399    CADJ STORE surfaceForcingPTr  = comlev1, key = ikey_dynamics,
400    CADJ &     kind = isbyte
401    # endif
402    c
403    # ifdef ALLOW_GMREDI
404    CADJ STORE Kwx                = comlev1, key = ikey_dynamics,
405    CADJ &     kind = isbyte
406    CADJ STORE Kwy                = comlev1, key = ikey_dynamics,
407    CADJ &     kind = isbyte
408    CADJ STORE Kwz                = comlev1, key = ikey_dynamics,
409    CADJ &     kind = isbyte
410    #  ifdef GM_BOLUS_ADVEC
411    CADJ STORE GM_PsiX            = comlev1, key = ikey_dynamics,
412    CADJ &     kind = isbyte
413    CADJ STORE GM_PsiY            = comlev1, key = ikey_dynamics,
414    CADJ &     kind = isbyte
415    #  endif
416    # endif
417    c
418    # ifdef ALLOW_KPP
419    CADJ STORE KPPghat            = comlev1, key = ikey_dynamics,
420    CADJ &     kind = isbyte
421    CADJ STORE KPPfrac            = comlev1, key = ikey_dynamics,
422    CADJ &     kind = isbyte
423    CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics,
424    CADJ &     kind = isbyte
425    CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics,
426    CADJ &     kind = isbyte
427    # endif
428    c
429    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
430    CADJ STORE theta,salt,wvel          = comlev1, key = ikey_dynamics,
431    CADJ &     kind = isbyte
432    CADJ STORE etaH               = comlev1, key = ikey_dynamics,
433    CADJ &     kind = isbyte
434    #  ifdef ALLOW_CD_CODE
435    CADJ STORE etanm1             = comlev1, key = ikey_dynamics,
436    CADJ &     kind = isbyte
437    #  endif
438    #  ifndef DISABLE_RSTAR_CODE
439    cph-test
440    CADJ STORE rstarexpc = comlev1, key = ikey_dynamics,
441    CADJ &     kind = isbyte
442    #  endif
443    # endif
444    #endif /* ALLOW_AUTODIFF_TAMC */
445    
446          IF ( .NOT.staggerTimeStep ) THEN
447    #ifdef ALLOW_DEBUG
448            IF ( debugLevel .GE. debLevB )
449       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)
450  #endif  #endif
451          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)  CADJ STORE salt               = comlev1, key = ikey_dynamics,
452    CADJ &     kind = isbyte
453            CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
454          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
455          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
456    C--    if not staggerTimeStep: end
457  C--   do exchanges (needed for DYNAMICS) when using stagger time-step :        ENDIF
458  #ifndef DISABLE_DEBUGMODE  c #ifdef ALLOW_NONHYDROSTATIC
459        IF ( debugLevel .GE. debLevB )        IF ( implicitIntGravWave ) THEN
      &    CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)  
 #endif  
460          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
461          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
462          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
   
 #ifdef ALLOW_SHAP_FILT  
       IF (useSHAP_FILT .AND.  
      &     staggerTimeStep .AND. shap_filt_TrStagg ) THEN  
 #ifndef DISABLE_DEBUGMODE  
         IF ( debugLevel .GE. debLevB )  
      &    CALL DEBUG_CALL('SHAP_FILT_APPLY_TS',myThid)  
 #endif  
         CALL TIMER_START('SHAP_FILT           [FORWARD_STEP]',myThid)  
         CALL SHAP_FILT_APPLY_TS(gT,gS,myTime+deltaT,myIter+1,myThid)  
         CALL TIMER_STOP ('SHAP_FILT           [FORWARD_STEP]',myThid)  
463        ENDIF        ENDIF
464  #endif  c #endif
465  #ifdef ALLOW_ZONAL_FILT  
466        IF (useZONAL_FILT .AND.  #ifdef COMPONENT_MODULE
467       &     staggerTimeStep .AND. zonal_filt_TrStagg ) THEN        IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN
468  #ifndef DISABLE_DEBUGMODE  C      Post coupling data that I export.
469          IF ( debugLevel .GE. debLevB )  C      Read in coupling data that I import.
470       &    CALL DEBUG_CALL('ZONAL_FILT_APPLY_TS',myThid)           myItP1 = myIter + 1
471  #endif           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
472          CALL TIMER_START('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )
473          CALL ZONAL_FILT_APPLY_TS( gT, gS, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )
474          CALL TIMER_STOP ('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
475    # ifdef ALLOW_OCN_COMPON_INTERF
476            IF ( useRealFreshWaterFlux ) THEN
477             CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )
478            ENDIF
479    # endif /* ALLOW_OCN_COMPON_INTERF */
480        ENDIF        ENDIF
481  #endif    #endif /* COMPONENT_MODULE */
482    
483    #ifdef ALLOW_AUTODIFF_TAMC
484    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
485    CADJ STORE hFacC          = comlev1, key = ikey_dynamics,
486    CADJ &     kind = isbyte
487    CADJ STORE hFacS          = comlev1, key = ikey_dynamics,
488    CADJ &     kind = isbyte
489    CADJ STORE hFacW          = comlev1, key = ikey_dynamics,
490    CADJ &     kind = isbyte
491    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
492    CADJ &     kind = isbyte
493    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
494    CADJ &     kind = isbyte
495    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
496    CADJ &     kind = isbyte
497    CADJ STORE etaN           = comlev1, key = ikey_dynamics,
498    CADJ &     kind = isbyte
499    c
500    #  ifndef DISABLE_RSTAR_CODE
501    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics,
502    CADJ &     kind = isbyte
503    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics,
504    CADJ &     kind = isbyte
505    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics,
506    CADJ &     kind = isbyte
507    c
508    CADJ STORE h0facc,h0facs,h0facw  
509    CADJ &     = comlev1, key = ikey_dynamics,
510    CADJ &     kind = isbyte
511    CADJ STORE rstardhcdt,rstardhsdt,rstardhwdt
512    CADJ &     = comlev1, key = ikey_dynamics,
513    CADJ &     kind = isbyte
514    CADJ STORE rstarexpc,rstarexps,rstarexpw
515    CADJ &     = comlev1, key = ikey_dynamics,
516    CADJ &     kind = isbyte
517    #  endif
518    # endif
519    #endif
520  C--   Step forward fields and calculate time tendency terms.  C--   Step forward fields and calculate time tendency terms.
521  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
522        IF ( momStepping ) THEN        IF ( momStepping ) THEN
523  #endif  #endif
524  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
525          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
526       &    CALL DEBUG_CALL('DYNAMICS',myThid)       &    CALL DEBUG_CALL('DYNAMICS',myThid)
527  #endif  #endif
528          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',myThid)
529          CALL DYNAMICS( myTime, myIter, myThid )          CALL DYNAMICS( myTime, myIter, myThid )
530          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',myThid)
531  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
532        ENDIF        ENDIF
533  #endif  #endif
534    
535  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_AUTODIFF_TAMC
536  C--   Step forward W field in N-H algorithm  # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
537        IF ( momStepping .AND. nonHydrostatic ) THEN  CADJ STORE gU, gV  = comlev1, key = ikey_dynamics,
538  #ifndef DISABLE_DEBUGMODE  CADJ &     kind = isbyte
539            IF ( debugLevel .GE. debLevB )  # endif
      &     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  
540  #endif  #endif
541    
542    C--   Update time-counter
543          myIter = nIter0 + iLoop
544          myTime = startTime + deltaTClock * float(iLoop)
545    
546    #ifdef ALLOW_MNC
547    C     Update the default next iter for MNC
548          IF ( useMNC ) THEN
549             CALL MNC_CW_CITER_SETG( 1, 1, -1, myIter , myThid )
550    
551    C        TODO: Logic should be added here so that users can specify, on
552    C        a per-citer-group basis, when it is time to update the
553    C        "current" (and not just the "next") iteration
554    
555    C        TODO: the following is just a temporary band-aid (mostly, for
556    C        Baylor) until someone writes a routine that better handles time
557    C        boundaries such as weeks, months, years, etc.
558             IF ( mnc_filefreq .GT. 0 ) THEN
559               IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock))
560         &          THEN
561                 CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid )
562               ENDIF
563             ENDIF
564          ENDIF
565    #endif /* ALLOW_MNC */
566    
567    C--   Update geometric factors:
568  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
569  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) :
570        IF ( nonlinFreeSurf.GT.0) THEN        IF ( nonlinFreeSurf.GT.0) THEN
571         IF ( select_rStar.GT.0 ) THEN         IF ( select_rStar.GT.0 ) THEN
572          CALL TIMER_START('UPDATE_R_STAR      [FORWARD_STEP]',myThid)  # ifndef DISABLE_RSTAR_CODE
573    # ifdef ALLOW_AUTODIFF_TAMC
574    CADJ STORE hFacC    = comlev1, key = ikey_dynamics,
575    CADJ &     kind = isbyte
576    CADJ STORE hFacS    = comlev1, key = ikey_dynamics,
577    CADJ &     kind = isbyte
578    CADJ STORE hFacW    = comlev1, key = ikey_dynamics,
579    CADJ &     kind = isbyte
580    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
581    CADJ &     kind = isbyte
582    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
583    CADJ &     kind = isbyte
584    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
585    CADJ &     kind = isbyte
586    c
587    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics,
588    CADJ &     kind = isbyte
589    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics,
590    CADJ &     kind = isbyte
591    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics,
592    CADJ &     kind = isbyte
593    c
594    CADJ STORE h0facc,h0facs,h0facw  = comlev1, key = ikey_dynamics,
595    CADJ &     kind = isbyte
596    # endif
597            CALL TIMER_START('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
598          CALL UPDATE_R_STAR( myTime, myIter, myThid )          CALL UPDATE_R_STAR( myTime, myIter, myThid )
599          CALL TIMER_STOP ('UPDATE_R_STAR      [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
600    # ifdef ALLOW_AUTODIFF_TAMC
601    CADJ STORE hFacC    = comlev1, key = ikey_dynamics,
602    CADJ &     kind = isbyte
603    CADJ STORE hFacS    = comlev1, key = ikey_dynamics,
604    CADJ &     kind = isbyte
605    CADJ STORE hFacW    = comlev1, key = ikey_dynamics,
606    CADJ &     kind = isbyte
607    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
608    CADJ &     kind = isbyte
609    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
610    CADJ &     kind = isbyte
611    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
612    CADJ &     kind = isbyte
613    # endif
614    # endif /* DISABLE_RSTAR_CODE */
615         ELSE         ELSE
616          CALL TIMER_START('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)  #ifdef ALLOW_AUTODIFF_TAMC
617    CADJ STORE hFac_surfC, hFac_surfS, hFac_surfW
618    CADJ &     = comlev1, key = ikey_dynamics,
619    CADJ &     kind = isbyte
620    #endif
621            CALL TIMER_START('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
622          CALL UPDATE_SURF_DR( myTime, myIter, myThid )          CALL UPDATE_SURF_DR( myTime, myIter, myThid )
623          CALL TIMER_STOP ('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
624         ENDIF         ENDIF
625        ENDIF        ENDIF
626    # ifdef ALLOW_AUTODIFF_TAMC
627    CADJ STORE hFacC    = comlev1, key = ikey_dynamics,
628    CADJ &     kind = isbyte
629    CADJ STORE hFacS    = comlev1, key = ikey_dynamics,
630    CADJ &     kind = isbyte
631    CADJ STORE hFacW    = comlev1, key = ikey_dynamics,
632    CADJ &     kind = isbyte
633    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
634    CADJ &     kind = isbyte
635    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
636    CADJ &     kind = isbyte
637    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
638    CADJ &     kind = isbyte
639    # endif
640  C-    update also CG2D matrix (and preconditioner)  C-    update also CG2D matrix (and preconditioner)
641        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN
642          CALL TIMER_START('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_START('UPDATE_CG2D         [FORWARD_STEP]',myThid)
643          CALL UPDATE_CG2D( myTime, myIter, myThid )          CALL UPDATE_CG2D( myTime, myIter, myThid )
644          CALL TIMER_STOP ('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_CG2D         [FORWARD_STEP]',myThid)
645        ENDIF        ENDIF
646  #endif  #endif /* NONLIN_FRSURF */
647    
648  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE
649  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
650        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN
651          CALL TIMER_START('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_START('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
652          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
653  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
654  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
655            CALL SHAP_FILT_APPLY_UV( uVel,vVel,            CALL SHAP_FILT_APPLY_UV( uVel,vVel,
656       &                             myTime+deltaT, myIter+1, myThid )       &                             myTime, myIter, myThid )
657          ENDIF          ENDIF
658          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime+deltaT,myIter+1,myThid)          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)
659          CALL TIMER_STOP ('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
660        ENDIF        ENDIF
661  #endif  #endif
662  #ifdef ALLOW_ZONAL_FILT  #ifdef ALLOW_ZONAL_FILT
663        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN
664          CALL TIMER_START('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_START('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
665          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
666  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
667  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
668            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )
669          ENDIF          ENDIF
670          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )
671          CALL TIMER_STOP ('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
672        ENDIF        ENDIF
673  #endif    #endif
674    
675  C--   Solve elliptic equation(s).  C--   Solve elliptic equation(s).
676  C     Two-dimensional only for conventional hydrostatic or  C     Two-dimensional only for conventional hydrostatic or
677  C     three-dimensional for non-hydrostatic and/or IGW scheme.  C     three-dimensional for non-hydrostatic and/or IGW scheme.
678        IF ( momStepping ) THEN        IF ( momStepping ) THEN
679        CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)  #ifdef ALLOW_AUTODIFF_TAMC
680        CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)  # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
681        CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)  CADJ STORE uvel, vvel
682    CADJ &     = comlev1, key = ikey_dynamics,
683    CADJ &     kind = isbyte
684    CADJ STORE empmr,hfacs,hfacw
685    CADJ &     = comlev1, key = ikey_dynamics,
686    CADJ &     kind = isbyte
687    # endif
688    #endif
689            CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
690            CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)
691            CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
692        ENDIF        ENDIF
693    
694    C--   Correct divergence in flow field and cycle time-stepping momentum
695    #ifndef ALLOW_AUTODIFF_TAMC
696          IF ( momStepping ) THEN
697    #endif
698    #ifdef ALLOW_AUTODIFF_TAMC
699    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
700    #  ifndef DISABLE_RSTAR_CODE
701    cph-test
702    cph not clear, why this one
703    CADJ STORE h0facc = comlev1, key = ikey_dynamics,
704    CADJ &     kind = isbyte
705    #  endif
706    # endif
707    # ifdef ALLOW_DEPTH_CONTROL
708    CADJ STORE etan, uvel,vvel
709    CADJ &     = comlev1, key = ikey_dynamics
710    # endif
711    #endif
712            CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
713            CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)
714            CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
715    #ifndef ALLOW_AUTODIFF_TAMC
716          ENDIF
717    #endif
718    
719    #ifdef EXACT_CONSERV
720          IF (exactConserv) THEN
721    C--   Update etaH(n+1) :
722            CALL TIMER_START('UPDATE_ETAH         [FORWARD_STEP]',myThid)
723            CALL UPDATE_ETAH( myTime, myIter, myThid )
724            CALL TIMER_STOP ('UPDATE_ETAH         [FORWARD_STEP]',myThid)
725          ENDIF
726    #endif /* EXACT_CONSERV */
727    
728    #ifdef NONLIN_FRSURF
729          IF ( select_rStar.NE.0 ) THEN
730    # ifndef DISABLE_RSTAR_CODE
731    #  ifdef ALLOW_AUTODIFF_TAMC
732    cph-test
733    CADJ STORE rstarfacc,rstarfacs,rstarfacw = comlev1, key = ikey_dynamics,
734    CADJ &     kind = isbyte
735    #  endif
736    C--   r* : compute the future level thickness according to etaH(n+1)
737            CALL TIMER_START('CALC_R_STAR         [FORWARD_STEP]',myThid)
738            CALL CALC_R_STAR(etaH, myTime, myIter, myThid )
739            CALL TIMER_STOP ('CALC_R_STAR         [FORWARD_STEP]',myThid)
740    # endif /* DISABLE_RSTAR_CODE */
741          ELSEIF ( nonlinFreeSurf.GT.0) THEN
742    C--   compute the future surface level thickness according to etaH(n+1)
743    # ifdef ALLOW_AUTODIFF_TAMC
744    CADJ STORE etaH          = comlev1, key = ikey_dynamics,
745    CADJ &     kind = isbyte
746    # endif
747            CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',myThid)
748            CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )
749            CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',myThid)
750          ENDIF
751    # ifdef ALLOW_AUTODIFF_TAMC
752    CADJ STORE hFac_surfC       = comlev1, key = ikey_dynamics,
753    CADJ &     kind = isbyte
754    CADJ STORE salt,theta,vvel  = comlev1, key = ikey_dynamics,
755    CADJ &     kind = isbyte
756    # endif
757    #endif /* NONLIN_FRSURF */
758    
759    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
760          IF ( staggerTimeStep ) THEN
761    C--   do exchanges of U,V (needed for multiDim) when using stagger time-step :
762    #ifdef ALLOW_DEBUG
763            IF ( debugLevel .GE. debLevB )
764         &   CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)
765    #endif
766            CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
767            CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
768            CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
769    
770    #ifdef ALLOW_DIAGNOSTICS
771    C--   State-variables diagnostics
772            IF ( useDiagnostics ) THEN
773              CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
774              CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid )
775              CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
776            ENDIF
777    #endif
778    
779    #ifdef ALLOW_DEBUG
780            IF ( debugLevel .GE. debLevB )
781         &   CALL DEBUG_CALL('THERMODYNAMICS',myThid)
782    #endif
783            CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
784            CALL THERMODYNAMICS( myTime, myIter, myThid )
785            CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
786    
787    C--    if staggerTimeStep: end
788          ENDIF
789    C---+--------+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
790    
791  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
792  cph This is needed because convective_adjustment calls  cph This is needed because convective_adjustment calls
793  cph find_rho which may use pressure()  cph find_rho which may use pressure()
794  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics,
795    CADJ &     kind = isbyte
796  #endif  #endif
797  C--   Correct divergence in flow field and cycle time-stepping  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)
798  C     arrays (for all fields) ; update time-counter        CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
799        myIter = nIter0 + iLoop        CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)
800        myTime = startTime + deltaTClock * float(iLoop)        CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
801        CALL TIMER_START('THE_CORRECTION_STEP [FORWARD_STEP]',myThid)  
802        CALL THE_CORRECTION_STEP(myTime, myIter, myThid)  #ifdef ALLOW_GCHEM
803        CALL TIMER_STOP ('THE_CORRECTION_STEP [FORWARD_STEP]',myThid)  C     Add separate timestepping of chemical/biological/forcing
804    C     of ptracers here in GCHEM_FORCING_SEP
805    #ifdef ALLOW_AUTODIFF_TAMC
806    CADJ STORE ptracer  = comlev1, key = ikey_dynamics,
807    CADJ &     kind = isbyte
808    CADJ STORE theta  = comlev1, key = ikey_dynamics,
809    CADJ &     kind = isbyte
810    CADJ STORE salt  = comlev1, key = ikey_dynamics,
811    CADJ &     kind = isbyte
812    #endif
813          IF ( useGCHEM ) THEN
814    #ifdef ALLOW_DEBUG
815             IF ( debugLevel .GE. debLevB )
816         &    CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid)
817    #endif /* ALLOW_DEBUG */
818             CALL TIMER_START('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
819             CALL GCHEM_FORCING_SEP( myTime,myIter,myThid )
820             CALL TIMER_STOP ('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
821          ENDIF
822    #endif /* ALLOW_GCHEM */
823    
824  C--   Do "blocking" sends and receives for tendency "overlap" terms  C--   Do "blocking" sends and receives for tendency "overlap" terms
825  c     CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)  c     CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
# Line 400  C--   Do "blocking" sends and receives f Line 831  C--   Do "blocking" sends and receives f
831        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )
832        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
833    
834  cswdptr -- add for seperate timestepping of chemical/biological/forcing  #ifdef ALLOW_DIAGNOSTICS
835  cswdptr    of ptracers ---        IF ( useDiagnostics ) THEN
836  #ifdef ALLOW_GCHEM         CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
837  ceh3 This is broken -- this ifdef should not be visible!         CALL DO_STATEVARS_DIAGS( myTime, 2, myIter, myThid )
838  #ifdef PTRACERS_SEPARATE_FORCING         CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
839  ceh3 needs an IF ( use GCHEM ) THEN        ENDIF
840          call GCHEM_FORCING_SEP( myTime,myIter,myThid )  #endif
841  #endif /* PTRACERS_SEPARATE_FORCING */  
842  #endif /* ALLOW_GCHEM */  #ifdef ALLOW_GRIDALT
843  cswdptr -- end add ---        IF (useGRIDALT) THEN
844             CALL GRIDALT_UPDATE(myThid)
845          ENDIF
846    #endif
847    
848    #ifdef ALLOW_FIZHI
849          IF (useFIZHI) THEN
850             CALL TIMER_START('FIZHI               [FORWARD_STEP]',myThid)
851             CALL STEP_FIZHI_CORR ( myTime, myIter, myThid, dTtracerLev(1) )
852             CALL TIMER_STOP ('FIZHI               [FORWARD_STEP]',myThid)
853          ENDIF
854    #endif
855    
856  #ifdef ALLOW_FLT  #ifdef ALLOW_FLT
857  C--   Calculate float trajectories  C--   Calculate float trajectories
858        IF (useFLT) THEN        IF (useFLT) THEN
859          CALL TIMER_START('FLOATS            [FORWARD_STEP]',myThid)          CALL TIMER_START('FLOATS            [FORWARD_STEP]',myThid)
860          CALL FLT_MAIN(myIter,myTime, myThid)          CALL FLT_MAIN( myTime, myIter, myThid )
861          CALL TIMER_STOP ('FLOATS            [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('FLOATS            [FORWARD_STEP]',myThid)
862        ENDIF        ENDIF
863  #endif  #endif
864    
865  #ifndef EXCLUDE_MONITOR  #ifdef ALLOW_TIMEAVE
866    C--   State-variables time-averaging
867          CALL TIMER_START('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
868          CALL DO_STATEVARS_TAVE( myTime, myIter, myThid )
869          CALL TIMER_STOP ('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
870    #endif
871    
872    #ifdef ALLOW_MONITOR
873          IF ( .NOT.useOffLine ) THEN
874  C--   Check status of solution (statistics, cfl, etc...)  C--   Check status of solution (statistics, cfl, etc...)
875        CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)
876        CALL MONITOR( myIter, myTime, myThid )          CALL MONITOR( myIter, myTime, myThid )
877        CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)
878  #endif /* EXCLUDE_MONITOR */        ENDIF
879    #endif /* ALLOW_MONITOR */
880    
881    #ifdef ALLOW_COST
882    C--     compare model with data and compute cost function
883    C--     this is done after exchanges to allow interpolation
884          CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)
885          CALL COST_TILE  ( myTime, myIter, myThid )
886          CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)
887    #endif
888    
889  C--   Do IO if needed.  C--   Do IO if needed.
890        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
891        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )
892        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
893    
894          modelEnd = myTime.EQ.endTime .OR. myIter.EQ.nEndIter
895    #ifdef HAVE_SIGREG
896          IF ( useSIGREG ) THEN
897            modelEnd = modelEnd .OR. ( i_got_signal.GT.0 )
898          ENDIF
899    #endif /* HAVE_SIGREG */
900    
901  C--   Save state for restarts  C--   Save state for restarts
902  C     Note:    (jmc: is it still the case after ckp35 ?)        CALL TIMER_START('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
903  C     =====        CALL DO_WRITE_PICKUP(
904  C     Because of the ordering of the timestepping code and       I                      modelEnd, myTime, myIter, myThid )
905  C     tendency term code at end of loop model arrays hold        CALL TIMER_STOP ('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
906  C     U,V,T,S  at "time-level" N but gu, gv, gs, gt, guNM1,...  
907  C     at "time-level" N+1/2 (guNM1 at "time-level" N+1/2 is  #ifdef HAVE_SIGREG
908  C     gu at "time-level" N-1/2) and etaN at "time-level" N+1/2.        IF ( useSIGREG ) THEN
909  C      where N = I+timeLevBase-1          IF ( modelEnd .AND. i_got_signal.GT.0 ) THEN
910  C     Thus a checkpoint contains U.0000000000, GU.0000000001 and            STOP 'Checkpoint completed -- killed by signal handler'
911  C     etaN.0000000001 in the indexing scheme used for the model          ENDIF
912  C     "state" files. This example is referred to as a checkpoint        ENDIF
913  C     at time level 1  #endif /* HAVE_SIGREG */
914        CALL TIMER_START('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)  
915        CALL WRITE_CHECKPOINT(  #ifdef ALLOW_AUTODIFF_TAMC
916       &        .FALSE., myTime, myIter, myThid )        CALL AUTODIFF_INADMODE_SET( myThid )
917        CALL TIMER_STOP ('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)  #endif
918    
919    #ifdef ALLOW_SHOWFLOPS
920          CALL TIMER_START('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
921          CALL SHOWFLOPS_INLOOP( iloop, mythid )
922          CALL TIMER_STOP ('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
923    #endif
924    
925  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
926        IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
927       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)
928  #endif  #endif
929    
930          RETURN
931        END        END
Legend:
Removed from v.1.65  
changed lines
  Added in v.1.165
  ViewVC Help
Powered by ViewVC 1.1.22