/[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.105 by heimbach, Thu Nov 11 02:24:20 2004 UTC revision 1.164 by jmc, Sun Jan 4 01:00:19 2009 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    
 #ifdef ALLOW_GCHEM  
 # include "GCHEM_OPTIONS.h"  
 #endif  
 #ifdef ALLOW_OFFLINE  
 # include "OFFLINE_OPTIONS.h"  
 #endif  
7  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
8  # include "GMREDI_OPTIONS.h"  # include "GMREDI_OPTIONS.h"
9  #endif  #endif
10    #ifdef ALLOW_OBCS
11    # include "OBCS_OPTIONS.h"
12    #endif
13    #ifdef ALLOW_SEAICE
14    # include "SEAICE_OPTIONS.h"
15    #endif
16    
17  CBOP  CBOP
18  C     !ROUTINE: FORWARD_STEP  C     !ROUTINE: FORWARD_STEP
# Line 28  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 43  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 55  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
 # ifdef EXACT_CONSERV  
 #  include "SURFACE.h"  
 # endif  
118  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
119  #  include "KPP.h"  #  include "KPP.h"
120  # endif  # endif
121  # ifdef ALLOW_GMREDI  # ifdef ALLOW_GMREDI
122  #  include "GMREDI.h"  #  include "GMREDI.h"
123  # endif  # endif
124    # ifdef ALLOW_RBCS
125    #  include "RBCS.h"
126    # 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))  CADJ STORE uvel, vvel = comlev1, key = ikey_dynamics
211        ENDIF  #endif
212  #  endif        CALL TIMER_START('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
213  # endif /* ALLOW_EXF */        CALL LOAD_FIELDS_DRIVER( myTime, myIter, myThid )
214          CALL TIMER_STOP ('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
215    
216    C--   Call Bulk-Formulae forcing package
217  #ifdef ALLOW_BULK_FORCE  #ifdef ALLOW_BULK_FORCE
218  C--   end of if/else block useBulfforce --        IF ( useBulkForce ) THEN
219    #ifdef ALLOW_DEBUG
220            IF ( debugLevel .GE. debLevB )
221         &   CALL DEBUG_CALL('BULKF_FORCING',myThid)
222    #endif
223            CALL TIMER_START('BULKF_FORCING       [FORWARD_STEP]',myThid)
224    C-    calculate qnet and empmr (and wind stress)
225            CALL BULKF_FORCING( myTime, myIter, myThid )
226            CALL TIMER_STOP ('BULKF_FORCING       [FORWARD_STEP]',myThid)
227        ENDIF        ENDIF
228  #endif /* ALLOW_BULK_FORCE */  #endif /* ALLOW_BULK_FORCE */
229    
230  #ifdef ALLOW_AUTODIFF  C--   Call external chepaml forcing package
231  c--   Add control vector for forcing and parameter fields  #ifdef ALLOW_CHEAPAML
232        if ( myiter .EQ. nIter0 )        IF ( useCheapAML  ) THEN
233       &     CALL CTRL_MAP_FORCING (mythid)  #ifdef ALLOW_DEBUG
234  #endif         IF ( debugLevel .GE. debLevB )
235         &    CALL DEBUG_CALL('CHEAPAML_FIELDS_LOAD',myThid)
236  # ifdef ALLOW_SEAICE  #endif
237  C--   Call sea ice model to compute forcing/external data fields.  In         CALL TIMER_START('CHEAPAML      [FORWARD_STEP]',mythid)
238  C     addition to computing prognostic sea-ice variables and diagnosing the  C-    calculate qnet (and wind stress)
239  C     forcing/external data fields that drive the ocean model, SEAICE_MODEL         CALL CHEAPAML( myTime, myIter,myThid )
240  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)  
241        ENDIF        ENDIF
242  # endif /* ALLOW_SEAICE */  #endif /*ALLOW_CHEAPAML */
243    
 #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  
244    
245  #ifdef ALLOW_OFFLINE  #ifdef ALLOW_AUTODIFF
246          call OFFLINE_FIELDS_LOAD( myTime, myIter, myThid )  c--   Add control vector for forcing and parameter fields
247          IF ( myIter .EQ. nIter0 )
248         &     CALL CTRL_MAP_FORCING (myThid)
249  #endif  #endif
250    
251  #ifdef ALLOW_PTRACERS  #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))
252  # ifdef ALLOW_GCHEM        CALL DUMMY_IN_STEPPING( myTime, myIter, myThid )
          CALL GCHEM_FIELDS_LOAD( mytime, myiter, mythid )  
 # endif  
253  #endif  #endif
254    
255  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
256         IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN
257  C      Post coupling data that I export.  C      Post coupling data that I export.
258  C      Read in coupling data that I import.  C      Read in coupling data that I import.
259           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
260           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )
261           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )
262           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
263         ENDIF        ENDIF
264  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
265    
266  #ifdef ALLOW_EBM  #ifdef ALLOW_EBM
267          IF ( useEBM ) THEN        IF ( useEBM ) THEN
268  # ifdef ALLOW_DEBUG  # ifdef ALLOW_DEBUG
269           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
270       &    CALL DEBUG_CALL('EBM',myThid)       &    CALL DEBUG_CALL('EBM',myThid)
271  # endif  # endif
272           CALL TIMER_START('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_START('EBM                [FORWARD_STEP]',myThid)
273           CALL EBM_DRIVER ( myTime, myIter, myThid )           CALL EBM_DRIVER ( myTime, myIter, myThid )
274           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',myThid)
275          ENDIF        ENDIF
276  #endif  #endif /* ALLOW_EBM */
277    
278  C--     Step forward fields and calculate time tendency terms.  C--     Step forward fields and calculate time tendency terms.
279    
280  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
281         IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
282       &    CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)       & CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)
283  #endif  #endif
284         CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
285         CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )        CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )
286         CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
287    
288  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
289  CADJ STORE theta              = comlev1, key = ikey_dynamics  CADJ STORE surfaceforcingtice    = comlev1, key = ikey_dynamics
 CADJ STORE salt               = comlev1, key = ikey_dynamics  
 CADJ STORE totphihyd          = comlev1, key = ikey_dynamics  
 CADJ STORE surfaceforcingtice = comlev1, key = ikey_dynamics  
290  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
291  CADJ STORE uvel               = comlev1, key = ikey_dynamics  CADJ STORE uvel               = comlev1, key = ikey_dynamics
292  CADJ STORE vvel               = comlev1, key = ikey_dynamics  CADJ STORE vvel               = comlev1, key = ikey_dynamics
293  # endif  # endif
294  # ifdef EXACT_CONSERV  # ifdef EXACT_CONSERV
295  CADJ STORE empmr              = comlev1, key = ikey_dynamics  cphCADJ STORE empmr              = comlev1, key = ikey_dynamics
296  CADJ STORE pmepr              = comlev1, key = ikey_dynamics  cphCADJ STORE pmepr              = comlev1, key = ikey_dynamics
297    # endif
298    # ifdef ALLOW_PTRACERS
299    CADJ STORE ptracer               = comlev1, key = ikey_dynamics
300    # endif
301    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
302    cph-test
303    CADJ STORE hFacC                 = comlev1, key = ikey_dynamics
304    #  ifndef DISABLE_RSTAR_CODE
305    CADJ STORE rstarexpc             = comlev1, key = ikey_dynamics
306    #  endif
307  # endif  # endif
308  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
309    
310  #ifndef ALLOW_OFFLINE  #ifndef ALLOW_AUTODIFF_TAMC
311          IF ( .NOT. useOffLine ) THEN
312    #endif
313  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
314         IF ( debugLevel .GE. debLevB )         IF ( debugLevel .GE. debLevB )
315       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)
316  #endif  #endif
317         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
318         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )
319         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
320    #ifdef ALLOW_AUTODIFF_TAMC
321    CADJ STORE EmPmR    = comlev1, key = ikey_dynamics
322    # ifdef EXACT_CONSERV
323    CADJ STORE pmepr    = comlev1, key = ikey_dynamics
324    # endif
325    #else
326          ENDIF
327  #endif  #endif
328    
329  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
330    # ifdef NONLIN_FRSURF
331    cph-test
332    CADJ STORE hFac_surfC         = comlev1, key = ikey_dynamics
333    CADJ STORE hfac_surfs         = comlev1, key = ikey_dynamics
334    CADJ STORE hfac_surfw         = comlev1, key = ikey_dynamics
335    # endif
336    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
337    CADJ STORE hFacC, hFacS, hFacW
338    CADJ &     = comlev1, key = ikey_dynamics
339    CADJ STORE recip_hFacC, recip_hFacS, recip_hFacW
340    CADJ &     = comlev1, key = ikey_dynamics
341    c
342    CADJ STORE surfaceforcingu = comlev1, key = ikey_dynamics
343    CADJ STORE surfaceforcingv = comlev1, key = ikey_dynamics
344    # endif
345    #endif /* ALLOW_AUTODIFF_TAMC */
346    
347    #ifdef ALLOW_GCHEM
348    #ifdef ALLOW_AUTODIFF_TAMC
349    CADJ STORE ptracer  = comlev1, key = ikey_dynamics
350    CADJ STORE theta  = comlev1, key = ikey_dynamics
351    CADJ STORE salt  = comlev1, key = ikey_dynamics
352    #endif
353          IF ( useGCHEM ) THEN
354    #ifdef ALLOW_DEBUG
355            IF ( debugLevel .GE. debLevB )
356         &       CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid)
357    #endif
358            CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
359            CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid )
360            CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
361          ENDIF
362    #endif /* ALLOW_GCHEM */
363    
364    #ifdef ALLOW_AUTODIFF_TAMC
365  cph needed to be moved here from do_oceanic_physics  cph needed to be moved here from do_oceanic_physics
366  cph to be visible down the road  cph to be visible down the road
367  c  c
368    CADJ STORE rhoInSitu          = comlev1, key = ikey_dynamics
369  CADJ STORE surfaceForcingS    = comlev1, key = ikey_dynamics  CADJ STORE surfaceForcingS    = comlev1, key = ikey_dynamics
370  CADJ STORE surfaceForcingT    = comlev1, key = ikey_dynamics  CADJ STORE surfaceForcingT    = comlev1, key = ikey_dynamics
371  CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics  CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics
# Line 308  ctest( Line 373  ctest(
373  CADJ STORE IVDConvCount       = comlev1, key = ikey_dynamics  CADJ STORE IVDConvCount       = comlev1, key = ikey_dynamics
374  ctest)  ctest)
375  # ifdef ALLOW_PTRACERS  # ifdef ALLOW_PTRACERS
376  CADJ STORE surfaceForcingPtr  = comlev1, key = ikey_dynamics  CADJ STORE surfaceForcingPTr  = comlev1, key = ikey_dynamics
377  # endif  # endif
378  c  c
379  # ifdef ALLOW_GMREDI  # ifdef ALLOW_GMREDI
# Line 327  CADJ STORE KPPfrac            = comlev1, Line 392  CADJ STORE KPPfrac            = comlev1,
392  CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics  CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics
393  CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics  CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics
394  # endif  # endif
395    c
396    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
397    CADJ STORE theta,salt,wvel          = comlev1, key = ikey_dynamics
398    CADJ STORE etaH               = comlev1, key = ikey_dynamics
399    #  ifdef ALLOW_CD_CODE
400    CADJ STORE etanm1             = comlev1, key = ikey_dynamics
401    #  endif
402    #  ifndef DISABLE_RSTAR_CODE
403    cph-test
404    CADJ STORE rstarexpc = comlev1, key = ikey_dynamics
405    #  endif
406    # endif
407  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
408    
409        IF ( .NOT.staggerTimeStep ) THEN        IF ( .NOT.staggerTimeStep ) THEN
410  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
411          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
412       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)
413  #endif  #endif
414          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)  cph-adj-test(
415    CADJ STORE salt               = comlev1, key = ikey_dynamics
416    cph-adj-test)
417            CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
418          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
419          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
420  C--    if not staggerTimeStep: end  C--    if not staggerTimeStep: end
421        ENDIF        ENDIF
422    c #ifdef ALLOW_NONHYDROSTATIC
423          IF ( implicitIntGravWave ) THEN
424            CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
425            CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
426            CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
427          ENDIF
428    c #endif
429    
430  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
431         IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN
432  C      Post coupling data that I export.  C      Post coupling data that I export.
433  C      Read in coupling data that I import.  C      Read in coupling data that I import.
434           myItP1 = myIter + 1           myItP1 = myIter + 1
# Line 349  C      Read in coupling data that I impo Line 436  C      Read in coupling data that I impo
436           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )
437           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )
438           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
439  # ifndef ALLOW_AIM  # ifdef ALLOW_OCN_COMPON_INTERF
440          IF ( useRealFreshWaterFlux ) THEN          IF ( useRealFreshWaterFlux ) THEN
441           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )
442          ENDIF          ENDIF
443  # endif  # endif /* ALLOW_OCN_COMPON_INTERF */
444         ENDIF        ENDIF
445  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
446    
447    #ifdef ALLOW_AUTODIFF_TAMC
448    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
449    CADJ STORE hFacC          = comlev1, key = ikey_dynamics
450    CADJ STORE hFacS          = comlev1, key = ikey_dynamics
451    CADJ STORE hFacW          = comlev1, key = ikey_dynamics
452    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
453    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
454    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
455    CADJ STORE etaN           = comlev1, key = ikey_dynamics
456    c
457    #  ifndef DISABLE_RSTAR_CODE
458    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics
459    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics
460    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics
461    c
462    CADJ STORE h0facc,h0facs,h0facw  
463    CADJ &     = comlev1, key = ikey_dynamics
464    CADJ STORE rstardhcdt,rstardhsdt,rstardhwdt
465    CADJ &     = comlev1, key = ikey_dynamics
466    CADJ STORE rstarexpc,rstarexps,rstarexpw
467    CADJ &     = comlev1, key = ikey_dynamics
468    #  endif
469    # endif
470    #endif
471  C--   Step forward fields and calculate time tendency terms.  C--   Step forward fields and calculate time tendency terms.
 #ifndef ALLOW_OFFLINE  
472  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
473        IF ( momStepping ) THEN        IF ( momStepping ) THEN
474  #endif  #endif
475  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
476          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
477       &    CALL DEBUG_CALL('DYNAMICS',myThid)       &    CALL DEBUG_CALL('DYNAMICS',myThid)
478  #endif  #endif
479          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',myThid)
480          CALL DYNAMICS( myTime, myIter, myThid )          CALL DYNAMICS( myTime, myIter, myThid )
481          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',myThid)
482  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
483        ENDIF        ENDIF
484  #endif  #endif
 #endif  
485    
486  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_AUTODIFF_TAMC
487  C--   Step forward W field in N-H algorithm  # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
488        IF ( momStepping .AND. nonHydrostatic ) THEN  CADJ STORE gU, gV  = comlev1, key = ikey_dynamics
489  #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  
490  #endif  #endif
491    
492  C--   Update time-counter  C--   Update time-counter
493        myIter = nIter0 + iLoop        myIter = nIter0 + iLoop
494        myTime = startTime + deltaTClock * float(iLoop)        myTime = startTime + deltaTClock * float(iLoop)
495    
496    #ifdef ALLOW_MNC
497    C     Update the default next iter for MNC
498          IF ( useMNC ) THEN
499             CALL MNC_CW_CITER_SETG( 1, 1, -1, myIter , myThid )
500    
501    C        TODO: Logic should be added here so that users can specify, on
502    C        a per-citer-group basis, when it is time to update the
503    C        "current" (and not just the "next") iteration
504    
505    C        TODO: the following is just a temporary band-aid (mostly, for
506    C        Baylor) until someone writes a routine that better handles time
507    C        boundaries such as weeks, months, years, etc.
508             IF ( mnc_filefreq .GT. 0 ) THEN
509               IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock))
510         &          THEN
511                 CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid )
512               ENDIF
513             ENDIF
514          ENDIF
515    #endif /* ALLOW_MNC */
516    
517  C--   Update geometric factors:  C--   Update geometric factors:
518  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
519  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) :
520        IF ( nonlinFreeSurf.GT.0) THEN        IF ( nonlinFreeSurf.GT.0) THEN
521         IF ( select_rStar.GT.0 ) THEN         IF ( select_rStar.GT.0 ) THEN
522          CALL TIMER_START('UPDATE_R_STAR      [FORWARD_STEP]',myThid)  # ifndef DISABLE_RSTAR_CODE
523    # ifdef ALLOW_AUTODIFF_TAMC
524    cph-test
525    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
526    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
527    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
528    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
529    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
530    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
531    c
532    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics
533    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics
534    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics
535    c
536    CADJ STORE h0facc,h0facs,h0facw  = comlev1, key = ikey_dynamics
537    # endif
538            CALL TIMER_START('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
539          CALL UPDATE_R_STAR( myTime, myIter, myThid )          CALL UPDATE_R_STAR( myTime, myIter, myThid )
540          CALL TIMER_STOP ('UPDATE_R_STAR      [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
541    # ifdef ALLOW_AUTODIFF_TAMC
542    cph-test
543    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
544    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
545    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
546    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
547    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
548    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
549    # endif
550    # endif /* DISABLE_RSTAR_CODE */
551         ELSE         ELSE
552          CALL TIMER_START('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)  #ifdef ALLOW_AUTODIFF_TAMC
553    CADJ STORE hFac_surfC, hFac_surfS, hFac_surfW
554    CADJ &     = comlev1, key = ikey_dynamics
555    #endif
556            CALL TIMER_START('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
557          CALL UPDATE_SURF_DR( myTime, myIter, myThid )          CALL UPDATE_SURF_DR( myTime, myIter, myThid )
558          CALL TIMER_STOP ('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
559         ENDIF         ENDIF
560        ENDIF        ENDIF
561    # ifdef ALLOW_AUTODIFF_TAMC
562    cph-test
563    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
564    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
565    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
566    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
567    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
568    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
569    # endif
570  C-    update also CG2D matrix (and preconditioner)  C-    update also CG2D matrix (and preconditioner)
571        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN
572          CALL TIMER_START('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_START('UPDATE_CG2D         [FORWARD_STEP]',myThid)
573          CALL UPDATE_CG2D( myTime, myIter, myThid )          CALL UPDATE_CG2D( myTime, myIter, myThid )
574          CALL TIMER_STOP ('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_CG2D         [FORWARD_STEP]',myThid)
575        ENDIF        ENDIF
576  #endif  #endif /* NONLIN_FRSURF */
577    
578  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE
579  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
580        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN
581          CALL TIMER_START('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_START('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
582          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
583  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
584  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
# Line 424  C      => Filtering of uVel,vVel is nece Line 586  C      => Filtering of uVel,vVel is nece
586       &                             myTime, myIter, myThid )       &                             myTime, myIter, myThid )
587          ENDIF          ENDIF
588          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)
589          CALL TIMER_STOP ('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
590        ENDIF        ENDIF
591  #endif  #endif
592  #ifdef ALLOW_ZONAL_FILT  #ifdef ALLOW_ZONAL_FILT
593        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN
594          CALL TIMER_START('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_START('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
595          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
596  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
597  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
598            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )
599          ENDIF          ENDIF
600          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )
601          CALL TIMER_STOP ('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
602        ENDIF        ENDIF
603  #endif    #endif
604    
605  C--   Solve elliptic equation(s).  C--   Solve elliptic equation(s).
606  C     Two-dimensional only for conventional hydrostatic or  C     Two-dimensional only for conventional hydrostatic or
607  C     three-dimensional for non-hydrostatic and/or IGW scheme.  C     three-dimensional for non-hydrostatic and/or IGW scheme.
 #ifndef ALLOW_OFFLINE  
608        IF ( momStepping ) THEN        IF ( momStepping ) THEN
609    #ifdef ALLOW_AUTODIFF_TAMC
610    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
611    CADJ STORE uvel, vvel
612    CADJ &     = comlev1, key = ikey_dynamics
613    CADJ STORE empmr,hfacs,hfacw
614    CADJ &     = comlev1, key = ikey_dynamics
615    # endif
616    #endif
617          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
618          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)
619          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
620        ENDIF        ENDIF
 #endif  
621    
622  C--   Correct divergence in flow field and cycle time-stepping momentum  C--   Correct divergence in flow field and cycle time-stepping momentum
623  c     IF ( momStepping ) THEN  #ifndef ALLOW_AUTODIFF_TAMC
624  #ifndef ALLOW_OFFLINE        IF ( momStepping ) THEN
625          CALL TIMER_START('UV_CORRECTION_STEP  [FORWARD_STEP]',myThid)  #endif
626    #ifdef ALLOW_AUTODIFF_TAMC
627    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
628    #  ifndef DISABLE_RSTAR_CODE
629    cph-test
630    cph not clear, why this one
631    CADJ STORE h0facc = comlev1, key = ikey_dynamics
632    #  endif
633    # endif
634    # ifdef ALLOW_DEPTH_CONTROL
635    CADJ STORE etan, uvel,vvel
636    CADJ &     = comlev1, key = ikey_dynamics
637    # endif
638    #endif
639            CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
640          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)
641          CALL TIMER_STOP ('UV_CORRECTION_STEP  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
642    #ifndef ALLOW_AUTODIFF_TAMC
643          ENDIF
644  #endif  #endif
 c     ENDIF  
645    
646  #ifdef EXACT_CONSERV  #ifdef EXACT_CONSERV
647        IF (exactConserv) THEN        IF (exactConserv) THEN
648  C--   Update etaH(n+1) :  C--   Update etaH(n+1) :
649          CALL TIMER_START('UPDATE_ETAH        [FORWARD_STEP]',mythid)          CALL TIMER_START('UPDATE_ETAH         [FORWARD_STEP]',myThid)
650          CALL UPDATE_ETAH( myTime, myIter, myThid )          CALL UPDATE_ETAH( myTime, myIter, myThid )
651          CALL TIMER_STOP ('UPDATE_ETAH        [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('UPDATE_ETAH         [FORWARD_STEP]',myThid)
652        ENDIF        ENDIF
653  #endif /* EXACT_CONSERV */  #endif /* EXACT_CONSERV */
654    
655  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
656        IF ( select_rStar.NE.0 ) THEN        IF ( select_rStar.NE.0 ) THEN
657  C--   r* : compute the future level thickness according to etaH(n+1)  # ifndef DISABLE_RSTAR_CODE
658          CALL TIMER_START('CALC_R_STAR       [FORWARD_STEP]',mythid)  #  ifdef ALLOW_AUTODIFF_TAMC
659    cph-test
660    CADJ STORE rstarfacc,rstarfacs,rstarfacw = comlev1, key = ikey_dynamics
661    #  endif
662    C--   r* : compute the future level thickness according to etaH(n+1)
663            CALL TIMER_START('CALC_R_STAR         [FORWARD_STEP]',myThid)
664          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )
665          CALL TIMER_STOP ('CALC_R_STAR       [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_R_STAR         [FORWARD_STEP]',myThid)
666    # endif /* DISABLE_RSTAR_CODE */
667        ELSEIF ( nonlinFreeSurf.GT.0) THEN        ELSEIF ( nonlinFreeSurf.GT.0) THEN
668  C--   compute the future surface level thickness according to etaH(n+1)  C--   compute the future surface level thickness according to etaH(n+1)
669          CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',mythid)  # ifdef ALLOW_AUTODIFF_TAMC
670    CADJ STORE etaH          = comlev1, key = ikey_dynamics
671    # endif
672            CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',myThid)
673          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )
674          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',myThid)
675        ENDIF        ENDIF
676    # ifdef ALLOW_AUTODIFF_TAMC
677    CADJ STORE hFac_surfC       = comlev1, key = ikey_dynamics
678    CADJ STORE salt,theta,vvel  = comlev1, key = ikey_dynamics
679    # endif
680  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
681    
682  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
# Line 488  C---+----1----+----2----+----3----+----4 Line 684  C---+----1----+----2----+----3----+----4
684  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 :
685  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
686          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
687       &    CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)       &   CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)
688  #endif  #endif
689          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
690          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
691          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
692    
693    #ifdef ALLOW_DIAGNOSTICS
694    C--   State-variables diagnostics
695            IF ( useDiagnostics ) THEN
696              CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
697              CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid )
698              CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
699            ENDIF
700    #endif
701    
702  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
703          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
704       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &   CALL DEBUG_CALL('THERMODYNAMICS',myThid)
705  #endif  #endif
706          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
707          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
708          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
709    
710  C--    if staggerTimeStep: end  C--    if staggerTimeStep: end
711        ENDIF        ENDIF
712  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+--------+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
713    
714  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
715  cph This is needed because convective_adjustment calls  cph This is needed because convective_adjustment calls
# Line 512  cph find_rho which may use pressure() Line 717  cph find_rho which may use pressure()
717  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics
718  #endif  #endif
719  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)
720          CALL TIMER_START('TS_CORRECTION_STEP  [FORWARD_STEP]',myThid)        CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
721          CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)        CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)
722          CALL TIMER_STOP ('TS_CORRECTION_STEP  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
723    
724    #ifdef ALLOW_GCHEM
725    C     Add separate timestepping of chemical/biological/forcing
726    C     of ptracers here in GCHEM_FORCING_SEP
727    #ifdef ALLOW_AUTODIFF_TAMC
728    CADJ STORE ptracer  = comlev1, key = ikey_dynamics
729    CADJ STORE theta  = comlev1, key = ikey_dynamics
730    CADJ STORE salt  = comlev1, key = ikey_dynamics
731    #endif
732          IF ( useGCHEM ) THEN
733    #ifdef ALLOW_DEBUG
734             IF ( debugLevel .GE. debLevB )
735         &    CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid)
736    #endif /* ALLOW_DEBUG */
737             CALL TIMER_START('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
738             CALL GCHEM_FORCING_SEP( myTime,myIter,myThid )
739             CALL TIMER_STOP ('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
740          ENDIF
741    #endif /* ALLOW_GCHEM */
742    
743  C--   Do "blocking" sends and receives for tendency "overlap" terms  C--   Do "blocking" sends and receives for tendency "overlap" terms
744  c     CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)  c     CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
# Line 526  C--   Do "blocking" sends and receives f Line 750  C--   Do "blocking" sends and receives f
750        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )
751        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
752    
753  cswdptr -- add for seperate timestepping of chemical/biological/forcing  #ifdef ALLOW_DIAGNOSTICS
754  cswdptr    of ptracers ---        IF ( useDiagnostics ) THEN
755  #ifdef ALLOW_GCHEM         CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
756  ceh3 This is broken -- this ifdef should not be visible!         CALL DO_STATEVARS_DIAGS( myTime, 2, myIter, myThid )
757  #ifdef PTRACERS_SEPARATE_FORCING         CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
758  ceh3 needs an IF ( use GCHEM ) THEN        ENDIF
759          call GCHEM_FORCING_SEP( myTime,myIter,myThid )  #endif
 #endif /* PTRACERS_SEPARATE_FORCING */  
 #endif /* ALLOW_GCHEM */  
 cswdptr -- end add ---  
760    
 C AMM  
761  #ifdef ALLOW_GRIDALT  #ifdef ALLOW_GRIDALT
762          if (useGRIDALT) then        IF (useGRIDALT) THEN
763           CALL GRIDALT_UPDATE(myThid)           CALL GRIDALT_UPDATE(myThid)
764          endif        ENDIF
765  #endif  #endif
 C AMM  
766    
 C AMM  
767  #ifdef ALLOW_FIZHI  #ifdef ALLOW_FIZHI
768          if( useFIZHI) then        IF (useFIZHI) THEN
769           CALL TIMER_START('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_START('FIZHI               [FORWARD_STEP]',myThid)
770           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid )           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid, dTtracerLev(1) )
771           CALL TIMER_STOP('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('FIZHI               [FORWARD_STEP]',myThid)
772          endif        ENDIF
773  #endif  #endif
 C AMM  
774    
775  #ifdef ALLOW_FLT  #ifdef ALLOW_FLT
776  C--   Calculate float trajectories  C--   Calculate float trajectories
777        IF (useFLT) THEN        IF (useFLT) THEN
778          CALL TIMER_START('FLOATS            [FORWARD_STEP]',myThid)          CALL TIMER_START('FLOATS            [FORWARD_STEP]',myThid)
779          CALL FLT_MAIN(myIter,myTime, myThid)          CALL FLT_MAIN( myTime, myIter, myThid )
780          CALL TIMER_STOP ('FLOATS            [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('FLOATS            [FORWARD_STEP]',myThid)
781        ENDIF        ENDIF
782  #endif  #endif
783    
784  C--   State-variables statistics (time-aver, diagnostics ...)  #ifdef ALLOW_TIMEAVE
785        CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)  C--   State-variables time-averaging
786        CALL DO_STATEVARS_DIAGS( myTime, myIter, myThid )        CALL TIMER_START('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
787        CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)        CALL DO_STATEVARS_TAVE( myTime, myIter, myThid )
788          CALL TIMER_STOP ('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
789    #endif
790    
 #ifndef ALLOW_OFFLINE  
791  #ifdef ALLOW_MONITOR  #ifdef ALLOW_MONITOR
792          IF ( .NOT.useOffLine ) THEN
793  C--   Check status of solution (statistics, cfl, etc...)  C--   Check status of solution (statistics, cfl, etc...)
794        CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)
795        CALL MONITOR( myIter, myTime, myThid )          CALL MONITOR( myIter, myTime, myThid )
796        CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)
797          ENDIF
798  #endif /* ALLOW_MONITOR */  #endif /* ALLOW_MONITOR */
 #endif  
799    
800  #ifdef ALLOW_COST  #ifdef ALLOW_COST
801  C--     compare model with data and compute cost function  C--     compare model with data and compute cost function
802  C--     this is done after exchanges to allow interpolation  C--     this is done after exchanges to allow interpolation
803        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)
804        CALL COST_TILE  ( mytime, myiter, myThid )        CALL COST_TILE  ( myTime, myIter, myThid )
805        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)
806  #endif  #endif
807    
808  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  
809        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
810        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )
811        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
812  #endif  
813          modelEnd = myTime.EQ.endTime .OR. myIter.EQ.nEndIter
814    #ifdef HAVE_SIGREG
815          IF ( useSIGREG ) THEN
816            modelEnd = modelEnd .OR. ( i_got_signal.GT.0 )
817          ENDIF
818    #endif /* HAVE_SIGREG */
819    
820  C--   Save state for restarts  C--   Save state for restarts
821        CALL TIMER_START('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
822        CALL PACKAGES_WRITE_PICKUP(        CALL DO_WRITE_PICKUP(
823       I               .FALSE., myTime, myIter, myThid )       I                      modelEnd, myTime, myIter, myThid )
824  #ifndef ALLOW_OFFLINE        CALL TIMER_STOP ('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
825        CALL WRITE_CHECKPOINT(  
826       I               .FALSE., myTime, myIter, myThid )    #ifdef HAVE_SIGREG
827          IF ( useSIGREG ) THEN
828            IF ( modelEnd .AND. i_got_signal.GT.0 ) THEN
829              STOP 'Checkpoint completed -- killed by signal handler'
830            ENDIF
831          ENDIF
832    #endif /* HAVE_SIGREG */
833    
834    #ifdef ALLOW_AUTODIFF_TAMC
835          CALL AUTODIFF_INADMODE_SET( myThid )
836    #endif
837    
838    #ifdef ALLOW_SHOWFLOPS
839          CALL TIMER_START('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
840          CALL SHOWFLOPS_INLOOP( iloop, mythid )
841          CALL TIMER_STOP ('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
842  #endif  #endif
       CALL TIMER_STOP ('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)  
843    
844  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
845        IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
846       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)
847  #endif  #endif
848    
Legend:
Removed from v.1.105  
changed lines
  Added in v.1.164
  ViewVC Help
Powered by ViewVC 1.1.22