/[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.151 by heimbach, Mon Jun 25 20:20:05 2007 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          EXTERNAL DIFFERENT_MULTIPLE
49          LOGICAL  DIFFERENT_MULTIPLE
50    #endif
51    
52    #ifdef HAVE_SIGREG
53    #include "SIGREG.h"
54    #endif
55    
56  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
57  # include "SHAP_FILT.h"  # include "SHAP_FILT.h"
58  #endif  #endif
# Line 56  C     == Global variables == Line 66  C     == Global variables ==
66  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
67  # include "FFIELDS.h"  # include "FFIELDS.h"
68    
 # ifdef ALLOW_NONHYDROSTATIC  
 #  include "CG3D.h"  
 # endif  
   
69  # include "tamc.h"  # include "tamc.h"
70  # include "ctrl.h"  # include "ctrl.h"
71  # include "ctrl_dummy.h"  # include "ctrl_dummy.h"
72  # include "cost.h"  # include "cost.h"
73  # include "EOS.h"  # include "EOS.h"
74    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
75    #  include "GRID.h"
76    # endif
77  # ifdef ALLOW_EXF  # ifdef ALLOW_EXF
78  #  include "exf_fields.h"  #  include "EXF_FIELDS.h"
 #  include "exf_clim_fields.h"  
79  #  ifdef ALLOW_BULKFORMULAE  #  ifdef ALLOW_BULKFORMULAE
80  #   include "exf_constants.h"  #   include "EXF_CONSTANTS.h"
81  #  endif  #  endif
82  # endif  # endif
 # ifdef ALLOW_OBCS  
 #  include "OBCS.h"  
 # endif  
83  # ifdef ALLOW_PTRACERS  # ifdef ALLOW_PTRACERS
84  #  include "PTRACERS_SIZE.h"  #  include "PTRACERS_SIZE.h"
85  #  include "PTRACERS.h"  #  include "PTRACERS.h"
86  # endif  # endif
87    # ifdef ALLOW_OBCS
88    #  include "OBCS.h"
89    #  ifdef ALLOW_PTRACERS
90    #   include "OBCS_PTRACERS.h"
91    #  endif
92    # endif
93  # ifdef ALLOW_CD_CODE  # ifdef ALLOW_CD_CODE
94  #  include "CD_CODE_VARS.h"  #  include "CD_CODE_VARS.h"
95  # endif  # endif
96    # ifdef ALLOW_THSICE
97    #  include "THSICE_VARS.h"
98    # endif
99    # ifdef ALLOW_SEAICE
100    #  include "SEAICE.h"
101    # endif
102  # ifdef ALLOW_EBM  # ifdef ALLOW_EBM
103  #  include "EBM.h"  #  include "EBM.h"
104  # endif  # endif
# Line 94  C     == Global variables == Line 111  C     == Global variables ==
111  # ifdef ALLOW_GMREDI  # ifdef ALLOW_GMREDI
112  #  include "GMREDI.h"  #  include "GMREDI.h"
113  # endif  # endif
114    # ifdef ALLOW_RBCS
115    #  include "RBCS.h"
116    # endif
117  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
118    
119  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
120  C     == Routine arguments ==  C     == Routine arguments ==
121  C     note: under the multi-threaded model myiter and  C     note: under the multi-threaded model myIter and
122  C           mytime are local variables passed around as routine  C           myTime are local variables passed around as routine
123  C           arguments. Although this is fiddly it saves the need to  C           arguments. Although this is fiddly it saves the need to
124  C           impose additional synchronisation points when they are  C           impose additional synchronisation points when they are
125  C           updated.  C           updated.
126  C     myIter - iteration counter for this thread  C     myIter - iteration counter for this thread
127  C     myTime - time counter for this thread  C     myTime - time counter for this thread
128  C     myThid - thread number for this instance of the routine.  C     myThid - thread number for this instance of the routine.
129        INTEGER iloop        INTEGER iloop
130        INTEGER myThid        INTEGER myThid
131        INTEGER myIter        INTEGER myIter
132        _RL     myTime        _RL     myTime
133    
134  C     == Local variables ==  C     == Local variables ==
135    #ifdef COMPONENT_MODULE
136        INTEGER myItP1        INTEGER myItP1
137    #endif
138  CEOP  CEOP
139    
140  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
141        IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
142       &    CALL DEBUG_ENTER('FORWARD_STEP',myThid)       &    CALL DEBUG_ENTER('FORWARD_STEP',myThid)
143  #endif  #endif
144    
145  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
146  C--   Reset the model iteration counter and the model time.  C--   Reset the model iteration counter and the model time.
147        myiter = nIter0 + (iloop-1)        myIter = nIter0 + (iloop-1)
148        mytime = startTime + float(iloop-1)*deltaTclock        myTime = startTime + float(iloop-1)*deltaTclock
 #endif  
   
 #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))  
 C     Include call to a dummy routine. Its adjoint will be  
 C     called at the proper place in the adjoint code.  
 C     The adjoint routine will print out adjoint values  
 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 )  
149  #endif  #endif
150    
151  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
152  c**************************************  c**************************************
153  #include "checkpoint_lev1_directives.h"  #include "checkpoint_lev1_directives.h"
154    #include "checkpoint_lev1_template.h"
155  c**************************************  c**************************************
156  #endif  #endif
157    
158  C--   Call external forcing package  C--   Switch on/off diagnostics for snap-shot output:
159  #ifdef ALLOW_BULK_FORCE  #ifdef ALLOW_DIAGNOSTICS
160        IF ( useBulkForce ) THEN        IF ( useDiagnostics ) THEN
161            CALL DIAGNOSTICS_SWITCH_ONOFF( myTime, myIter, myThid )
162    C--   State-variables diagnostics
163            CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
164            CALL DO_STATEVARS_DIAGS( myTime, 0, myIter, myThid )
165            CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
166          ENDIF
167    #endif
168    
169    #ifdef ALLOW_PROFILES
170  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
171         IF ( debugLevel .GE. debLevB )        IF (debugMode) CALL DEBUG_CALL('',myThid)
172       &    CALL DEBUG_CALL('BULKF_FIELDS_LOAD',myThid)  #endif
173    c--     Accumulate in-situ time averages of theta, salt, and SSH.
174            CALL TIMER_START('PROFILES_INLOOP    [THE_MAIN_LOOP]', mythid)
175            CALL PROFILES_INLOOP( mytime, mythid )
176            CALL TIMER_STOP ('PROFILES_INLOOP    [THE_MAIN_LOOP]', mythid)
177  #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 */  
178    
179  # 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  
180  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
181         IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
182       &    CALL DEBUG_CALL('EXTERNAL_FIELDS_LOAD',myThid)       & CALL DEBUG_CALL('LOAD_FIELDS_DRIVER',myThid)
183  #endif  #endif
184         CALL TIMER_START('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)        CALL TIMER_START('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
185         CALL EXTERNAL_FIELDS_LOAD( mytime, myiter, mythid )        CALL LOAD_FIELDS_DRIVER( myTime, myIter, myThid )
186         CALL TIMER_STOP ('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid)        CALL TIMER_STOP ('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
187  #  if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM))  
188        ENDIF  C--   Call Bulk-Formulae forcing package
 #  endif  
 # endif /* ALLOW_EXF */  
189  #ifdef ALLOW_BULK_FORCE  #ifdef ALLOW_BULK_FORCE
190  C--   end of if/else block useBulfforce --        IF ( useBulkForce ) THEN
191    #ifdef ALLOW_DEBUG
192            IF ( debugLevel .GE. debLevB )
193         &   CALL DEBUG_CALL('BULKF_FORCING',myThid)
194    #endif
195            CALL TIMER_START('BULKF_FORCING       [FORWARD_STEP]',myThid)
196    C-    calculate qnet and empmr (and wind stress)
197            CALL BULKF_FORCING( myTime, myIter, myThid )
198            CALL TIMER_STOP ('BULKF_FORCING       [FORWARD_STEP]',myThid)
199        ENDIF        ENDIF
200  #endif /* ALLOW_BULK_FORCE */  #endif /* ALLOW_BULK_FORCE */
201    
202  #ifdef ALLOW_AUTODIFF  #ifdef ALLOW_AUTODIFF
203  c--   Add control vector for forcing and parameter fields  c--   Add control vector for forcing and parameter fields
204        if ( myiter .EQ. nIter0 )        IF ( myIter .EQ. nIter0 )
205       &     CALL CTRL_MAP_FORCING (mythid)       &     CALL CTRL_MAP_FORCING (myThid)
206  #endif  #endif
207    
208  # ifdef ALLOW_SEAICE  #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))
209  C--   Call sea ice model to compute forcing/external data fields.  In        CALL DUMMY_IN_STEPPING( myTime, myIter, myThid )
 C     addition to computing prognostic sea-ice variables and diagnosing the  
 C     forcing/external data fields that drive the ocean model, SEAICE_MODEL  
 C     also sets theta to the freezing point under sea-ice.  The implied  
 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)  
       ENDIF  
 # endif /* ALLOW_SEAICE */  
   
 #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  
   
 #ifdef ALLOW_OFFLINE  
         call OFFLINE_FIELDS_LOAD( myTime, myIter, myThid )  
 #endif  
   
 #ifdef ALLOW_PTRACERS  
 # ifdef ALLOW_GCHEM  
          CALL GCHEM_FIELDS_LOAD( mytime, myiter, mythid )  
 # endif  
210  #endif  #endif
211    
212  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
213         IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN
214  C      Post coupling data that I export.  C      Post coupling data that I export.
215  C      Read in coupling data that I import.  C      Read in coupling data that I import.
216           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
217           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )
218           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )
219           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
220         ENDIF        ENDIF
221  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
222    
223  #ifdef ALLOW_EBM  #ifdef ALLOW_EBM
224          IF ( useEBM ) THEN        IF ( useEBM ) THEN
225  # ifdef ALLOW_DEBUG  # ifdef ALLOW_DEBUG
226           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
227       &    CALL DEBUG_CALL('EBM',myThid)       &    CALL DEBUG_CALL('EBM',myThid)
228  # endif  # endif
229           CALL TIMER_START('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_START('EBM                [FORWARD_STEP]',myThid)
230           CALL EBM_DRIVER ( myTime, myIter, myThid )           CALL EBM_DRIVER ( myTime, myIter, myThid )
231           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',myThid)
232          ENDIF        ENDIF
233  #endif  #endif /* ALLOW_EBM */
234    
235  C--     Step forward fields and calculate time tendency terms.  C--     Step forward fields and calculate time tendency terms.
236    
237  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
238         IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
239       &    CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)       & CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)
240  #endif  #endif
241         CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
242         CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )        CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )
243         CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
244    
245  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
246  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  
247  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
248  CADJ STORE uvel               = comlev1, key = ikey_dynamics  CADJ STORE uvel               = comlev1, key = ikey_dynamics
249  CADJ STORE vvel               = comlev1, key = ikey_dynamics  CADJ STORE vvel               = comlev1, key = ikey_dynamics
250  # endif  # endif
251  # ifdef EXACT_CONSERV  # ifdef EXACT_CONSERV
252  CADJ STORE empmr              = comlev1, key = ikey_dynamics  cphCADJ STORE empmr              = comlev1, key = ikey_dynamics
253  CADJ STORE pmepr              = comlev1, key = ikey_dynamics  cphCADJ STORE pmepr              = comlev1, key = ikey_dynamics
254    # endif
255    # ifdef ALLOW_PTRACERS
256    CADJ STORE ptracer               = comlev1, key = ikey_dynamics
257    # endif
258    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
259    cph-test
260    CADJ STORE hFacC                 = comlev1, key = ikey_dynamics
261    #  ifndef DISABLE_RSTAR_CODE
262    CADJ STORE rstarexpc             = comlev1, key = ikey_dynamics
263    #  endif
264  # endif  # endif
265  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
266    
267  #ifndef ALLOW_OFFLINE  #ifndef ALLOW_AUTODIFF_TAMC
268          IF ( .NOT. useOffLine ) THEN
269    #endif
270  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
271         IF ( debugLevel .GE. debLevB )         IF ( debugLevel .GE. debLevB )
272       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)
273  #endif  #endif
274         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
275         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )
276         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
277    #ifdef ALLOW_AUTODIFF_TAMC
278    CADJ STORE EmPmR    = comlev1, key = ikey_dynamics
279    # ifdef EXACT_CONSERV
280    CADJ STORE pmepr    = comlev1, key = ikey_dynamics
281    # endif
282    #else
283          ENDIF
284    #endif
285    
286    #ifdef ALLOW_AUTODIFF_TAMC
287    # ifdef NONLIN_FRSURF
288    cph-test
289    CADJ STORE hFac_surfC         = comlev1, key = ikey_dynamics
290    CADJ STORE hfac_surfs         = comlev1, key = ikey_dynamics
291    CADJ STORE hfac_surfw         = comlev1, key = ikey_dynamics
292    # endif
293    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
294    CADJ STORE hFacC, hFacS, hFacW
295    CADJ &     = comlev1, key = ikey_dynamics
296    CADJ STORE recip_hFacC, recip_hFacS, recip_hFacW
297    CADJ &     = comlev1, key = ikey_dynamics
298    c
299    CADJ STORE surfaceforcingu = comlev1, key = ikey_dynamics
300    CADJ STORE surfaceforcingv = comlev1, key = ikey_dynamics
301    # endif
302    #endif /* ALLOW_AUTODIFF_TAMC */
303    
304    #ifdef ALLOW_GCHEM
305    C     GCHEM package is an interface for any bio-geochemical or
306    C     ecosystem model you would like to include.
307    C     If GCHEM_SEPARATE_FORCING is not defined, you are
308    C     responsible for computing tendency terms for passive
309    C     tracers and storing them on a 3DxNumPtracers-array called
310    C     gchemTendency in GCHEM_CALC_TENDENCY. This tendency is then added
311    C     to gPtr in ptracers_forcing later-on.
312    C     If GCHEM_SEPARATE_FORCING is defined, you are reponsible for
313    C     UPDATING ptracers directly in GCHEM_FORCING_SEP. This amounts
314    C     to a completely separate time step that you have to implement
315    C     yourself (Eulerian seems to be fine in most cases).
316    CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
317    C     CAVEAT: Up to now, when GCHEM is turned on the field ptracerForcingSurf,
318    C     which is needed for KPP is not set properly. ptracerForcingSurf must
319    C     be treated differently depending on whether GCHEM_SEPARATE_FORCING
320    C     is define or not. TBD.
321    CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
322          IF ( useGCHEM ) THEN
323    #ifdef ALLOW_DEBUG
324            IF ( debugLevel .GE. debLevB )
325         &       CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid)
326  #endif  #endif
327            CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
328            CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid )
329            CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
330          ENDIF
331    #endif /* ALLOW_GCHEM */
332    
333  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
334  cph needed to be moved here from do_oceanic_physics  cph needed to be moved here from do_oceanic_physics
# Line 327  CADJ STORE KPPfrac            = comlev1, Line 360  CADJ STORE KPPfrac            = comlev1,
360  CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics  CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics
361  CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics  CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics
362  # endif  # endif
363    c
364    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
365    CADJ STORE etaH               = comlev1, key = ikey_dynamics
366    #  ifdef ALLOW_CD_CODE
367    CADJ STORE etanm1             = comlev1, key = ikey_dynamics
368    #  endif
369    #  ifndef DISABLE_RSTAR_CODE
370    cph-test
371    CADJ STORE rstarexpc = comlev1, key = ikey_dynamics
372    #  endif
373    # endif
374  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
375    
376        IF ( .NOT.staggerTimeStep ) THEN        IF ( .NOT.staggerTimeStep ) THEN
377  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
378          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
379       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)
380  #endif  #endif
381          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
382          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
383          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
384  C--    if not staggerTimeStep: end  C--    if not staggerTimeStep: end
385        ENDIF        ENDIF
386    c #ifdef ALLOW_NONHYDROSTATIC
387          IF ( implicitIntGravWave ) THEN
388            CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
389            CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
390            CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
391          ENDIF
392    c #endif
393    
394  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
395         IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN
396  C      Post coupling data that I export.  C      Post coupling data that I export.
397  C      Read in coupling data that I import.  C      Read in coupling data that I import.
398           myItP1 = myIter + 1           myItP1 = myIter + 1
# Line 349  C      Read in coupling data that I impo Line 400  C      Read in coupling data that I impo
400           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )
401           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )
402           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
403  # ifndef ALLOW_AIM  # ifdef ALLOW_OCN_COMPON_INTERF
404          IF ( useRealFreshWaterFlux ) THEN          IF ( useRealFreshWaterFlux ) THEN
405           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )
406          ENDIF          ENDIF
407  # endif  # endif /* ALLOW_OCN_COMPON_INTERF */
408         ENDIF        ENDIF
409  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
410    
411    #ifdef ALLOW_AUTODIFF_TAMC
412    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
413    CADJ STORE hFacC          = comlev1, key = ikey_dynamics
414    CADJ STORE hFacS          = comlev1, key = ikey_dynamics
415    CADJ STORE hFacW          = comlev1, key = ikey_dynamics
416    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
417    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
418    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
419    CADJ STORE etaN           = comlev1, key = ikey_dynamics
420    c
421    #  ifndef DISABLE_RSTAR_CODE
422    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics
423    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics
424    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics
425    c
426    CADJ STORE h0facc,h0facs,h0facw  
427    CADJ &     = comlev1, key = ikey_dynamics
428    CADJ STORE rstardhcdt,rstardhsdt,rstardhwdt
429    CADJ &     = comlev1, key = ikey_dynamics
430    CADJ STORE rstarexpc,rstarexps,rstarexpw
431    CADJ &     = comlev1, key = ikey_dynamics
432    #  endif
433    # endif
434    #endif
435  C--   Step forward fields and calculate time tendency terms.  C--   Step forward fields and calculate time tendency terms.
 #ifndef ALLOW_OFFLINE  
436  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
437        IF ( momStepping ) THEN        IF ( momStepping ) THEN
438  #endif  #endif
439  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
440          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
441       &    CALL DEBUG_CALL('DYNAMICS',myThid)       &    CALL DEBUG_CALL('DYNAMICS',myThid)
442  #endif  #endif
443          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',myThid)
444          CALL DYNAMICS( myTime, myIter, myThid )          CALL DYNAMICS( myTime, myIter, myThid )
445          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',myThid)
446  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
447        ENDIF        ENDIF
448  #endif  #endif
 #endif  
449    
450  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_AUTODIFF_TAMC
451  C--   Step forward W field in N-H algorithm  # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
452        IF ( momStepping .AND. nonHydrostatic ) THEN  cph-test
453  #ifdef ALLOW_DEBUG  CADJ STORE gU, gV  = comlev1, key = ikey_dynamics
454            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  
455  #endif  #endif
456    
457  C--   Update time-counter  C--   Update time-counter
458        myIter = nIter0 + iLoop        myIter = nIter0 + iLoop
459        myTime = startTime + deltaTClock * float(iLoop)        myTime = startTime + deltaTClock * float(iLoop)
460    
461    #ifdef ALLOW_MNC
462    C     Update the default next iter for MNC
463          IF ( useMNC ) THEN
464             CALL MNC_CW_CITER_SETG( 1, 1, -1, myIter , myThid )
465    
466    C        TODO: Logic should be added here so that users can specify, on
467    C        a per-citer-group basis, when it is time to update the
468    C        "current" (and not just the "next") iteration
469    
470    C        TODO: the following is just a temporary band-aid (mostly, for
471    C        Baylor) until someone writes a routine that better handles time
472    C        boundaries such as weeks, months, years, etc.
473             IF ( mnc_filefreq .GT. 0 ) THEN
474               IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock))
475         &          THEN
476                 CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid )
477               ENDIF
478             ENDIF
479          ENDIF
480    #endif /* ALLOW_MNC */
481    
482  C--   Update geometric factors:  C--   Update geometric factors:
483  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
484  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) :
485        IF ( nonlinFreeSurf.GT.0) THEN        IF ( nonlinFreeSurf.GT.0) THEN
486         IF ( select_rStar.GT.0 ) THEN         IF ( select_rStar.GT.0 ) THEN
487          CALL TIMER_START('UPDATE_R_STAR      [FORWARD_STEP]',myThid)  # ifndef DISABLE_RSTAR_CODE
488    # ifdef ALLOW_AUTODIFF_TAMC
489    cph-test
490    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
491    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
492    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
493    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
494    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
495    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
496    c
497    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics
498    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics
499    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics
500    c
501    CADJ STORE h0facc,h0facs,h0facw  = comlev1, key = ikey_dynamics
502    # endif
503            CALL TIMER_START('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
504          CALL UPDATE_R_STAR( myTime, myIter, myThid )          CALL UPDATE_R_STAR( myTime, myIter, myThid )
505          CALL TIMER_STOP ('UPDATE_R_STAR      [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
506    # ifdef ALLOW_AUTODIFF_TAMC
507    cph-test
508    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
509    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
510    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
511    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
512    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
513    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
514    # endif
515    # endif /* DISABLE_RSTAR_CODE */
516         ELSE         ELSE
517          CALL TIMER_START('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)  #ifdef ALLOW_AUTODIFF_TAMC
518    CADJ STORE hFac_surfC, hFac_surfS, hFac_surfW
519    CADJ &     = comlev1, key = ikey_dynamics
520    #endif
521            CALL TIMER_START('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
522          CALL UPDATE_SURF_DR( myTime, myIter, myThid )          CALL UPDATE_SURF_DR( myTime, myIter, myThid )
523          CALL TIMER_STOP ('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
524         ENDIF         ENDIF
525        ENDIF        ENDIF
526    # ifdef ALLOW_AUTODIFF_TAMC
527    cph-test
528    CADJ STORE hFacC    = comlev1, key = ikey_dynamics
529    CADJ STORE hFacS    = comlev1, key = ikey_dynamics
530    CADJ STORE hFacW    = comlev1, key = ikey_dynamics
531    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics
532    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics
533    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics
534    # endif
535  C-    update also CG2D matrix (and preconditioner)  C-    update also CG2D matrix (and preconditioner)
536        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN
537          CALL TIMER_START('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_START('UPDATE_CG2D         [FORWARD_STEP]',myThid)
538          CALL UPDATE_CG2D( myTime, myIter, myThid )          CALL UPDATE_CG2D( myTime, myIter, myThid )
539          CALL TIMER_STOP ('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_CG2D         [FORWARD_STEP]',myThid)
540        ENDIF        ENDIF
541  #endif  #endif /* NONLIN_FRSURF */
542    
543  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE
544  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
545        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN        IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN
546          CALL TIMER_START('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_START('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
547          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
548  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
549  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
# Line 424  C      => Filtering of uVel,vVel is nece Line 551  C      => Filtering of uVel,vVel is nece
551       &                             myTime, myIter, myThid )       &                             myTime, myIter, myThid )
552          ENDIF          ENDIF
553          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)          CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid)
554          CALL TIMER_STOP ('SHAP_FILT           [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SHAP_FILT_UV        [FORWARD_STEP]',myThid)
555        ENDIF        ENDIF
556  #endif  #endif
557  #ifdef ALLOW_ZONAL_FILT  #ifdef ALLOW_ZONAL_FILT
558        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN        IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN
559          CALL TIMER_START('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_START('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
560          IF (implicDiv2Dflow.LT.1.) THEN          IF (implicDiv2Dflow.LT.1.) THEN
561  C--   Explicit+Implicit part of the Barotropic Flow Divergence  C--   Explicit+Implicit part of the Barotropic Flow Divergence
562  C      => Filtering of uVel,vVel is necessary  C      => Filtering of uVel,vVel is necessary
563            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )            CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid )
564          ENDIF          ENDIF
565          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )
566          CALL TIMER_STOP ('ZONAL_FILT_APPLY    [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
567        ENDIF        ENDIF
568  #endif    #endif
569    
570  C--   Solve elliptic equation(s).  C--   Solve elliptic equation(s).
571  C     Two-dimensional only for conventional hydrostatic or  C     Two-dimensional only for conventional hydrostatic or
572  C     three-dimensional for non-hydrostatic and/or IGW scheme.  C     three-dimensional for non-hydrostatic and/or IGW scheme.
 #ifndef ALLOW_OFFLINE  
573        IF ( momStepping ) THEN        IF ( momStepping ) THEN
574    #ifdef ALLOW_AUTODIFF_TAMC
575    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
576    CADJ STORE uvel, vvel
577    CADJ &     = comlev1, key = ikey_dynamics
578    CADJ STORE empmr,hfacs,hfacw
579    CADJ &     = comlev1, key = ikey_dynamics
580    # endif
581    #endif
582          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
583          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)
584          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
585        ENDIF        ENDIF
 #endif  
586    
587  C--   Correct divergence in flow field and cycle time-stepping momentum  C--   Correct divergence in flow field and cycle time-stepping momentum
588  c     IF ( momStepping ) THEN  #ifndef ALLOW_AUTODIFF_TAMC
589  #ifndef ALLOW_OFFLINE        IF ( momStepping ) THEN
590          CALL TIMER_START('UV_CORRECTION_STEP  [FORWARD_STEP]',myThid)  #endif
591    #ifdef ALLOW_AUTODIFF_TAMC
592    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
593    #  ifndef DISABLE_RSTAR_CODE
594    cph-test
595    cph not clear, why this one
596    CADJ STORE h0facc = comlev1, key = ikey_dynamics
597    #  endif
598    # endif
599    # ifdef ALLOW_DEPTH_CONTROL
600    CADJ STORE etan, uvel,vvel
601    CADJ &     = comlev1, key = ikey_dynamics
602    # endif
603    #endif
604            CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
605          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)
606          CALL TIMER_STOP ('UV_CORRECTION_STEP  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
607    #ifndef ALLOW_AUTODIFF_TAMC
608          ENDIF
609  #endif  #endif
 c     ENDIF  
610    
611  #ifdef EXACT_CONSERV  #ifdef EXACT_CONSERV
612        IF (exactConserv) THEN        IF (exactConserv) THEN
613  C--   Update etaH(n+1) :  C--   Update etaH(n+1) :
614          CALL TIMER_START('UPDATE_ETAH        [FORWARD_STEP]',mythid)          CALL TIMER_START('UPDATE_ETAH         [FORWARD_STEP]',myThid)
615          CALL UPDATE_ETAH( myTime, myIter, myThid )          CALL UPDATE_ETAH( myTime, myIter, myThid )
616          CALL TIMER_STOP ('UPDATE_ETAH        [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('UPDATE_ETAH         [FORWARD_STEP]',myThid)
617        ENDIF        ENDIF
618  #endif /* EXACT_CONSERV */  #endif /* EXACT_CONSERV */
619    
620  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
621        IF ( select_rStar.NE.0 ) THEN        IF ( select_rStar.NE.0 ) THEN
622  C--   r* : compute the future level thickness according to etaH(n+1)  # ifndef DISABLE_RSTAR_CODE
623          CALL TIMER_START('CALC_R_STAR       [FORWARD_STEP]',mythid)  #  ifdef ALLOW_AUTODIFF_TAMC
624    cph-test
625    CADJ STORE rstarfacc,rstarfacs,rstarfacw = comlev1, key = ikey_dynamics
626    #  endif
627    C--   r* : compute the future level thickness according to etaH(n+1)
628            CALL TIMER_START('CALC_R_STAR         [FORWARD_STEP]',myThid)
629          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )
630          CALL TIMER_STOP ('CALC_R_STAR       [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_R_STAR         [FORWARD_STEP]',myThid)
631    # endif /* DISABLE_RSTAR_CODE */
632        ELSEIF ( nonlinFreeSurf.GT.0) THEN        ELSEIF ( nonlinFreeSurf.GT.0) THEN
633  C--   compute the future surface level thickness according to etaH(n+1)  C--   compute the future surface level thickness according to etaH(n+1)
634          CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',mythid)  # ifdef ALLOW_AUTODIFF_TAMC
635    CADJ STORE etaH          = comlev1, key = ikey_dynamics
636    # endif
637            CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',myThid)
638          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )
639          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',myThid)
640        ENDIF        ENDIF
641    # ifdef ALLOW_AUTODIFF_TAMC
642    cph-test
643    CADJ STORE hFac_surfC    = comlev1, key = ikey_dynamics
644    # endif
645  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
646    
647  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
# Line 488  C---+----1----+----2----+----3----+----4 Line 649  C---+----1----+----2----+----3----+----4
649  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 :
650  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
651          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
652       &    CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)       &   CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)
653  #endif  #endif
654          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
655          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
656          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
657    
658    #ifdef ALLOW_DIAGNOSTICS
659    C--   State-variables diagnostics
660            IF ( useDiagnostics ) THEN
661              CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
662              CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid )
663              CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
664            ENDIF
665    #endif
666    
667  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
668          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
669       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &   CALL DEBUG_CALL('THERMODYNAMICS',myThid)
670  #endif  #endif
671          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
672          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
673          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
674    
675  C--    if staggerTimeStep: end  C--    if staggerTimeStep: end
676        ENDIF        ENDIF
677  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+--------+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
678    
679  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
680  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 682  cph find_rho which may use pressure()
682  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics
683  #endif  #endif
684  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)
685          CALL TIMER_START('TS_CORRECTION_STEP  [FORWARD_STEP]',myThid)        CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
686          CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)        CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)
687          CALL TIMER_STOP ('TS_CORRECTION_STEP  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
688    
689    #ifdef ALLOW_GCHEM
690    C     Add separate timestepping of chemical/biological/forcing
691    C     of ptracers here in GCHEM_FORCING_SEP
692          IF ( useGCHEM ) THEN
693    #ifdef ALLOW_DEBUG
694             IF ( debugLevel .GE. debLevB )
695         &    CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid)
696    #endif /* ALLOW_DEBUG */
697             CALL TIMER_START('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
698             CALL GCHEM_FORCING_SEP( myTime,myIter,myThid )
699             CALL TIMER_STOP ('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
700          ENDIF
701    #endif /* ALLOW_GCHEM */
702    
703  C--   Do "blocking" sends and receives for tendency "overlap" terms  C--   Do "blocking" sends and receives for tendency "overlap" terms
704  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 710  C--   Do "blocking" sends and receives f
710        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )
711        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
712    
713  cswdptr -- add for seperate timestepping of chemical/biological/forcing  #ifdef ALLOW_DIAGNOSTICS
714  cswdptr    of ptracers ---        IF ( useDiagnostics ) THEN
715  #ifdef ALLOW_GCHEM         CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
716  ceh3 This is broken -- this ifdef should not be visible!         CALL DO_STATEVARS_DIAGS( myTime, 2, myIter, myThid )
717  #ifdef PTRACERS_SEPARATE_FORCING         CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
718  ceh3 needs an IF ( use GCHEM ) THEN        ENDIF
719          call GCHEM_FORCING_SEP( myTime,myIter,myThid )  #endif
 #endif /* PTRACERS_SEPARATE_FORCING */  
 #endif /* ALLOW_GCHEM */  
 cswdptr -- end add ---  
720    
 C AMM  
721  #ifdef ALLOW_GRIDALT  #ifdef ALLOW_GRIDALT
722          if (useGRIDALT) then        IF (useGRIDALT) THEN
723           CALL GRIDALT_UPDATE(myThid)           CALL GRIDALT_UPDATE(myThid)
724          endif        ENDIF
725  #endif  #endif
 C AMM  
726    
 C AMM  
727  #ifdef ALLOW_FIZHI  #ifdef ALLOW_FIZHI
728          if( useFIZHI) then        IF (useFIZHI) THEN
729           CALL TIMER_START('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_START('FIZHI               [FORWARD_STEP]',myThid)
730           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid )           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid, dTtracerLev(1) )
731           CALL TIMER_STOP('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('FIZHI               [FORWARD_STEP]',myThid)
732          endif        ENDIF
733  #endif  #endif
 C AMM  
734    
735  #ifdef ALLOW_FLT  #ifdef ALLOW_FLT
736  C--   Calculate float trajectories  C--   Calculate float trajectories
# Line 564  C--   Calculate float trajectories Line 741  C--   Calculate float trajectories
741        ENDIF        ENDIF
742  #endif  #endif
743    
744  C--   State-variables statistics (time-aver, diagnostics ...)  #ifdef ALLOW_TIMEAVE
745        CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)  C--   State-variables time-averaging
746        CALL DO_STATEVARS_DIAGS( myTime, myIter, myThid )        CALL TIMER_START('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
747        CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)        CALL DO_STATEVARS_TAVE( myTime, myIter, myThid )
748          CALL TIMER_STOP ('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
749    #endif
750    
 #ifndef ALLOW_OFFLINE  
751  #ifdef ALLOW_MONITOR  #ifdef ALLOW_MONITOR
752          IF ( .NOT.useOffLine ) THEN
753  C--   Check status of solution (statistics, cfl, etc...)  C--   Check status of solution (statistics, cfl, etc...)
754        CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)
755        CALL MONITOR( myIter, myTime, myThid )          CALL MONITOR( myIter, myTime, myThid )
756        CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)
757          ENDIF
758  #endif /* ALLOW_MONITOR */  #endif /* ALLOW_MONITOR */
 #endif  
759    
760  #ifdef ALLOW_COST  #ifdef ALLOW_COST
761  C--     compare model with data and compute cost function  C--     compare model with data and compute cost function
762  C--     this is done after exchanges to allow interpolation  C--     this is done after exchanges to allow interpolation
763        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)
764        CALL COST_TILE  ( mytime, myiter, myThid )        CALL COST_TILE  ( myTime, myIter, myThid )
765        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)
766  #endif  #endif
767    
768  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  
769        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
770        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )
771        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
772  #endif  
773    #ifdef HAVE_SIGREG
774          IF ( useSIGREG ) THEN
775            IF ( i_got_signal .GT. 0 ) THEN
776              CALL PACKAGES_WRITE_PICKUP(
777         I         .TRUE., myTime, myIter, myThid )
778              CALL WRITE_PICKUP(
779         I         .TRUE., myTime, myIter, myThid )
780              STOP 'Checkpoint completed -- killed by signal handler'
781            ENDIF
782          ENDIF
783    #endif /* HAVE_SIGREG */
784    
785  C--   Save state for restarts  C--   Save state for restarts
786        CALL TIMER_START('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
787        CALL PACKAGES_WRITE_PICKUP(        CALL DO_WRITE_PICKUP(
788       I               .FALSE., myTime, myIter, myThid )       I               .FALSE., myTime, myIter, myThid )
789  #ifndef ALLOW_OFFLINE        CALL TIMER_STOP ('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
       CALL WRITE_CHECKPOINT(  
      I               .FALSE., myTime, myIter, myThid )    
 #endif  
       CALL TIMER_STOP ('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)  
790    
791  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
792        IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
793       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)
794  #endif  #endif
795    
Legend:
Removed from v.1.105  
changed lines
  Added in v.1.151
  ViewVC Help
Powered by ViewVC 1.1.22