/[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.123 by jmc, Fri Nov 4 01:19:24 2005 UTC revision 1.165 by heimbach, Fri Feb 13 21:56:48 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_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 25  C     | Line 28  C     |
28  C     | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and  C     | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and
29  C     | Adjoint Model Compiler (TAMC). For this purpose the initialization  C     | Adjoint Model Compiler (TAMC). For this purpose the initialization
30  C     | of the model was split into two parts. Those parameters that do  C     | of the model was split into two parts. Those parameters that do
31  C     | not depend on a specific model run are set in INITIALISE_FIXED,    C     | not depend on a specific model run are set in INITIALISE_FIXED,
32  C     | whereas those that do depend on the specific realization are  C     | whereas those that do depend on the specific realization are
33  C     | initialized in INITIALISE_VARIA.    C     | initialized in INITIALISE_VARIA.
34  C     |  C     |
35  C     *==================================================================  C     *==================================================================
36  C     \ev  C     \ev
# Line 42  C     == Global variables == Line 45  C     == Global variables ==
45    
46  #ifdef ALLOW_MNC  #ifdef ALLOW_MNC
47  #include "MNC_PARAMS.h"  #include "MNC_PARAMS.h"
48        EXTERNAL DIFFERENT_MULTIPLE  #endif
49        LOGICAL  DIFFERENT_MULTIPLE  
50    #ifdef HAVE_SIGREG
51    #include "SIGREG.h"
52  #endif  #endif
53    
54  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
# Line 58  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  #ifdef COMPONENT_MODULE
155        INTEGER myItP1        INTEGER myItP1
156  #endif  #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          CALL AUTODIFF_INADMODE_UNSET( myThid )
166    #endif
167    
168    #ifdef ALLOW_AUTODIFF_TAMC
169  C--   Reset the model iteration counter and the model time.  C--   Reset the model iteration counter and the model time.
170        myIter = nIter0 + (iloop-1)        myIter = nIter0 + (iloop-1)
171        myTime = startTime + float(iloop-1)*deltaTclock        myTime = startTime + float(iloop-1)*deltaTclock
# Line 134  C--   Reset the model iteration counter Line 174  C--   Reset the model iteration counter
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    
# Line 141  C--   Switch on/off diagnostics for snap Line 182  C--   Switch on/off diagnostics for snap
182  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
183        IF ( useDiagnostics ) THEN        IF ( useDiagnostics ) THEN
184          CALL DIAGNOSTICS_SWITCH_ONOFF( myTime, myIter, myThid )          CALL DIAGNOSTICS_SWITCH_ONOFF( myTime, myIter, myThid )
       ENDIF  
 #endif  
   
185  C--   State-variables diagnostics  C--   State-variables diagnostics
       IF ( usediagnostics ) THEN  
186          CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)          CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
187          CALL DO_STATEVARS_DIAGS( myTime, 0, myIter, myThid )          CALL DO_STATEVARS_DIAGS( myTime, 0, myIter, myThid )
188          CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
189        ENDIF        ENDIF
190    #endif
191    
192  C--   Call external forcing package  #ifdef ALLOW_PROFILES
 #ifdef ALLOW_BULK_FORCE  
       IF ( useBulkForce ) THEN  
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 &     kind = isbyte
211        ENDIF  CADJ STORE uvel, vvel = comlev1, key = ikey_dynamics,
212  #  endif  CADJ &     kind = isbyte
213  # endif /* ALLOW_EXF */  #endif
214          CALL TIMER_START('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
215          CALL LOAD_FIELDS_DRIVER( myTime, myIter, myThid )
216          CALL TIMER_STOP ('LOAD_FIELDS_DRIVER  [FORWARD_STEP]',myThid)
217    
218    C--   Call Bulk-Formulae forcing package
219  #ifdef ALLOW_BULK_FORCE  #ifdef ALLOW_BULK_FORCE
220  C--   end of if/else block useBulfforce --        IF ( useBulkForce ) THEN
221    #ifdef ALLOW_DEBUG
222            IF ( debugLevel .GE. debLevB )
223         &   CALL DEBUG_CALL('BULKF_FORCING',myThid)
224    #endif
225            CALL TIMER_START('BULKF_FORCING       [FORWARD_STEP]',myThid)
226    C-    calculate qnet and empmr (and wind stress)
227            CALL BULKF_FORCING( myTime, myIter, myThid )
228            CALL TIMER_STOP ('BULKF_FORCING       [FORWARD_STEP]',myThid)
229        ENDIF        ENDIF
230  #endif /* ALLOW_BULK_FORCE */  #endif /* ALLOW_BULK_FORCE */
231    
232    C--   Call external chepaml forcing package
233    #ifdef ALLOW_CHEAPAML
234          IF ( useCheapAML  ) THEN
235    #ifdef ALLOW_DEBUG
236           IF ( debugLevel .GE. debLevB )
237         &    CALL DEBUG_CALL('CHEAPAML_FIELDS_LOAD',myThid)
238    #endif
239           CALL TIMER_START('CHEAPAML      [FORWARD_STEP]',mythid)
240    C-    calculate qnet (and wind stress)
241           CALL CHEAPAML( myTime, myIter,myThid )
242           CALL TIMER_STOP ('CHEAPAML      [FORWARD_STEP]',mythid)
243          ENDIF
244    #endif /*ALLOW_CHEAPAML */
245    
246    
247  #ifdef ALLOW_AUTODIFF  #ifdef ALLOW_AUTODIFF
248  c--   Add control vector for forcing and parameter fields  c--   Add control vector for forcing and parameter fields
249        if ( myiter .EQ. nIter0 )        IF ( myIter .EQ. nIter0 )
250       &     CALL CTRL_MAP_FORCING (mythid)       &     CALL CTRL_MAP_FORCING (myThid)
251  #endif  #endif
252    
253  #if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR))  #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).  
254        CALL DUMMY_IN_STEPPING( myTime, myIter, myThid )        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 )  
 #endif  
   
 # ifdef ALLOW_SEAICE  
 C--   Call sea ice model to compute forcing/external data fields.  In  
 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  
         IF ( useGCHEM ) THEN  
 #ifdef ALLOW_DEBUG  
          IF ( debugLevel .GE. debLevB )  
      &        CALL DEBUG_CALL('GCHEM_FIELDS_LOAD',myThid)  
 #endif /* ALLOW_DEBUG */  
          CALL GCHEM_FIELDS_LOAD( mytime, myiter, mythid )  
         ENDIF  
 # endif  
255  #endif  #endif
256    
257  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
258         IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN
259  C      Post coupling data that I export.  C      Post coupling data that I export.
260  C      Read in coupling data that I import.  C      Read in coupling data that I import.
261           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_START('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
262           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myIter, myTime, myThid )
263           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid )
264           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
265         ENDIF        ENDIF
266  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
267    
268  #ifdef ALLOW_EBM  #ifdef ALLOW_EBM
269          IF ( useEBM ) THEN        IF ( useEBM ) THEN
270  # ifdef ALLOW_DEBUG  # ifdef ALLOW_DEBUG
271           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
272       &    CALL DEBUG_CALL('EBM',myThid)       &    CALL DEBUG_CALL('EBM',myThid)
273  # endif  # endif
274           CALL TIMER_START('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_START('EBM                [FORWARD_STEP]',myThid)
275           CALL EBM_DRIVER ( myTime, myIter, myThid )           CALL EBM_DRIVER ( myTime, myIter, myThid )
276           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('EBM                [FORWARD_STEP]',myThid)
277          ENDIF        ENDIF
278  #endif  #endif /* ALLOW_EBM */
279    
280  C--     Step forward fields and calculate time tendency terms.  C--     Step forward fields and calculate time tendency terms.
281    
282  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
283         IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
284       &    CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)       & CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid)
285  #endif  #endif
286         CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
287         CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )        CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid )
288         CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid)        CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid)
289    
290  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
291  CADJ STORE theta              = comlev1, key = ikey_dynamics  CADJ STORE surfaceforcingtice    = comlev1, key = ikey_dynamics,
292  CADJ STORE salt               = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
 CADJ STORE totphihyd          = comlev1, key = ikey_dynamics  
 CADJ STORE surfaceforcingtice = comlev1, key = ikey_dynamics  
293  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
294  CADJ STORE uvel               = comlev1, key = ikey_dynamics  CADJ STORE uvel               = comlev1, key = ikey_dynamics,
295  CADJ STORE vvel               = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
296    CADJ STORE vvel               = comlev1, key = ikey_dynamics,
297    CADJ &     kind = isbyte
298  # endif  # endif
299  # ifdef EXACT_CONSERV  # ifdef EXACT_CONSERV
300  CADJ STORE empmr              = comlev1, key = ikey_dynamics  cphCADJ STORE empmr              = comlev1, key = ikey_dynamics
301  CADJ STORE pmepr              = comlev1, key = ikey_dynamics  cphCADJ STORE pmepr              = comlev1, key = ikey_dynamics
302    # endif
303    # ifdef ALLOW_PTRACERS
304    CADJ STORE ptracer               = comlev1, key = ikey_dynamics,
305    CADJ &     kind = isbyte
306    # endif
307    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
308    cph-test
309    CADJ STORE hFacC                 = comlev1, key = ikey_dynamics,
310    CADJ &     kind = isbyte
311    #  ifndef DISABLE_RSTAR_CODE
312    CADJ STORE rstarexpc             = comlev1, key = ikey_dynamics,
313    CADJ &     kind = isbyte
314    #  endif
315  # endif  # endif
316  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
317    
318  #ifndef ALLOW_OFFLINE  #ifndef ALLOW_AUTODIFF_TAMC
319          IF ( .NOT. useOffLine ) THEN
320    #endif
321  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
322         IF ( debugLevel .GE. debLevB )         IF ( debugLevel .GE. debLevB )
323       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)       &    CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid)
324  #endif  #endif
325         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_START('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
326         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )         CALL DO_OCEANIC_PHYS( myTime, myIter, myThid )
327         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',mythid)         CALL TIMER_STOP ('DO_OCEANIC_PHYS     [FORWARD_STEP]',myThid)
328    #ifdef ALLOW_AUTODIFF_TAMC
329    CADJ STORE EmPmR    = comlev1, key = ikey_dynamics,
330    CADJ &     kind = isbyte
331    # ifdef EXACT_CONSERV
332    CADJ STORE pmepr    = comlev1, key = ikey_dynamics,
333    CADJ &     kind = isbyte
334    # endif
335    #else
336          ENDIF
337  #endif  #endif
338    
339    #ifdef ALLOW_AUTODIFF_TAMC
340    # ifdef NONLIN_FRSURF
341    cph-test
342    CADJ STORE hFac_surfC         = comlev1, key = ikey_dynamics,
343    CADJ &     kind = isbyte
344    CADJ STORE hfac_surfs         = comlev1, key = ikey_dynamics,
345    CADJ &     kind = isbyte
346    CADJ STORE hfac_surfw         = comlev1, key = ikey_dynamics,
347    CADJ &     kind = isbyte
348    # endif
349    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
350    CADJ STORE hFacC, hFacS, hFacW
351    CADJ &     = comlev1, key = ikey_dynamics,
352    CADJ &     kind = isbyte
353    CADJ STORE recip_hFacC, recip_hFacS, recip_hFacW
354    CADJ &     = comlev1, key = ikey_dynamics,
355    CADJ &     kind = isbyte
356    c
357    CADJ STORE surfaceforcingu = comlev1, key = ikey_dynamics,
358    CADJ &     kind = isbyte
359    CADJ STORE surfaceforcingv = comlev1, key = ikey_dynamics,
360    CADJ &     kind = isbyte
361    # endif
362    #endif /* ALLOW_AUTODIFF_TAMC */
363    
364  #ifdef ALLOW_GCHEM  #ifdef ALLOW_GCHEM
365  C     GCHEM package is an interface for any bio-geochemical or  #ifdef ALLOW_AUTODIFF_TAMC
366  C     ecosystem model you would like to include.  CADJ STORE ptracer  = comlev1, key = ikey_dynamics,
367  C     If GCHEM_SEPARATE_FORCING is not defined, you are  CADJ &     kind = isbyte
368  C     responsible for computing tendency terms for passive  CADJ STORE theta  = comlev1, key = ikey_dynamics,
369  C     tracers and storing them on a 3DxNumPtracers-array called  CADJ &     kind = isbyte
370  C     gchemTendency in GCHEM_CALC_TENDENCY. This tendency is then added  CADJ STORE salt  = comlev1, key = ikey_dynamics,
371  C     to gPtr in ptracers_forcing later-on.  CADJ &     kind = isbyte
372  C     If GCHEM_SEPARATE_FORCING is defined, you are reponsible for  #endif
373  C     UPDATING ptracers directly in GCHEM_FORCING_SEP. This amounts        IF ( useGCHEM ) THEN
 C     to a completely separate time step that you have to implement  
 C     yourself (Eulerian seems to be fine in most cases).  
 CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC  
 C     CAVEAT: Up to now, when GCHEM is turned on the field ptracerForcingSurf,  
 C     which is needed for KPP is not set properly. ptracerForcingSurf must  
 C     be treated differently depending on whether GCHEM_SEPARATE_FORCING  
 C     is define or not. TBD.  
 CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC  
        IF ( useGCHEM ) THEN  
374  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
375          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
376       &       CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid)       &       CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid)
377  #endif  #endif
378          CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)          CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
379          CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid )          CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid )
380          CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid)
381         ENDIF        ENDIF
382  #endif /* ALLOW_GCHEM */  #endif /* ALLOW_GCHEM */
383    
384  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
385  cph needed to be moved here from do_oceanic_physics  cph needed to be moved here from do_oceanic_physics
386  cph to be visible down the road  cph to be visible down the road
387  c  c
388  CADJ STORE surfaceForcingS    = comlev1, key = ikey_dynamics  CADJ STORE rhoInSitu          = comlev1, key = ikey_dynamics,
389  CADJ STORE surfaceForcingT    = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
390  CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics  CADJ STORE surfaceForcingS    = comlev1, key = ikey_dynamics,
391  ctest(  CADJ &     kind = isbyte
392  CADJ STORE IVDConvCount       = comlev1, key = ikey_dynamics  CADJ STORE surfaceForcingT    = comlev1, key = ikey_dynamics,
393  ctest)  CADJ &     kind = isbyte
394    CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics,
395    CADJ &     kind = isbyte
396    CADJ STORE IVDConvCount       = comlev1, key = ikey_dynamics,
397    CADJ &     kind = isbyte
398  # ifdef ALLOW_PTRACERS  # ifdef ALLOW_PTRACERS
399  CADJ STORE surfaceForcingPtr  = comlev1, key = ikey_dynamics  CADJ STORE surfaceForcingPTr  = comlev1, key = ikey_dynamics,
400    CADJ &     kind = isbyte
401  # endif  # endif
402  c  c
403  # ifdef ALLOW_GMREDI  # ifdef ALLOW_GMREDI
404  CADJ STORE Kwx                = comlev1, key = ikey_dynamics  CADJ STORE Kwx                = comlev1, key = ikey_dynamics,
405  CADJ STORE Kwy                = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
406  CADJ STORE Kwz                = comlev1, key = ikey_dynamics  CADJ STORE Kwy                = comlev1, key = ikey_dynamics,
407    CADJ &     kind = isbyte
408    CADJ STORE Kwz                = comlev1, key = ikey_dynamics,
409    CADJ &     kind = isbyte
410  #  ifdef GM_BOLUS_ADVEC  #  ifdef GM_BOLUS_ADVEC
411  CADJ STORE GM_PsiX            = comlev1, key = ikey_dynamics  CADJ STORE GM_PsiX            = comlev1, key = ikey_dynamics,
412  CADJ STORE GM_PsiY            = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
413    CADJ STORE GM_PsiY            = comlev1, key = ikey_dynamics,
414    CADJ &     kind = isbyte
415  #  endif  #  endif
416  # endif  # endif
417  c  c
418  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
419  CADJ STORE KPPghat            = comlev1, key = ikey_dynamics  CADJ STORE KPPghat            = comlev1, key = ikey_dynamics,
420  CADJ STORE KPPfrac            = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
421  CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics  CADJ STORE KPPfrac            = comlev1, key = ikey_dynamics,
422  CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics  CADJ &     kind = isbyte
423    CADJ STORE KPPdiffKzS         = comlev1, key = ikey_dynamics,
424    CADJ &     kind = isbyte
425    CADJ STORE KPPdiffKzT         = comlev1, key = ikey_dynamics,
426    CADJ &     kind = isbyte
427    # endif
428    c
429    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
430    CADJ STORE theta,salt,wvel          = comlev1, key = ikey_dynamics,
431    CADJ &     kind = isbyte
432    CADJ STORE etaH               = comlev1, key = ikey_dynamics,
433    CADJ &     kind = isbyte
434    #  ifdef ALLOW_CD_CODE
435    CADJ STORE etanm1             = comlev1, key = ikey_dynamics,
436    CADJ &     kind = isbyte
437    #  endif
438    #  ifndef DISABLE_RSTAR_CODE
439    cph-test
440    CADJ STORE rstarexpc = comlev1, key = ikey_dynamics,
441    CADJ &     kind = isbyte
442    #  endif
443  # endif  # endif
444  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
445    
446        IF ( .NOT.staggerTimeStep ) THEN        IF ( .NOT.staggerTimeStep ) THEN
447  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
448          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
449       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)
450  #endif  #endif
451          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)  CADJ STORE salt               = comlev1, key = ikey_dynamics,
452    CADJ &     kind = isbyte
453            CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
454          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
455          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
456  C--    if not staggerTimeStep: end  C--    if not staggerTimeStep: end
457        ENDIF        ENDIF
458    c #ifdef ALLOW_NONHYDROSTATIC
459          IF ( implicitIntGravWave ) THEN
460            CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
461            CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
462            CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
463          ENDIF
464    c #endif
465    
466  #ifdef COMPONENT_MODULE  #ifdef COMPONENT_MODULE
467         IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN        IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN
468  C      Post coupling data that I export.  C      Post coupling data that I export.
469  C      Read in coupling data that I import.  C      Read in coupling data that I import.
470           myItP1 = myIter + 1           myItP1 = myIter + 1
# Line 403  C      Read in coupling data that I impo Line 472  C      Read in coupling data that I impo
472           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )           CALL CPL_EXPORT_MY_DATA(       myItP1, myTime, myThid )
473           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )           CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid )
474           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('CPL_EXPORT-IMPORT  [FORWARD_STEP]',myThid)
475  # ifndef ALLOW_AIM  # ifdef ALLOW_OCN_COMPON_INTERF
476          IF ( useRealFreshWaterFlux ) THEN          IF ( useRealFreshWaterFlux ) THEN
477           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )           CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid )
478          ENDIF          ENDIF
479  # endif  # endif /* ALLOW_OCN_COMPON_INTERF */
480         ENDIF        ENDIF
481  #endif /* COMPONENT_MODULE */  #endif /* COMPONENT_MODULE */
482    
483    #ifdef ALLOW_AUTODIFF_TAMC
484    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
485    CADJ STORE hFacC          = comlev1, key = ikey_dynamics,
486    CADJ &     kind = isbyte
487    CADJ STORE hFacS          = comlev1, key = ikey_dynamics,
488    CADJ &     kind = isbyte
489    CADJ STORE hFacW          = comlev1, key = ikey_dynamics,
490    CADJ &     kind = isbyte
491    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
492    CADJ &     kind = isbyte
493    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
494    CADJ &     kind = isbyte
495    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
496    CADJ &     kind = isbyte
497    CADJ STORE etaN           = comlev1, key = ikey_dynamics,
498    CADJ &     kind = isbyte
499    c
500    #  ifndef DISABLE_RSTAR_CODE
501    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics,
502    CADJ &     kind = isbyte
503    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics,
504    CADJ &     kind = isbyte
505    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics,
506    CADJ &     kind = isbyte
507    c
508    CADJ STORE h0facc,h0facs,h0facw  
509    CADJ &     = comlev1, key = ikey_dynamics,
510    CADJ &     kind = isbyte
511    CADJ STORE rstardhcdt,rstardhsdt,rstardhwdt
512    CADJ &     = comlev1, key = ikey_dynamics,
513    CADJ &     kind = isbyte
514    CADJ STORE rstarexpc,rstarexps,rstarexpw
515    CADJ &     = comlev1, key = ikey_dynamics,
516    CADJ &     kind = isbyte
517    #  endif
518    # endif
519    #endif
520  C--   Step forward fields and calculate time tendency terms.  C--   Step forward fields and calculate time tendency terms.
 #ifndef ALLOW_OFFLINE  
521  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
522        IF ( momStepping ) THEN        IF ( momStepping ) THEN
523  #endif  #endif
524  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
525          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
526       &    CALL DEBUG_CALL('DYNAMICS',myThid)       &    CALL DEBUG_CALL('DYNAMICS',myThid)
527  #endif  #endif
528          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_START('DYNAMICS            [FORWARD_STEP]',myThid)
529          CALL DYNAMICS( myTime, myIter, myThid )          CALL DYNAMICS( myTime, myIter, myThid )
530          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('DYNAMICS            [FORWARD_STEP]',myThid)
531  #ifndef ALLOW_AUTODIFF_TAMC  #ifndef ALLOW_AUTODIFF_TAMC
532        ENDIF        ENDIF
533  #endif  #endif
534    
535    #ifdef ALLOW_AUTODIFF_TAMC
536    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
537    CADJ STORE gU, gV  = comlev1, key = ikey_dynamics,
538    CADJ &     kind = isbyte
539    # endif
540  #endif  #endif
541    
542  C--   Update time-counter  C--   Update time-counter
# Line 445  C        TODO: the following is just a t Line 556  C        TODO: the following is just a t
556  C        Baylor) until someone writes a routine that better handles time  C        Baylor) until someone writes a routine that better handles time
557  C        boundaries such as weeks, months, years, etc.  C        boundaries such as weeks, months, years, etc.
558           IF ( mnc_filefreq .GT. 0 ) THEN           IF ( mnc_filefreq .GT. 0 ) THEN
559             IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock))             IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock))
560       &          THEN       &          THEN
561               CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid )               CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid )
562             ENDIF             ENDIF
563           ENDIF           ENDIF
564         ENDIF        ENDIF
565  #endif  #endif /* ALLOW_MNC */
566    
567  C--   Update geometric factors:  C--   Update geometric factors:
568  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
569  C-    update hfacC,W,S and recip_hFac according to etaH(n+1) :  C-    update hfacC,W,S and recip_hFac according to etaH(n+1) :
570        IF ( nonlinFreeSurf.GT.0) THEN        IF ( nonlinFreeSurf.GT.0) THEN
571         IF ( select_rStar.GT.0 ) THEN         IF ( select_rStar.GT.0 ) THEN
572          CALL TIMER_START('UPDATE_R_STAR      [FORWARD_STEP]',myThid)  # ifndef DISABLE_RSTAR_CODE
573    # ifdef ALLOW_AUTODIFF_TAMC
574    CADJ STORE hFacC    = comlev1, key = ikey_dynamics,
575    CADJ &     kind = isbyte
576    CADJ STORE hFacS    = comlev1, key = ikey_dynamics,
577    CADJ &     kind = isbyte
578    CADJ STORE hFacW    = comlev1, key = ikey_dynamics,
579    CADJ &     kind = isbyte
580    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
581    CADJ &     kind = isbyte
582    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
583    CADJ &     kind = isbyte
584    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
585    CADJ &     kind = isbyte
586    c
587    CADJ STORE rstarFacC    = comlev1, key = ikey_dynamics,
588    CADJ &     kind = isbyte
589    CADJ STORE rstarFacS    = comlev1, key = ikey_dynamics,
590    CADJ &     kind = isbyte
591    CADJ STORE rstarFacW    = comlev1, key = ikey_dynamics,
592    CADJ &     kind = isbyte
593    c
594    CADJ STORE h0facc,h0facs,h0facw  = comlev1, key = ikey_dynamics,
595    CADJ &     kind = isbyte
596    # endif
597            CALL TIMER_START('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
598          CALL UPDATE_R_STAR( myTime, myIter, myThid )          CALL UPDATE_R_STAR( myTime, myIter, myThid )
599          CALL TIMER_STOP ('UPDATE_R_STAR      [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_R_STAR       [FORWARD_STEP]',myThid)
600    # ifdef ALLOW_AUTODIFF_TAMC
601    CADJ STORE hFacC    = comlev1, key = ikey_dynamics,
602    CADJ &     kind = isbyte
603    CADJ STORE hFacS    = comlev1, key = ikey_dynamics,
604    CADJ &     kind = isbyte
605    CADJ STORE hFacW    = comlev1, key = ikey_dynamics,
606    CADJ &     kind = isbyte
607    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
608    CADJ &     kind = isbyte
609    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
610    CADJ &     kind = isbyte
611    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
612    CADJ &     kind = isbyte
613    # endif
614    # endif /* DISABLE_RSTAR_CODE */
615         ELSE         ELSE
616          CALL TIMER_START('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)  #ifdef ALLOW_AUTODIFF_TAMC
617    CADJ STORE hFac_surfC, hFac_surfS, hFac_surfW
618    CADJ &     = comlev1, key = ikey_dynamics,
619    CADJ &     kind = isbyte
620    #endif
621            CALL TIMER_START('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
622          CALL UPDATE_SURF_DR( myTime, myIter, myThid )          CALL UPDATE_SURF_DR( myTime, myIter, myThid )
623          CALL TIMER_STOP ('UPDATE_SURF_DR     [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_SURF_DR      [FORWARD_STEP]',myThid)
624         ENDIF         ENDIF
625        ENDIF        ENDIF
626    # ifdef ALLOW_AUTODIFF_TAMC
627    CADJ STORE hFacC    = comlev1, key = ikey_dynamics,
628    CADJ &     kind = isbyte
629    CADJ STORE hFacS    = comlev1, key = ikey_dynamics,
630    CADJ &     kind = isbyte
631    CADJ STORE hFacW    = comlev1, key = ikey_dynamics,
632    CADJ &     kind = isbyte
633    CADJ STORE recip_hFacC    = comlev1, key = ikey_dynamics,
634    CADJ &     kind = isbyte
635    CADJ STORE recip_hFacS    = comlev1, key = ikey_dynamics,
636    CADJ &     kind = isbyte
637    CADJ STORE recip_hFacW    = comlev1, key = ikey_dynamics,
638    CADJ &     kind = isbyte
639    # endif
640  C-    update also CG2D matrix (and preconditioner)  C-    update also CG2D matrix (and preconditioner)
641        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN        IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN
642          CALL TIMER_START('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_START('UPDATE_CG2D         [FORWARD_STEP]',myThid)
643          CALL UPDATE_CG2D( myTime, myIter, myThid )          CALL UPDATE_CG2D( myTime, myIter, myThid )
644          CALL TIMER_STOP ('UPDATE_CG2D        [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('UPDATE_CG2D         [FORWARD_STEP]',myThid)
645        ENDIF        ENDIF
646  #endif  #endif /* NONLIN_FRSURF */
647    
648  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE  C--   Apply Filters to u*,v* before SOLVE_FOR_PRESSURE
649  #ifdef ALLOW_SHAP_FILT  #ifdef ALLOW_SHAP_FILT
# Line 500  C      => Filtering of uVel,vVel is nece Line 670  C      => Filtering of uVel,vVel is nece
670          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )          CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid )
671          CALL TIMER_STOP ('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('ZONAL_FILT_UV       [FORWARD_STEP]',myThid)
672        ENDIF        ENDIF
673  #endif    #endif
674    
675  C--   Solve elliptic equation(s).  C--   Solve elliptic equation(s).
676  C     Two-dimensional only for conventional hydrostatic or  C     Two-dimensional only for conventional hydrostatic or
677  C     three-dimensional for non-hydrostatic and/or IGW scheme.  C     three-dimensional for non-hydrostatic and/or IGW scheme.
 #ifndef ALLOW_OFFLINE  
678        IF ( momStepping ) THEN        IF ( momStepping ) THEN
679    #ifdef ALLOW_AUTODIFF_TAMC
680    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
681    CADJ STORE uvel, vvel
682    CADJ &     = comlev1, key = ikey_dynamics,
683    CADJ &     kind = isbyte
684    CADJ STORE empmr,hfacs,hfacw
685    CADJ &     = comlev1, key = ikey_dynamics,
686    CADJ &     kind = isbyte
687    # endif
688    #endif
689          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_START('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
690          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)          CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid)
691          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('SOLVE_FOR_PRESSURE  [FORWARD_STEP]',myThid)
692        ENDIF        ENDIF
 #endif  
693    
694  C--   Correct divergence in flow field and cycle time-stepping momentum  C--   Correct divergence in flow field and cycle time-stepping momentum
695  c     IF ( momStepping ) THEN  #ifndef ALLOW_AUTODIFF_TAMC
696  #ifndef ALLOW_OFFLINE        IF ( momStepping ) THEN
697    #endif
698    #ifdef ALLOW_AUTODIFF_TAMC
699    # if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
700    #  ifndef DISABLE_RSTAR_CODE
701    cph-test
702    cph not clear, why this one
703    CADJ STORE h0facc = comlev1, key = ikey_dynamics,
704    CADJ &     kind = isbyte
705    #  endif
706    # endif
707    # ifdef ALLOW_DEPTH_CONTROL
708    CADJ STORE etan, uvel,vvel
709    CADJ &     = comlev1, key = ikey_dynamics
710    # endif
711    #endif
712          CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)          CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
713          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)          CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid)
714          CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid)
715    #ifndef ALLOW_AUTODIFF_TAMC
716          ENDIF
717  #endif  #endif
 c     ENDIF  
718    
719  #ifdef EXACT_CONSERV  #ifdef EXACT_CONSERV
720        IF (exactConserv) THEN        IF (exactConserv) THEN
721  C--   Update etaH(n+1) :  C--   Update etaH(n+1) :
722          CALL TIMER_START('UPDATE_ETAH         [FORWARD_STEP]',mythid)          CALL TIMER_START('UPDATE_ETAH         [FORWARD_STEP]',myThid)
723          CALL UPDATE_ETAH( myTime, myIter, myThid )          CALL UPDATE_ETAH( myTime, myIter, myThid )
724          CALL TIMER_STOP ('UPDATE_ETAH         [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('UPDATE_ETAH         [FORWARD_STEP]',myThid)
725        ENDIF        ENDIF
726  #endif /* EXACT_CONSERV */  #endif /* EXACT_CONSERV */
727    
728  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
729        IF ( select_rStar.NE.0 ) THEN        IF ( select_rStar.NE.0 ) THEN
730  C--   r* : compute the future level thickness according to etaH(n+1)  # ifndef DISABLE_RSTAR_CODE
731          CALL TIMER_START('CALC_R_STAR       [FORWARD_STEP]',mythid)  #  ifdef ALLOW_AUTODIFF_TAMC
732    cph-test
733    CADJ STORE rstarfacc,rstarfacs,rstarfacw = comlev1, key = ikey_dynamics,
734    CADJ &     kind = isbyte
735    #  endif
736    C--   r* : compute the future level thickness according to etaH(n+1)
737            CALL TIMER_START('CALC_R_STAR         [FORWARD_STEP]',myThid)
738          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )          CALL CALC_R_STAR(etaH, myTime, myIter, myThid )
739          CALL TIMER_STOP ('CALC_R_STAR       [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_R_STAR         [FORWARD_STEP]',myThid)
740    # endif /* DISABLE_RSTAR_CODE */
741        ELSEIF ( nonlinFreeSurf.GT.0) THEN        ELSEIF ( nonlinFreeSurf.GT.0) THEN
742  C--   compute the future surface level thickness according to etaH(n+1)  C--   compute the future surface level thickness according to etaH(n+1)
743          CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',mythid)  # ifdef ALLOW_AUTODIFF_TAMC
744    CADJ STORE etaH          = comlev1, key = ikey_dynamics,
745    CADJ &     kind = isbyte
746    # endif
747            CALL TIMER_START('CALC_SURF_DR      [FORWARD_STEP]',myThid)
748          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )          CALL CALC_SURF_DR(etaH, myTime, myIter, myThid )
749          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('CALC_SURF_DR      [FORWARD_STEP]',myThid)
750        ENDIF        ENDIF
751    # ifdef ALLOW_AUTODIFF_TAMC
752    CADJ STORE hFac_surfC       = comlev1, key = ikey_dynamics,
753    CADJ &     kind = isbyte
754    CADJ STORE salt,theta,vvel  = comlev1, key = ikey_dynamics,
755    CADJ &     kind = isbyte
756    # endif
757  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
758    
759  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
# Line 550  C---+----1----+----2----+----3----+----4 Line 761  C---+----1----+----2----+----3----+----4
761  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 :
762  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
763          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
764       &    CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)       &   CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid)
765  #endif  #endif
766          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_START('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
767          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )          CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid )
768          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
769    
770    #ifdef ALLOW_DIAGNOSTICS
771  C--   State-variables diagnostics  C--   State-variables diagnostics
772         IF ( usediagnostics ) THEN          IF ( useDiagnostics ) THEN
773          CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)            CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
774          CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid )            CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid )
775          CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)            CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
776         ENDIF          ENDIF
777    #endif
778    
779  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
780          IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
781       &    CALL DEBUG_CALL('THERMODYNAMICS',myThid)       &   CALL DEBUG_CALL('THERMODYNAMICS',myThid)
782  #endif  #endif
783          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_START('THERMODYNAMICS      [FORWARD_STEP]',myThid)
784          CALL THERMODYNAMICS( myTime, myIter, myThid )          CALL THERMODYNAMICS( myTime, myIter, myThid )
785          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',mythid)          CALL TIMER_STOP ('THERMODYNAMICS      [FORWARD_STEP]',myThid)
786    
787  C--    if staggerTimeStep: end  C--    if staggerTimeStep: end
788        ENDIF        ENDIF
789  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+--------+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
790    
791  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
792  cph This is needed because convective_adjustment calls  cph This is needed because convective_adjustment calls
793  cph find_rho which may use pressure()  cph find_rho which may use pressure()
794  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics  CADJ STORE totphihyd  = comlev1, key = ikey_dynamics,
795    CADJ &     kind = isbyte
796  #endif  #endif
797  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)  C--   Cycle time-stepping Tracers arrays (T,S,+pTracers)
798          CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)        CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
799          CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)        CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid)
800          CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid)
801    
802  #ifdef ALLOW_GCHEM  #ifdef ALLOW_GCHEM
803  C     Add separate timestepping of chemical/biological/forcing  C     Add separate timestepping of chemical/biological/forcing
804  C     of ptracers here in GCHEM_FORCING_SEP  C     of ptracers here in GCHEM_FORCING_SEP
805          IF ( useGCHEM ) THEN  #ifdef ALLOW_AUTODIFF_TAMC
806    CADJ STORE ptracer  = comlev1, key = ikey_dynamics,
807    CADJ &     kind = isbyte
808    CADJ STORE theta  = comlev1, key = ikey_dynamics,
809    CADJ &     kind = isbyte
810    CADJ STORE salt  = comlev1, key = ikey_dynamics,
811    CADJ &     kind = isbyte
812    #endif
813          IF ( useGCHEM ) THEN
814  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
815           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
816       &        CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid)       &    CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid)
817  #endif /* ALLOW_DEBUG */  #endif /* ALLOW_DEBUG */
818           CALL TIMER_START('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)           CALL TIMER_START('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
819           CALL GCHEM_FORCING_SEP( myTime,myIter,myThid )           CALL GCHEM_FORCING_SEP( myTime,myIter,myThid )
820           CALL TIMER_STOP ('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)           CALL TIMER_STOP ('GCHEM_FORCING_SEP  [FORWARD_STEP]',myThid)
821          ENDIF          ENDIF
822  #endif /* ALLOW_GCHEM */  #endif /* ALLOW_GCHEM */
823    
824  C--   Do "blocking" sends and receives for tendency "overlap" terms  C--   Do "blocking" sends and receives for tendency "overlap" terms
# Line 609  C--   Do "blocking" sends and receives f Line 831  C--   Do "blocking" sends and receives f
831        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )        CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid )
832        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('BLOCKING_EXCHANGES  [FORWARD_STEP]',myThid)
833    
834    #ifdef ALLOW_DIAGNOSTICS
835          IF ( useDiagnostics ) THEN
836           CALL TIMER_START('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
837           CALL DO_STATEVARS_DIAGS( myTime, 2, myIter, myThid )
838           CALL TIMER_STOP ('DO_STATEVARS_DIAGS  [FORWARD_STEP]',myThid)
839          ENDIF
840    #endif
841    
 C AMM  
842  #ifdef ALLOW_GRIDALT  #ifdef ALLOW_GRIDALT
843          if (useGRIDALT) then        IF (useGRIDALT) THEN
844           CALL GRIDALT_UPDATE(myThid)           CALL GRIDALT_UPDATE(myThid)
845          endif        ENDIF
846  #endif  #endif
 C AMM  
847    
 C AMM  
848  #ifdef ALLOW_FIZHI  #ifdef ALLOW_FIZHI
849          if( useFIZHI) then        IF (useFIZHI) THEN
850           CALL TIMER_START('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_START('FIZHI               [FORWARD_STEP]',myThid)
851           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid )           CALL STEP_FIZHI_CORR ( myTime, myIter, myThid, dTtracerLev(1) )
852           CALL TIMER_STOP('FIZHI               [FORWARD_STEP]',mythid)           CALL TIMER_STOP ('FIZHI               [FORWARD_STEP]',myThid)
853          endif        ENDIF
854  #endif  #endif
 C AMM  
855    
856  #ifdef ALLOW_FLT  #ifdef ALLOW_FLT
857  C--   Calculate float trajectories  C--   Calculate float trajectories
858        IF (useFLT) THEN        IF (useFLT) THEN
859          CALL TIMER_START('FLOATS            [FORWARD_STEP]',myThid)          CALL TIMER_START('FLOATS            [FORWARD_STEP]',myThid)
860          CALL FLT_MAIN(myIter,myTime, myThid)          CALL FLT_MAIN( myTime, myIter, myThid )
861          CALL TIMER_STOP ('FLOATS            [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('FLOATS            [FORWARD_STEP]',myThid)
862        ENDIF        ENDIF
863  #endif  #endif
864    
865    #ifdef ALLOW_TIMEAVE
866  C--   State-variables time-averaging  C--   State-variables time-averaging
867        CALL TIMER_START('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
868        CALL DO_STATEVARS_TAVE( myTime, myIter, myThid )        CALL DO_STATEVARS_TAVE( myTime, myIter, myThid )
869        CALL TIMER_STOP ('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('DO_STATEVARS_TAVE   [FORWARD_STEP]',myThid)
870    #endif
871    
 #ifndef ALLOW_OFFLINE  
872  #ifdef ALLOW_MONITOR  #ifdef ALLOW_MONITOR
873          IF ( .NOT.useOffLine ) THEN
874  C--   Check status of solution (statistics, cfl, etc...)  C--   Check status of solution (statistics, cfl, etc...)
875        CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_START('MONITOR             [FORWARD_STEP]',myThid)
876        CALL MONITOR( myIter, myTime, myThid )          CALL MONITOR( myIter, myTime, myThid )
877        CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)          CALL TIMER_STOP ('MONITOR             [FORWARD_STEP]',myThid)
878          ENDIF
879  #endif /* ALLOW_MONITOR */  #endif /* ALLOW_MONITOR */
 #endif  
880    
881  #ifdef ALLOW_COST  #ifdef ALLOW_COST
882  C--     compare model with data and compute cost function  C--     compare model with data and compute cost function
883  C--     this is done after exchanges to allow interpolation  C--     this is done after exchanges to allow interpolation
884        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_START('COST_TILE           [FORWARD_STEP]',myThid)
885        CALL COST_TILE  ( mytime, myiter, myThid )        CALL COST_TILE  ( myTime, myIter, myThid )
886        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('COST_TILE           [FORWARD_STEP]',myThid)
887  #endif  #endif
888    
889  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  
890        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
891        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )        CALL DO_THE_MODEL_IO( myTime, myIter, myThid )
892        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)        CALL TIMER_STOP ('DO_THE_MODEL_IO     [FORWARD_STEP]',myThid)
893  #endif  
894          modelEnd = myTime.EQ.endTime .OR. myIter.EQ.nEndIter
895    #ifdef HAVE_SIGREG
896          IF ( useSIGREG ) THEN
897            modelEnd = modelEnd .OR. ( i_got_signal.GT.0 )
898          ENDIF
899    #endif /* HAVE_SIGREG */
900    
901  C--   Save state for restarts  C--   Save state for restarts
902        CALL TIMER_START('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)        CALL TIMER_START('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
903        CALL PACKAGES_WRITE_PICKUP(        CALL DO_WRITE_PICKUP(
904       I               .FALSE., myTime, myIter, myThid )       I                      modelEnd, myTime, myIter, myThid )
905  #ifndef ALLOW_OFFLINE        CALL TIMER_STOP ('DO_WRITE_PICKUP     [FORWARD_STEP]',myThid)
906        CALL WRITE_CHECKPOINT(  
907       I               .FALSE., myTime, myIter, myThid )    #ifdef HAVE_SIGREG
908          IF ( useSIGREG ) THEN
909            IF ( modelEnd .AND. i_got_signal.GT.0 ) THEN
910              STOP 'Checkpoint completed -- killed by signal handler'
911            ENDIF
912          ENDIF
913    #endif /* HAVE_SIGREG */
914    
915    #ifdef ALLOW_AUTODIFF_TAMC
916          CALL AUTODIFF_INADMODE_SET( myThid )
917    #endif
918    
919    #ifdef ALLOW_SHOWFLOPS
920          CALL TIMER_START('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
921          CALL SHOWFLOPS_INLOOP( iloop, mythid )
922          CALL TIMER_STOP ('SHOWFLOPS_INLOOP   [THE_MAIN_LOOP]', mythid)
923  #endif  #endif
       CALL TIMER_STOP ('WRITE_CHECKPOINT    [FORWARD_STEP]',myThid)  
924    
925  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
926        IF ( debugLevel .GE. debLevB )        IF ( debugLevel .GE. debLevB )
927       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)
928  #endif  #endif
929    
Legend:
Removed from v.1.123  
changed lines
  Added in v.1.165
  ViewVC Help
Powered by ViewVC 1.1.22