1 |
C $Header$ |
C $Header$ |
2 |
C $Name$ |
C $Name$ |
3 |
|
|
4 |
|
#include "PACKAGES_CONFIG.h" |
5 |
#include "CPP_OPTIONS.h" |
#include "CPP_OPTIONS.h" |
6 |
|
|
7 |
|
#ifdef ALLOW_GMREDI |
8 |
|
# include "GMREDI_OPTIONS.h" |
9 |
|
#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 |
18 |
|
C !ROUTINE: FORWARD_STEP |
19 |
|
C !INTERFACE: |
20 |
SUBROUTINE FORWARD_STEP( iloop, myTime, myIter, myThid ) |
SUBROUTINE FORWARD_STEP( iloop, myTime, myIter, myThid ) |
|
IMPLICIT NONE |
|
21 |
|
|
22 |
c ================================================================== |
C !DESCRIPTION: \bv |
23 |
c SUBROUTINE forward_step |
C *================================================================== |
24 |
c ================================================================== |
C | SUBROUTINE forward_step |
25 |
c |
C | o Run the ocean model and, optionally, evaluate a cost function. |
26 |
c o Run the ocean model and evaluate the specified cost function. |
C *================================================================== |
27 |
c |
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 | |
35 |
|
C *================================================================== |
36 |
|
C \ev |
37 |
|
|
38 |
C == global variables == |
C !USES: |
39 |
|
IMPLICIT NONE |
40 |
|
C == Global variables == |
41 |
#include "SIZE.h" |
#include "SIZE.h" |
42 |
#include "EEPARAMS.h" |
#include "EEPARAMS.h" |
43 |
#include "PARAMS.h" |
#include "PARAMS.h" |
44 |
#include "DYNVARS.h" |
#include "DYNVARS.h" |
|
#include "FFIELDS.h" |
|
|
#include "TR1.h" |
|
45 |
|
|
46 |
#ifdef ALLOW_NONHYDROSTATIC |
#ifdef ALLOW_MNC |
47 |
#include "CG3D.h" |
#include "MNC_PARAMS.h" |
48 |
|
#endif |
49 |
|
|
50 |
|
#ifdef HAVE_SIGREG |
51 |
|
#include "SIGREG.h" |
52 |
|
#endif |
53 |
|
|
54 |
|
#ifdef ALLOW_SHAP_FILT |
55 |
|
# include "SHAP_FILT.h" |
56 |
|
#endif |
57 |
|
#ifdef ALLOW_ZONAL_FILT |
58 |
|
# include "ZONAL_FILT.h" |
59 |
|
#endif |
60 |
|
#ifdef COMPONENT_MODULE |
61 |
|
# include "CPL_PARAMS.h" |
62 |
#endif |
#endif |
63 |
|
|
64 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
65 |
#include "tamc.h" |
# include "FFIELDS.h" |
66 |
#include "ctrl.h" |
# include "SURFACE.h" |
67 |
#include "ctrl_dummy.h" |
|
68 |
#include "cost.h" |
# include "tamc.h" |
69 |
|
# include "ctrl.h" |
70 |
|
# include "ctrl_dummy.h" |
71 |
|
# include "cost.h" |
72 |
|
# include "EOS.h" |
73 |
|
# if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL) |
74 |
|
# include "GRID.h" |
75 |
|
# endif |
76 |
|
# ifdef ALLOW_EXF |
77 |
|
# include "EXF_FIELDS.h" |
78 |
|
# ifdef ALLOW_BULKFORMULAE |
79 |
|
# include "EXF_CONSTANTS.h" |
80 |
|
# endif |
81 |
|
# endif |
82 |
|
# ifdef ALLOW_PTRACERS |
83 |
|
# include "PTRACERS_SIZE.h" |
84 |
|
# include "PTRACERS_FIELDS.h" |
85 |
|
# endif |
86 |
|
# ifdef ALLOW_GCHEM |
87 |
|
# include "GCHEM_FIELDS.h" |
88 |
|
# endif |
89 |
|
# ifdef ALLOW_CFC |
90 |
|
# include "CFC.h" |
91 |
|
# endif |
92 |
|
# ifdef ALLOW_DIC |
93 |
|
# include "DIC_VARS.h" |
94 |
|
# include "DIC_LOAD.h" |
95 |
|
# include "DIC_ATMOS.h" |
96 |
|
# endif |
97 |
|
# ifdef ALLOW_OBCS |
98 |
|
# include "OBCS.h" |
99 |
|
# ifdef ALLOW_PTRACERS |
100 |
|
# include "OBCS_PTRACERS.h" |
101 |
|
# endif |
102 |
|
# endif |
103 |
|
# ifdef ALLOW_CD_CODE |
104 |
|
# include "CD_CODE_VARS.h" |
105 |
|
# endif |
106 |
|
# ifdef ALLOW_THSICE |
107 |
|
# include "THSICE_VARS.h" |
108 |
|
# endif |
109 |
|
# ifdef ALLOW_SEAICE |
110 |
|
# include "SEAICE.h" |
111 |
|
# endif |
112 |
|
# ifdef ALLOW_SALT_PLUME |
113 |
|
# include "SALT_PLUME.h" |
114 |
|
# endif |
115 |
|
# ifdef ALLOW_EBM |
116 |
|
# include "EBM.h" |
117 |
|
# endif |
118 |
|
# ifdef ALLOW_KPP |
119 |
|
# include "KPP.h" |
120 |
|
# endif |
121 |
|
# ifdef ALLOW_GMREDI |
122 |
|
# include "GMREDI.h" |
123 |
|
# endif |
124 |
|
# ifdef ALLOW_RBCS |
125 |
|
# include "RBCS.h" |
126 |
|
# endif |
127 |
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
128 |
|
|
129 |
|
#ifdef ALLOW_MNC |
130 |
|
EXTERNAL DIFFERENT_MULTIPLE |
131 |
|
LOGICAL DIFFERENT_MULTIPLE |
132 |
#endif |
#endif |
133 |
|
|
134 |
C == routine arguments == |
|
135 |
C note: under the multi-threaded model myiter and |
C !INPUT/OUTPUT PARAMETERS: |
136 |
C mytime are local variables passed around as routine |
C == Routine arguments == |
137 |
C arguments. Although this is fiddly it saves the need to |
C note: under the multi-threaded model myIter and |
138 |
C impose additional synchronisation points when they are |
C myTime are local variables passed around as routine |
139 |
|
C arguments. Although this is fiddly it saves the need to |
140 |
|
C impose additional synchronisation points when they are |
141 |
C updated. |
C updated. |
142 |
C myiter - iteration counter for this thread |
C myTime :: time counter for this thread |
143 |
C mytime - time counter for this thread |
C myIter :: iteration counter for this thread |
144 |
C mythid - thread number for this instance of the routine. |
C myThid :: thread number for this instance of the routine. |
145 |
integer iloop |
INTEGER iloop |
146 |
integer mythid |
_RL myTime |
147 |
integer myiter |
INTEGER myIter |
148 |
_RL mytime |
INTEGER myThid |
149 |
|
|
150 |
C == local variables == |
C !LOCAL VARIABLES: |
151 |
|
C == Local variables == |
152 |
|
C modelEnd :: true if reaching the end of the run |
153 |
|
LOGICAL modelEnd |
154 |
|
#ifdef COMPONENT_MODULE |
155 |
|
INTEGER myItP1 |
156 |
|
#endif |
157 |
|
CEOP |
158 |
|
|
159 |
|
#ifdef ALLOW_DEBUG |
160 |
|
IF ( debugLevel .GE. debLevB ) |
161 |
|
& CALL DEBUG_ENTER('FORWARD_STEP',myThid) |
162 |
|
#endif |
163 |
|
|
164 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
165 |
C-- Set the model iteration counter and the model time. |
CALL AUTODIFF_INADMODE_UNSET( myThid ) |
166 |
myiter = nIter0 + (iloop-1) |
#endif |
167 |
mytime = startTime + float(iloop-1)*deltaTclock |
|
168 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
169 |
C Include call to a dummy routine. Its adjoint will be |
C-- Reset the model iteration counter and the model time. |
170 |
C called at the proper place in the adjoint code. |
myIter = nIter0 + (iloop-1) |
171 |
C The adjoint routine will print out adjoint values |
myTime = startTime + float(iloop-1)*deltaTclock |
172 |
C if requested. The location of the call is important, |
#endif |
173 |
C it has to be after the adjoint of the exchanges |
|
174 |
C (DO_GTERM_BLOCKING_EXCHANGES). |
#ifdef ALLOW_AUTODIFF_TAMC |
175 |
CALL DUMMY_IN_STEPPING( myTime, myIter, myThid ) |
c************************************** |
176 |
#endif |
#include "checkpoint_lev1_directives.h" |
177 |
|
#include "checkpoint_lev1_template.h" |
178 |
C-- Load forcing/external data fields. |
c************************************** |
179 |
#ifdef INCLUDE_EXTERNAL_FORCING_PACKAGE |
#endif |
180 |
C NOTE, that although the exf package is part of the |
|
181 |
C distribution, it is not currently maintained, i.e. |
C-- Switch on/off diagnostics for snap-shot output: |
182 |
C exf is disabled by default in genmake. |
#ifdef ALLOW_DIAGNOSTICS |
183 |
CALL EXF_GETFORCING( mytime, myiter, mythid ) |
IF ( useDiagnostics ) THEN |
184 |
#else |
CALL DIAGNOSTICS_SWITCH_ONOFF( myTime, myIter, myThid ) |
185 |
CALL TIMER_START('EXTERNAL_FIELDS_LOAD[THE_MAIN_LOOP]',mythid) |
C-- State-variables diagnostics |
186 |
CALL EXTERNAL_FIELDS_LOAD( mytime, myiter, mythid ) |
CALL TIMER_START('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid) |
187 |
CALL TIMER_STOP ('EXTERNAL_FIELDS_LOAD[THE_MAIN_LOOP]',mythid) |
CALL DO_STATEVARS_DIAGS( myTime, 0, myIter, myThid ) |
188 |
|
CALL TIMER_STOP ('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid) |
189 |
|
ENDIF |
190 |
#endif |
#endif |
191 |
|
|
192 |
|
#ifdef ALLOW_PROFILES |
193 |
|
#ifdef ALLOW_DEBUG |
194 |
|
IF (debugMode) CALL DEBUG_CALL('',myThid) |
195 |
|
#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 |
201 |
|
|
202 |
|
C-- Call driver to load external forcing fields from file |
203 |
|
#ifdef ALLOW_DEBUG |
204 |
|
IF ( debugLevel .GE. debLevB ) |
205 |
|
& CALL DEBUG_CALL('LOAD_FIELDS_DRIVER',myThid) |
206 |
|
#endif |
207 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
208 |
|
cph Important STORE that avoids hidden recomp. of load_fields_driver |
209 |
|
CADJ STORE theta = comlev1, key = ikey_dynamics, |
210 |
|
CADJ & kind = isbyte |
211 |
|
CADJ STORE uvel, vvel = comlev1, key = ikey_dynamics, |
212 |
|
CADJ & kind = isbyte |
213 |
|
#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 |
220 |
|
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 |
230 |
|
#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 |
248 |
|
c-- Add control vector for forcing and parameter fields |
249 |
|
IF ( myIter .EQ. nIter0 ) |
250 |
|
& CALL CTRL_MAP_FORCING (myThid) |
251 |
|
#endif |
252 |
|
|
253 |
|
#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR)) |
254 |
|
CALL DUMMY_IN_STEPPING( myTime, myIter, myThid ) |
255 |
|
#endif |
256 |
|
|
257 |
|
#ifdef COMPONENT_MODULE |
258 |
|
IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN |
259 |
|
C Post coupling data that I export. |
260 |
|
C Read in coupling data that I import. |
261 |
|
CALL TIMER_START('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
262 |
|
CALL CPL_EXPORT_MY_DATA( myIter, myTime, myThid ) |
263 |
|
CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid ) |
264 |
|
CALL TIMER_STOP ('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
265 |
|
ENDIF |
266 |
|
#endif /* COMPONENT_MODULE */ |
267 |
|
|
268 |
|
#ifdef ALLOW_EBM |
269 |
|
IF ( useEBM ) THEN |
270 |
|
# ifdef ALLOW_DEBUG |
271 |
|
IF ( debugLevel .GE. debLevB ) |
272 |
|
& CALL DEBUG_CALL('EBM',myThid) |
273 |
|
# endif |
274 |
|
CALL TIMER_START('EBM [FORWARD_STEP]',myThid) |
275 |
|
CALL EBM_DRIVER ( myTime, myIter, myThid ) |
276 |
|
CALL TIMER_STOP ('EBM [FORWARD_STEP]',myThid) |
277 |
|
ENDIF |
278 |
|
#endif /* ALLOW_EBM */ |
279 |
|
|
280 |
C-- Step forward fields and calculate time tendency terms. |
C-- Step forward fields and calculate time tendency terms. |
281 |
CALL TIMER_START('DYNAMICS [THE_MAIN_LOOP]',mythid) |
|
282 |
CALL DYNAMICS( myTime, myIter, myThid ) |
#ifdef ALLOW_DEBUG |
283 |
CALL TIMER_STOP ('DYNAMICS [THE_MAIN_LOOP]',mythid) |
IF ( debugLevel .GE. debLevB ) |
284 |
|
& CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid) |
285 |
|
#endif |
286 |
|
CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid) |
287 |
|
CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid ) |
288 |
|
CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',myThid) |
289 |
|
|
290 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
291 |
|
CADJ STORE surfaceforcingtice = comlev1, key = ikey_dynamics, |
292 |
|
CADJ & kind = isbyte |
293 |
|
# ifdef ALLOW_KPP |
294 |
|
CADJ STORE uvel = comlev1, key = ikey_dynamics, |
295 |
|
CADJ & kind = isbyte |
296 |
|
CADJ STORE vvel = comlev1, key = ikey_dynamics, |
297 |
|
CADJ & kind = isbyte |
298 |
|
# endif |
299 |
|
# ifdef EXACT_CONSERV |
300 |
|
cphCADJ STORE empmr = comlev1, key = ikey_dynamics |
301 |
|
cphCADJ STORE pmepr = comlev1, key = ikey_dynamics |
302 |
|
# endif |
303 |
|
# ifdef ALLOW_PTRACERS |
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 |
316 |
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
317 |
|
|
318 |
#ifndef ALLOW_AUTODIFF_TAMC |
#ifndef ALLOW_AUTODIFF_TAMC |
319 |
#ifdef ALLOW_NONHYDROSTATIC |
IF ( .NOT. useOffLine ) THEN |
320 |
C-- Step forward W field in N-H algorithm |
#endif |
321 |
IF ( nonHydrostatic ) THEN |
#ifdef ALLOW_DEBUG |
322 |
CALL TIMER_START('CALC_GW [THE_MAIN_LOOP]',myThid) |
IF ( debugLevel .GE. debLevB ) |
323 |
CALL CALC_GW(myThid) |
& CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid) |
324 |
CALL TIMER_STOP ('CALC_GW [THE_MAIN_LOOP]',myThid) |
#endif |
325 |
ENDIF |
CALL TIMER_START('DO_OCEANIC_PHYS [FORWARD_STEP]',myThid) |
326 |
|
CALL DO_OCEANIC_PHYS( myTime, myIter, myThid ) |
327 |
|
CALL TIMER_STOP ('DO_OCEANIC_PHYS [FORWARD_STEP]',myThid) |
328 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
329 |
|
CADJ STORE EmPmR = comlev1, key = ikey_dynamics, |
330 |
|
CADJ & kind = isbyte |
331 |
|
# ifdef EXACT_CONSERV |
332 |
|
CADJ STORE pmepr = comlev1, key = ikey_dynamics, |
333 |
|
CADJ & kind = isbyte |
334 |
|
# endif |
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 */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
363 |
|
|
364 |
C-- This block has been moved to the_correction_step(). We have |
#ifdef ALLOW_GCHEM |
365 |
C left this code here to indicate where the filters used to be |
#ifdef ALLOW_AUTODIFF_TAMC |
366 |
C in the algorithm before JMC moved them to after the pressure |
CADJ STORE ptracer = comlev1, key = ikey_dynamics, |
367 |
C solver. |
CADJ & kind = isbyte |
368 |
C |
CADJ STORE theta = comlev1, key = ikey_dynamics, |
369 |
C#ifdef ALLOW_SHAP_FILT |
CADJ & kind = isbyte |
370 |
CC-- Step forward all tiles, filter and exchange. |
CADJ STORE salt = comlev1, key = ikey_dynamics, |
371 |
C CALL TIMER_START('SHAP_FILT [THE_MAIN_LOOP]',myThid) |
CADJ & kind = isbyte |
372 |
C CALL SHAP_FILT_APPLY( |
#endif |
373 |
C I gUnm1, gVnm1, gTnm1, gSnm1, |
IF ( useGCHEM ) THEN |
374 |
C I myTime, myIter, myThid ) |
#ifdef ALLOW_DEBUG |
375 |
C IF (implicDiv2Dflow.LT.1.) THEN |
IF ( debugLevel .GE. debLevB ) |
376 |
CC-- Explicit+Implicit part of the Barotropic Flow Divergence |
& CALL DEBUG_CALL('GCHEM_CALC_TENDENCY',myThid) |
377 |
CC => Filtering of uVel,vVel is necessary |
#endif |
378 |
C CALL SHAP_FILT_UV( uVel, vVel, myTime, myThid ) |
CALL TIMER_START('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid) |
379 |
C ENDIF |
CALL GCHEM_CALC_TENDENCY( myTime, myIter, myThid ) |
380 |
C CALL TIMER_STOP ('SHAP_FILT [THE_MAIN_LOOP]',myThid) |
CALL TIMER_STOP ('GCHEM_CALC_TENDENCY [FORWARD_STEP]',myThid) |
381 |
C#endif |
ENDIF |
382 |
C |
#endif /* ALLOW_GCHEM */ |
|
C#ifdef ALLOW_ZONAL_FILT |
|
|
C IF (zonal_filt_lat.LT.90.) THEN |
|
|
C CALL TIMER_START('ZONAL_FILT_APPLY [THE_MAIN_LOOP]',myThid) |
|
|
C CALL ZONAL_FILT_APPLY( |
|
|
C U gUnm1, gVnm1, gTnm1, gSnm1, |
|
|
C I myThid ) |
|
|
C CALL TIMER_STOP ('ZONAL_FILT_APPLY [THE_MAIN_LOOP]',myThid) |
|
|
C ENDIF |
|
|
C#endif |
|
383 |
|
|
384 |
C-- Solve elliptic equation(s). |
#ifdef ALLOW_AUTODIFF_TAMC |
385 |
C Two-dimensional only for conventional hydrostatic or |
cph needed to be moved here from do_oceanic_physics |
386 |
C three-dimensional for non-hydrostatic and/or IGW scheme. |
cph to be visible down the road |
387 |
CALL TIMER_START('SOLVE_FOR_PRESSURE [THE_MAIN_LOOP]',myThid) |
c |
388 |
CALL SOLVE_FOR_PRESSURE( myThid ) |
CADJ STORE rhoInSitu = comlev1, key = ikey_dynamics, |
389 |
CALL TIMER_STOP ('SOLVE_FOR_PRESSURE [THE_MAIN_LOOP]',myThid) |
CADJ & kind = isbyte |
390 |
|
CADJ STORE surfaceForcingS = comlev1, key = ikey_dynamics, |
391 |
|
CADJ & kind = isbyte |
392 |
|
CADJ STORE surfaceForcingT = comlev1, key = ikey_dynamics, |
393 |
|
CADJ & kind = isbyte |
394 |
|
CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics, |
395 |
|
CADJ & kind = isbyte |
396 |
|
CADJ STORE IVDConvCount = comlev1, key = ikey_dynamics, |
397 |
|
CADJ & kind = isbyte |
398 |
|
# ifdef ALLOW_PTRACERS |
399 |
|
CADJ STORE surfaceForcingPTr = comlev1, key = ikey_dynamics, |
400 |
|
CADJ & kind = isbyte |
401 |
|
# endif |
402 |
|
c |
403 |
|
# ifdef ALLOW_GMREDI |
404 |
|
CADJ STORE Kwx = comlev1, key = ikey_dynamics, |
405 |
|
CADJ & kind = isbyte |
406 |
|
CADJ STORE Kwy = comlev1, key = ikey_dynamics, |
407 |
|
CADJ & kind = isbyte |
408 |
|
CADJ STORE Kwz = comlev1, key = ikey_dynamics, |
409 |
|
CADJ & kind = isbyte |
410 |
|
# ifdef GM_BOLUS_ADVEC |
411 |
|
CADJ STORE GM_PsiX = comlev1, key = ikey_dynamics, |
412 |
|
CADJ & kind = isbyte |
413 |
|
CADJ STORE GM_PsiY = comlev1, key = ikey_dynamics, |
414 |
|
CADJ & kind = isbyte |
415 |
|
# endif |
416 |
|
# endif |
417 |
|
c |
418 |
|
# ifdef ALLOW_KPP |
419 |
|
CADJ STORE KPPghat = comlev1, key = ikey_dynamics, |
420 |
|
CADJ & kind = isbyte |
421 |
|
CADJ STORE KPPfrac = comlev1, key = ikey_dynamics, |
422 |
|
CADJ & kind = isbyte |
423 |
|
CADJ STORE KPPdiffKzS = comlev1, key = ikey_dynamics, |
424 |
|
CADJ & kind = isbyte |
425 |
|
CADJ STORE KPPdiffKzT = comlev1, key = ikey_dynamics, |
426 |
|
CADJ & kind = isbyte |
427 |
|
# endif |
428 |
|
c |
429 |
|
# if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL) |
430 |
|
CADJ STORE theta,salt,wvel = comlev1, key = ikey_dynamics, |
431 |
|
CADJ & kind = isbyte |
432 |
|
CADJ STORE etaH = comlev1, key = ikey_dynamics, |
433 |
|
CADJ & kind = isbyte |
434 |
|
# ifdef ALLOW_CD_CODE |
435 |
|
CADJ STORE etanm1 = comlev1, key = ikey_dynamics, |
436 |
|
CADJ & kind = isbyte |
437 |
|
# endif |
438 |
|
# ifndef DISABLE_RSTAR_CODE |
439 |
|
cph-test |
440 |
|
CADJ STORE rstarexpc = comlev1, key = ikey_dynamics, |
441 |
|
CADJ & kind = isbyte |
442 |
|
# endif |
443 |
|
# endif |
444 |
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
445 |
|
|
446 |
C-- Correct divergence in flow field and cycle time-stepping |
IF ( .NOT.staggerTimeStep ) THEN |
447 |
C arrays (for all fields) ; update time-counter |
#ifdef ALLOW_DEBUG |
448 |
|
IF ( debugLevel .GE. debLevB ) |
449 |
|
& CALL DEBUG_CALL('THERMODYNAMICS',myThid) |
450 |
|
#endif |
451 |
|
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 ) |
455 |
|
CALL TIMER_STOP ('THERMODYNAMICS [FORWARD_STEP]',myThid) |
456 |
|
C-- if not staggerTimeStep: end |
457 |
|
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 |
467 |
|
IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN |
468 |
|
C Post coupling data that I export. |
469 |
|
C Read in coupling data that I import. |
470 |
|
myItP1 = myIter + 1 |
471 |
|
CALL TIMER_START('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
472 |
|
CALL CPL_EXPORT_MY_DATA( myItP1, myTime, myThid ) |
473 |
|
CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid ) |
474 |
|
CALL TIMER_STOP ('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
475 |
|
# ifdef ALLOW_OCN_COMPON_INTERF |
476 |
|
IF ( useRealFreshWaterFlux ) THEN |
477 |
|
CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid ) |
478 |
|
ENDIF |
479 |
|
# endif /* ALLOW_OCN_COMPON_INTERF */ |
480 |
|
ENDIF |
481 |
|
#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. |
521 |
|
#ifndef ALLOW_AUTODIFF_TAMC |
522 |
|
IF ( momStepping ) THEN |
523 |
|
#endif |
524 |
|
#ifdef ALLOW_DEBUG |
525 |
|
IF ( debugLevel .GE. debLevB ) |
526 |
|
& CALL DEBUG_CALL('DYNAMICS',myThid) |
527 |
|
#endif |
528 |
|
CALL TIMER_START('DYNAMICS [FORWARD_STEP]',myThid) |
529 |
|
CALL DYNAMICS( myTime, myIter, myThid ) |
530 |
|
CALL TIMER_STOP ('DYNAMICS [FORWARD_STEP]',myThid) |
531 |
|
#ifndef ALLOW_AUTODIFF_TAMC |
532 |
|
ENDIF |
533 |
|
#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 |
541 |
|
|
542 |
|
C-- Update time-counter |
543 |
myIter = nIter0 + iLoop |
myIter = nIter0 + iLoop |
544 |
myTime = startTime + deltaTClock * float(iLoop) |
myTime = startTime + deltaTClock * float(iLoop) |
545 |
CALL TIMER_START('THE_CORRECTION_STEP [THE_MAIN_LOOP]',myThid) |
|
546 |
CALL THE_CORRECTION_STEP(myTime, myIter, myThid) |
#ifdef ALLOW_MNC |
547 |
CALL TIMER_STOP ('THE_CORRECTION_STEP [THE_MAIN_LOOP]',myThid) |
C Update the default next iter for MNC |
548 |
|
IF ( useMNC ) THEN |
549 |
|
CALL MNC_CW_CITER_SETG( 1, 1, -1, myIter , myThid ) |
550 |
|
|
551 |
|
C TODO: Logic should be added here so that users can specify, on |
552 |
|
C a per-citer-group basis, when it is time to update the |
553 |
|
C "current" (and not just the "next") iteration |
554 |
|
|
555 |
|
C TODO: the following is just a temporary band-aid (mostly, for |
556 |
|
C Baylor) until someone writes a routine that better handles time |
557 |
|
C boundaries such as weeks, months, years, etc. |
558 |
|
IF ( mnc_filefreq .GT. 0 ) THEN |
559 |
|
IF (DIFFERENT_MULTIPLE(mnc_filefreq,myTime,deltaTClock)) |
560 |
|
& THEN |
561 |
|
CALL MNC_CW_CITER_SETG( 1, 1, myIter, -1 , myThid ) |
562 |
|
ENDIF |
563 |
|
ENDIF |
564 |
|
ENDIF |
565 |
|
#endif /* ALLOW_MNC */ |
566 |
|
|
567 |
|
C-- Update geometric factors: |
568 |
|
#ifdef NONLIN_FRSURF |
569 |
|
C- update hfacC,W,S and recip_hFac according to etaH(n+1) : |
570 |
|
IF ( nonlinFreeSurf.GT.0) THEN |
571 |
|
IF ( select_rStar.GT.0 ) THEN |
572 |
|
# 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 ) |
599 |
|
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 |
616 |
|
#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 ) |
623 |
|
CALL TIMER_STOP ('UPDATE_SURF_DR [FORWARD_STEP]',myThid) |
624 |
|
ENDIF |
625 |
|
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) |
641 |
|
IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN |
642 |
|
CALL TIMER_START('UPDATE_CG2D [FORWARD_STEP]',myThid) |
643 |
|
CALL UPDATE_CG2D( myTime, myIter, myThid ) |
644 |
|
CALL TIMER_STOP ('UPDATE_CG2D [FORWARD_STEP]',myThid) |
645 |
|
ENDIF |
646 |
|
#endif /* NONLIN_FRSURF */ |
647 |
|
|
648 |
|
C-- Apply Filters to u*,v* before SOLVE_FOR_PRESSURE |
649 |
|
#ifdef ALLOW_SHAP_FILT |
650 |
|
IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN |
651 |
|
CALL TIMER_START('SHAP_FILT_UV [FORWARD_STEP]',myThid) |
652 |
|
IF (implicDiv2Dflow.LT.1.) THEN |
653 |
|
C-- Explicit+Implicit part of the Barotropic Flow Divergence |
654 |
|
C => Filtering of uVel,vVel is necessary |
655 |
|
CALL SHAP_FILT_APPLY_UV( uVel,vVel, |
656 |
|
& myTime, myIter, myThid ) |
657 |
|
ENDIF |
658 |
|
CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid) |
659 |
|
CALL TIMER_STOP ('SHAP_FILT_UV [FORWARD_STEP]',myThid) |
660 |
|
ENDIF |
661 |
|
#endif |
662 |
|
#ifdef ALLOW_ZONAL_FILT |
663 |
|
IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN |
664 |
|
CALL TIMER_START('ZONAL_FILT_UV [FORWARD_STEP]',myThid) |
665 |
|
IF (implicDiv2Dflow.LT.1.) THEN |
666 |
|
C-- Explicit+Implicit part of the Barotropic Flow Divergence |
667 |
|
C => Filtering of uVel,vVel is necessary |
668 |
|
CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid ) |
669 |
|
ENDIF |
670 |
|
CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid ) |
671 |
|
CALL TIMER_STOP ('ZONAL_FILT_UV [FORWARD_STEP]',myThid) |
672 |
|
ENDIF |
673 |
|
#endif |
674 |
|
|
675 |
|
C-- Solve elliptic equation(s). |
676 |
|
C Two-dimensional only for conventional hydrostatic or |
677 |
|
C three-dimensional for non-hydrostatic and/or IGW scheme. |
678 |
|
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) |
690 |
|
CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid) |
691 |
|
CALL TIMER_STOP ('SOLVE_FOR_PRESSURE [FORWARD_STEP]',myThid) |
692 |
|
ENDIF |
693 |
|
|
694 |
|
C-- Correct divergence in flow field and cycle time-stepping momentum |
695 |
|
#ifndef ALLOW_AUTODIFF_TAMC |
696 |
|
IF ( momStepping ) THEN |
697 |
|
#endif |
698 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
699 |
|
# if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL) |
700 |
|
# ifndef DISABLE_RSTAR_CODE |
701 |
|
cph-test |
702 |
|
cph not clear, why this one |
703 |
|
CADJ STORE h0facc = comlev1, key = ikey_dynamics, |
704 |
|
CADJ & kind = isbyte |
705 |
|
# endif |
706 |
|
# endif |
707 |
|
# ifdef ALLOW_DEPTH_CONTROL |
708 |
|
CADJ STORE etan, uvel,vvel |
709 |
|
CADJ & = comlev1, key = ikey_dynamics |
710 |
|
# endif |
711 |
|
#endif |
712 |
|
CALL TIMER_START('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid) |
713 |
|
CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid) |
714 |
|
CALL TIMER_STOP ('MOM_CORRECTION_STEP [FORWARD_STEP]',myThid) |
715 |
|
#ifndef ALLOW_AUTODIFF_TAMC |
716 |
|
ENDIF |
717 |
|
#endif |
718 |
|
|
719 |
|
#ifdef EXACT_CONSERV |
720 |
|
IF (exactConserv) THEN |
721 |
|
C-- Update etaH(n+1) : |
722 |
|
CALL TIMER_START('UPDATE_ETAH [FORWARD_STEP]',myThid) |
723 |
|
CALL UPDATE_ETAH( myTime, myIter, myThid ) |
724 |
|
CALL TIMER_STOP ('UPDATE_ETAH [FORWARD_STEP]',myThid) |
725 |
|
ENDIF |
726 |
|
#endif /* EXACT_CONSERV */ |
727 |
|
|
728 |
|
#ifdef NONLIN_FRSURF |
729 |
|
IF ( select_rStar.NE.0 ) THEN |
730 |
|
# ifndef DISABLE_RSTAR_CODE |
731 |
|
# ifdef ALLOW_AUTODIFF_TAMC |
732 |
|
cph-test |
733 |
|
CADJ STORE rstarfacc,rstarfacs,rstarfacw = comlev1, key = ikey_dynamics, |
734 |
|
CADJ & kind = isbyte |
735 |
|
# endif |
736 |
|
C-- r* : compute the future level thickness according to etaH(n+1) |
737 |
|
CALL TIMER_START('CALC_R_STAR [FORWARD_STEP]',myThid) |
738 |
|
CALL CALC_R_STAR(etaH, myTime, myIter, myThid ) |
739 |
|
CALL TIMER_STOP ('CALC_R_STAR [FORWARD_STEP]',myThid) |
740 |
|
# endif /* DISABLE_RSTAR_CODE */ |
741 |
|
ELSEIF ( nonlinFreeSurf.GT.0) THEN |
742 |
|
C-- compute the future surface level thickness according to etaH(n+1) |
743 |
|
# ifdef ALLOW_AUTODIFF_TAMC |
744 |
|
CADJ STORE etaH = comlev1, key = ikey_dynamics, |
745 |
|
CADJ & kind = isbyte |
746 |
|
# endif |
747 |
|
CALL TIMER_START('CALC_SURF_DR [FORWARD_STEP]',myThid) |
748 |
|
CALL CALC_SURF_DR(etaH, myTime, myIter, myThid ) |
749 |
|
CALL TIMER_STOP ('CALC_SURF_DR [FORWARD_STEP]',myThid) |
750 |
|
ENDIF |
751 |
|
# ifdef ALLOW_AUTODIFF_TAMC |
752 |
|
CADJ STORE hFac_surfC = comlev1, key = ikey_dynamics, |
753 |
|
CADJ & kind = isbyte |
754 |
|
CADJ STORE salt,theta,vvel = comlev1, key = ikey_dynamics, |
755 |
|
CADJ & kind = isbyte |
756 |
|
# endif |
757 |
|
#endif /* NONLIN_FRSURF */ |
758 |
|
|
759 |
|
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
760 |
|
IF ( staggerTimeStep ) THEN |
761 |
|
C-- do exchanges of U,V (needed for multiDim) when using stagger time-step : |
762 |
|
#ifdef ALLOW_DEBUG |
763 |
|
IF ( debugLevel .GE. debLevB ) |
764 |
|
& CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid) |
765 |
|
#endif |
766 |
|
CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
767 |
|
CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid ) |
768 |
|
CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
769 |
|
|
770 |
|
#ifdef ALLOW_DIAGNOSTICS |
771 |
|
C-- State-variables diagnostics |
772 |
|
IF ( useDiagnostics ) THEN |
773 |
|
CALL TIMER_START('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid) |
774 |
|
CALL DO_STATEVARS_DIAGS( myTime, 1, myIter, myThid ) |
775 |
|
CALL TIMER_STOP ('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid) |
776 |
|
ENDIF |
777 |
|
#endif |
778 |
|
|
779 |
|
#ifdef ALLOW_DEBUG |
780 |
|
IF ( debugLevel .GE. debLevB ) |
781 |
|
& CALL DEBUG_CALL('THERMODYNAMICS',myThid) |
782 |
|
#endif |
783 |
|
CALL TIMER_START('THERMODYNAMICS [FORWARD_STEP]',myThid) |
784 |
|
CALL THERMODYNAMICS( myTime, myIter, myThid ) |
785 |
|
CALL TIMER_STOP ('THERMODYNAMICS [FORWARD_STEP]',myThid) |
786 |
|
|
787 |
|
C-- if staggerTimeStep: end |
788 |
|
ENDIF |
789 |
|
C---+--------+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
790 |
|
|
791 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
792 |
|
cph This is needed because convective_adjustment calls |
793 |
|
cph find_rho which may use pressure() |
794 |
|
CADJ STORE totphihyd = comlev1, key = ikey_dynamics, |
795 |
|
CADJ & kind = isbyte |
796 |
|
#endif |
797 |
|
C-- Cycle time-stepping Tracers arrays (T,S,+pTracers) |
798 |
|
CALL TIMER_START('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid) |
799 |
|
CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid) |
800 |
|
CALL TIMER_STOP ('TRC_CORRECTION_STEP [FORWARD_STEP]',myThid) |
801 |
|
|
802 |
|
#ifdef ALLOW_GCHEM |
803 |
|
C Add separate timestepping of chemical/biological/forcing |
804 |
|
C of ptracers here in GCHEM_FORCING_SEP |
805 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
806 |
|
CADJ STORE ptracer = comlev1, key = ikey_dynamics, |
807 |
|
CADJ & kind = isbyte |
808 |
|
CADJ STORE theta = comlev1, key = ikey_dynamics, |
809 |
|
CADJ & kind = isbyte |
810 |
|
CADJ STORE salt = comlev1, key = ikey_dynamics, |
811 |
|
CADJ & kind = isbyte |
812 |
|
#endif |
813 |
|
IF ( useGCHEM ) THEN |
814 |
|
#ifdef ALLOW_DEBUG |
815 |
|
IF ( debugLevel .GE. debLevB ) |
816 |
|
& CALL DEBUG_CALL('GCHEM_FORCING_SEP',myThid) |
817 |
|
#endif /* ALLOW_DEBUG */ |
818 |
|
CALL TIMER_START('GCHEM_FORCING_SEP [FORWARD_STEP]',myThid) |
819 |
|
CALL GCHEM_FORCING_SEP( myTime,myIter,myThid ) |
820 |
|
CALL TIMER_STOP ('GCHEM_FORCING_SEP [FORWARD_STEP]',myThid) |
821 |
|
ENDIF |
822 |
|
#endif /* ALLOW_GCHEM */ |
823 |
|
|
824 |
C-- Do "blocking" sends and receives for tendency "overlap" terms |
C-- Do "blocking" sends and receives for tendency "overlap" terms |
825 |
c CALL TIMER_START('BLOCKING_EXCHANGES [THE_MAIN_LOOP]',myThid) |
c CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
826 |
c CALL DO_GTERM_BLOCKING_EXCHANGES( myThid ) |
c CALL DO_GTERM_BLOCKING_EXCHANGES( myThid ) |
827 |
c CALL TIMER_STOP ('BLOCKING_EXCHANGES [THE_MAIN_LOOP]',myThid) |
c CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
828 |
|
|
829 |
C-- Do "blocking" sends and receives for field "overlap" terms |
C-- Do "blocking" sends and receives for field "overlap" terms |
830 |
CALL TIMER_START('BLOCKING_EXCHANGES [THE_MAIN_LOOP]',myThid) |
CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
831 |
CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid ) |
CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid ) |
832 |
CALL TIMER_STOP ('BLOCKING_EXCHANGES [THE_MAIN_LOOP]',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 |
|
|
842 |
|
#ifdef ALLOW_GRIDALT |
843 |
|
IF (useGRIDALT) THEN |
844 |
|
CALL GRIDALT_UPDATE(myThid) |
845 |
|
ENDIF |
846 |
|
#endif |
847 |
|
|
848 |
#ifndef EXCLUDE_MONITOR |
#ifdef ALLOW_FIZHI |
849 |
|
IF (useFIZHI) THEN |
850 |
|
CALL TIMER_START('FIZHI [FORWARD_STEP]',myThid) |
851 |
|
CALL STEP_FIZHI_CORR ( myTime, myIter, myThid, dTtracerLev(1) ) |
852 |
|
CALL TIMER_STOP ('FIZHI [FORWARD_STEP]',myThid) |
853 |
|
ENDIF |
854 |
|
#endif |
855 |
|
|
856 |
|
#ifdef ALLOW_FLT |
857 |
|
C-- Calculate float trajectories |
858 |
|
IF (useFLT) THEN |
859 |
|
CALL TIMER_START('FLOATS [FORWARD_STEP]',myThid) |
860 |
|
CALL FLT_MAIN( myTime, myIter, myThid ) |
861 |
|
CALL TIMER_STOP ('FLOATS [FORWARD_STEP]',myThid) |
862 |
|
ENDIF |
863 |
|
#endif |
864 |
|
|
865 |
|
#ifdef ALLOW_TIMEAVE |
866 |
|
C-- State-variables time-averaging |
867 |
|
CALL TIMER_START('DO_STATEVARS_TAVE [FORWARD_STEP]',myThid) |
868 |
|
CALL DO_STATEVARS_TAVE( myTime, myIter, myThid ) |
869 |
|
CALL TIMER_STOP ('DO_STATEVARS_TAVE [FORWARD_STEP]',myThid) |
870 |
|
#endif |
871 |
|
|
872 |
|
#ifdef ALLOW_MONITOR |
873 |
|
IF ( .NOT.useOffLine ) THEN |
874 |
C-- Check status of solution (statistics, cfl, etc...) |
C-- Check status of solution (statistics, cfl, etc...) |
875 |
CALL MONITOR( myIter, myTime, myThid ) |
CALL TIMER_START('MONITOR [FORWARD_STEP]',myThid) |
876 |
#endif /* EXCLUDE_MONITOR */ |
CALL MONITOR( myIter, myTime, myThid ) |
877 |
|
CALL TIMER_STOP ('MONITOR [FORWARD_STEP]',myThid) |
878 |
|
ENDIF |
879 |
|
#endif /* ALLOW_MONITOR */ |
880 |
|
|
881 |
|
#ifdef ALLOW_COST |
882 |
|
C-- compare model with data and compute cost function |
883 |
|
C-- this is done after exchanges to allow interpolation |
884 |
|
CALL TIMER_START('COST_TILE [FORWARD_STEP]',myThid) |
885 |
|
CALL COST_TILE ( myTime, myIter, myThid ) |
886 |
|
CALL TIMER_STOP ('COST_TILE [FORWARD_STEP]',myThid) |
887 |
|
#endif |
888 |
|
|
|
#ifndef ALLOW_AUTODIFF_TAMC |
|
889 |
C-- Do IO if needed. |
C-- Do IO if needed. |
890 |
CALL TIMER_START('DO_THE_MODEL_IO [THE_MAIN_LOOP]',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 [THE_MAIN_LOOP]',myThid) |
CALL TIMER_STOP ('DO_THE_MODEL_IO [FORWARD_STEP]',myThid) |
893 |
|
|
894 |
|
modelEnd = myTime.EQ.endTime .OR. myIter.EQ.nEndIter |
895 |
|
#ifdef HAVE_SIGREG |
896 |
|
IF ( useSIGREG ) THEN |
897 |
|
modelEnd = modelEnd .OR. ( i_got_signal.GT.0 ) |
898 |
|
ENDIF |
899 |
|
#endif /* HAVE_SIGREG */ |
900 |
|
|
901 |
C-- Save state for restarts |
C-- Save state for restarts |
902 |
C Note: (jmc: is it still the case after ckp35 ?) |
CALL TIMER_START('DO_WRITE_PICKUP [FORWARD_STEP]',myThid) |
903 |
C ===== |
CALL DO_WRITE_PICKUP( |
904 |
C Because of the ordering of the timestepping code and |
I modelEnd, myTime, myIter, myThid ) |
905 |
C tendency term code at end of loop model arrays hold |
CALL TIMER_STOP ('DO_WRITE_PICKUP [FORWARD_STEP]',myThid) |
906 |
C U,V,T,S at "time-level" N but gu, gv, gs, gt, guNM1,... |
|
907 |
C at "time-level" N+1/2 (guNM1 at "time-level" N+1/2 is |
#ifdef HAVE_SIGREG |
908 |
C gu at "time-level" N-1/2) and etaN at "time-level" N+1/2. |
IF ( useSIGREG ) THEN |
909 |
C where N = I+timeLevBase-1 |
IF ( modelEnd .AND. i_got_signal.GT.0 ) THEN |
910 |
C Thus a checkpoint contains U.0000000000, GU.0000000001 and |
STOP 'Checkpoint completed -- killed by signal handler' |
911 |
C etaN.0000000001 in the indexing scheme used for the model |
ENDIF |
912 |
C "state" files. This example is referred to as a checkpoint |
ENDIF |
913 |
C at time level 1 |
#endif /* HAVE_SIGREG */ |
|
CALL TIMER_START('WRITE_CHECKPOINT [THE_MAIN_LOOP]',myThid) |
|
|
CALL WRITE_CHECKPOINT( |
|
|
& .FALSE., myTime, myIter, myThid ) |
|
|
CALL TIMER_STOP ('WRITE_CHECKPOINT [THE_MAIN_LOOP]',myThid) |
|
914 |
|
|
915 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#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 |
924 |
|
|
925 |
|
#ifdef ALLOW_DEBUG |
926 |
|
IF ( debugLevel .GE. debLevB ) |
927 |
|
& CALL DEBUG_LEAVE('FORWARD_STEP',myThid) |
928 |
|
#endif |
929 |
|
|
930 |
|
RETURN |
931 |
END |
END |