1 |
mlosch |
1.108 |
C $Header: /u/gcmpack/MITgcm/model/src/forward_step.F,v 1.107 2004/11/18 23:31:00 mlosch Exp $ |
2 |
adcroft |
1.15 |
C $Name: $ |
3 |
adcroft |
1.1 |
|
4 |
edhill |
1.64 |
#include "PACKAGES_CONFIG.h" |
5 |
adcroft |
1.1 |
#include "CPP_OPTIONS.h" |
6 |
edhill |
1.64 |
|
7 |
heimbach |
1.56 |
#ifdef ALLOW_GCHEM |
8 |
|
|
# include "GCHEM_OPTIONS.h" |
9 |
stephd |
1.55 |
#endif |
10 |
stephd |
1.101 |
#ifdef ALLOW_OFFLINE |
11 |
|
|
# include "OFFLINE_OPTIONS.h" |
12 |
|
|
#endif |
13 |
heimbach |
1.104 |
#ifdef ALLOW_GMREDI |
14 |
|
|
# include "GMREDI_OPTIONS.h" |
15 |
|
|
#endif |
16 |
adcroft |
1.1 |
|
17 |
cnh |
1.22 |
CBOP |
18 |
|
|
C !ROUTINE: FORWARD_STEP |
19 |
|
|
C !INTERFACE: |
20 |
adcroft |
1.13 |
SUBROUTINE FORWARD_STEP( iloop, myTime, myIter, myThid ) |
21 |
heimbach |
1.12 |
|
22 |
cnh |
1.22 |
C !DESCRIPTION: \bv |
23 |
|
|
C *================================================================== |
24 |
|
|
C | SUBROUTINE forward_step |
25 |
|
|
C | o Run the ocean model and, optionally, evaluate a cost function. |
26 |
|
|
C *================================================================== |
27 |
|
|
C | |
28 |
|
|
C | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and |
29 |
|
|
C | Adjoint Model Compiler (TAMC). For this purpose the initialization |
30 |
|
|
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, |
32 |
|
|
C | whereas those that do depend on the specific realization are |
33 |
|
|
C | initialized in INITIALISE_VARIA. |
34 |
|
|
C | |
35 |
|
|
C *================================================================== |
36 |
|
|
C \ev |
37 |
adcroft |
1.1 |
|
38 |
cnh |
1.22 |
C !USES: |
39 |
|
|
IMPLICIT NONE |
40 |
|
|
C == Global variables == |
41 |
adcroft |
1.1 |
#include "SIZE.h" |
42 |
|
|
#include "EEPARAMS.h" |
43 |
|
|
#include "PARAMS.h" |
44 |
|
|
#include "DYNVARS.h" |
45 |
|
|
|
46 |
jmc |
1.27 |
#ifdef ALLOW_SHAP_FILT |
47 |
jmc |
1.91 |
# include "SHAP_FILT.h" |
48 |
jmc |
1.27 |
#endif |
49 |
|
|
#ifdef ALLOW_ZONAL_FILT |
50 |
jmc |
1.91 |
# include "ZONAL_FILT.h" |
51 |
jmc |
1.27 |
#endif |
52 |
jmc |
1.93 |
#ifdef COMPONENT_MODULE |
53 |
|
|
# include "CPL_PARAMS.h" |
54 |
|
|
#endif |
55 |
jmc |
1.27 |
|
56 |
heimbach |
1.12 |
#ifdef ALLOW_AUTODIFF_TAMC |
57 |
jmc |
1.91 |
# include "FFIELDS.h" |
58 |
|
|
|
59 |
|
|
# ifdef ALLOW_NONHYDROSTATIC |
60 |
|
|
# include "CG3D.h" |
61 |
|
|
# endif |
62 |
|
|
|
63 |
heimbach |
1.30 |
# include "tamc.h" |
64 |
|
|
# include "ctrl.h" |
65 |
|
|
# include "ctrl_dummy.h" |
66 |
|
|
# include "cost.h" |
67 |
heimbach |
1.37 |
# include "EOS.h" |
68 |
edhill |
1.69 |
# ifdef ALLOW_EXF |
69 |
heimbach |
1.30 |
# include "exf_fields.h" |
70 |
heimbach |
1.85 |
# include "exf_clim_fields.h" |
71 |
jmc |
1.63 |
# ifdef ALLOW_BULKFORMULAE |
72 |
heimbach |
1.30 |
# include "exf_constants.h" |
73 |
|
|
# endif |
74 |
|
|
# endif |
75 |
|
|
# ifdef ALLOW_OBCS |
76 |
|
|
# include "OBCS.h" |
77 |
|
|
# endif |
78 |
heimbach |
1.56 |
# ifdef ALLOW_PTRACERS |
79 |
jmc |
1.99 |
# include "PTRACERS_SIZE.h" |
80 |
heimbach |
1.56 |
# include "PTRACERS.h" |
81 |
heimbach |
1.82 |
# endif |
82 |
|
|
# ifdef ALLOW_CD_CODE |
83 |
|
|
# include "CD_CODE_VARS.h" |
84 |
heimbach |
1.56 |
# endif |
85 |
heimbach |
1.92 |
# ifdef ALLOW_EBM |
86 |
|
|
# include "EBM.h" |
87 |
|
|
# endif |
88 |
heimbach |
1.102 |
# ifdef EXACT_CONSERV |
89 |
|
|
# include "SURFACE.h" |
90 |
|
|
# endif |
91 |
heimbach |
1.104 |
# ifdef ALLOW_KPP |
92 |
|
|
# include "KPP.h" |
93 |
|
|
# endif |
94 |
|
|
# ifdef ALLOW_GMREDI |
95 |
|
|
# include "GMREDI.h" |
96 |
|
|
# endif |
97 |
heimbach |
1.56 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
98 |
heimbach |
1.12 |
|
99 |
cnh |
1.22 |
C !LOCAL VARIABLES: |
100 |
|
|
C == Routine arguments == |
101 |
adcroft |
1.13 |
C note: under the multi-threaded model myiter and |
102 |
|
|
C mytime are local variables passed around as routine |
103 |
|
|
C arguments. Although this is fiddly it saves the need to |
104 |
|
|
C impose additional synchronisation points when they are |
105 |
|
|
C updated. |
106 |
jmc |
1.93 |
C myIter - iteration counter for this thread |
107 |
|
|
C myTime - time counter for this thread |
108 |
|
|
C myThid - thread number for this instance of the routine. |
109 |
|
|
INTEGER iloop |
110 |
|
|
INTEGER myThid |
111 |
|
|
INTEGER myIter |
112 |
|
|
_RL myTime |
113 |
molod |
1.83 |
|
114 |
jmc |
1.93 |
C == Local variables == |
115 |
|
|
INTEGER myItP1 |
116 |
cnh |
1.22 |
CEOP |
117 |
heimbach |
1.12 |
|
118 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
119 |
heimbach |
1.57 |
IF ( debugLevel .GE. debLevB ) |
120 |
|
|
& CALL DEBUG_ENTER('FORWARD_STEP',myThid) |
121 |
adcroft |
1.53 |
#endif |
122 |
|
|
|
123 |
heimbach |
1.12 |
#ifdef ALLOW_AUTODIFF_TAMC |
124 |
dimitri |
1.45 |
C-- Reset the model iteration counter and the model time. |
125 |
|
|
myiter = nIter0 + (iloop-1) |
126 |
|
|
mytime = startTime + float(iloop-1)*deltaTclock |
127 |
heimbach |
1.12 |
#endif |
128 |
|
|
|
129 |
heimbach |
1.28 |
#ifdef ALLOW_AUTODIFF_TAMC |
130 |
|
|
c************************************** |
131 |
|
|
#include "checkpoint_lev1_directives.h" |
132 |
|
|
c************************************** |
133 |
heimbach |
1.23 |
#endif |
134 |
cheisey |
1.38 |
|
135 |
heimbach |
1.37 |
C-- Call external forcing package |
136 |
cheisey |
1.40 |
#ifdef ALLOW_BULK_FORCE |
137 |
jmc |
1.76 |
IF ( useBulkForce ) THEN |
138 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
139 |
jmc |
1.58 |
IF ( debugLevel .GE. debLevB ) |
140 |
heimbach |
1.57 |
& CALL DEBUG_CALL('BULKF_FIELDS_LOAD',myThid) |
141 |
adcroft |
1.53 |
#endif |
142 |
jmc |
1.76 |
CALL TIMER_START('BULKF_FORCING [FORWARD_STEP]',mythid) |
143 |
|
|
C- load all forcing fields at current time |
144 |
|
|
CALL BULKF_FIELDS_LOAD( myTime, myIter, myThid ) |
145 |
|
|
C- calculate qnet and empmr (and wind stress) |
146 |
|
|
CALL BULKF_FORCING( myTime, myIter, myThid ) |
147 |
|
|
CALL TIMER_STOP ('BULKF_FORCING [FORWARD_STEP]',mythid) |
148 |
jmc |
1.63 |
ELSE |
149 |
jmc |
1.58 |
#endif /* ALLOW_BULK_FORCE */ |
150 |
jmc |
1.63 |
|
151 |
edhill |
1.64 |
# ifdef ALLOW_EXF |
152 |
heimbach |
1.72 |
# ifdef ALLOW_DEBUG |
153 |
heimbach |
1.57 |
IF ( debugLevel .GE. debLevB ) |
154 |
|
|
& CALL DEBUG_CALL('EXF_GETFORCING',myThid) |
155 |
heimbach |
1.72 |
# endif |
156 |
dimitri |
1.45 |
CALL TIMER_START('EXF_GETFORCING [FORWARD_STEP]',mythid) |
157 |
|
|
CALL EXF_GETFORCING( mytime, myiter, mythid ) |
158 |
|
|
CALL TIMER_STOP ('EXF_GETFORCING [FORWARD_STEP]',mythid) |
159 |
edhill |
1.64 |
# else /* ALLOW_EXF undef */ |
160 |
heimbach |
1.49 |
cph The following IF-statement creates an additional dependency |
161 |
|
|
cph for the forcing fields requiring additional storing. |
162 |
|
|
cph Therefore, the IF-statement will be put between CPP-OPTIONS, |
163 |
|
|
cph assuming that ALLOW_SEAICE has not yet been differentiated. |
164 |
heimbach |
1.92 |
# if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM)) |
165 |
|
|
IF ( .NOT. useSEAICE .AND. .NOT. useEBM ) THEN |
166 |
heimbach |
1.49 |
# endif |
167 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
168 |
heimbach |
1.57 |
IF ( debugLevel .GE. debLevB ) |
169 |
|
|
& CALL DEBUG_CALL('EXTERNAL_FIELDS_LOAD',myThid) |
170 |
adcroft |
1.53 |
#endif |
171 |
dimitri |
1.45 |
CALL TIMER_START('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid) |
172 |
|
|
CALL EXTERNAL_FIELDS_LOAD( mytime, myiter, mythid ) |
173 |
|
|
CALL TIMER_STOP ('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid) |
174 |
heimbach |
1.92 |
# if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM)) |
175 |
dimitri |
1.45 |
ENDIF |
176 |
heimbach |
1.49 |
# endif |
177 |
edhill |
1.64 |
# endif /* ALLOW_EXF */ |
178 |
jmc |
1.63 |
#ifdef ALLOW_BULK_FORCE |
179 |
|
|
C-- end of if/else block useBulfforce -- |
180 |
|
|
ENDIF |
181 |
|
|
#endif /* ALLOW_BULK_FORCE */ |
182 |
heimbach |
1.49 |
|
183 |
heimbach |
1.68 |
#ifdef ALLOW_AUTODIFF |
184 |
heimbach |
1.49 |
c-- Add control vector for forcing and parameter fields |
185 |
|
|
if ( myiter .EQ. nIter0 ) |
186 |
|
|
& CALL CTRL_MAP_FORCING (mythid) |
187 |
|
|
#endif |
188 |
cheisey |
1.38 |
|
189 |
heimbach |
1.106 |
#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR)) |
190 |
|
|
C Include call to a dummy routine. Its adjoint will be |
191 |
|
|
C called at the proper place in the adjoint code. |
192 |
|
|
C The adjoint routine will print out adjoint values |
193 |
|
|
C if requested. The location of the call is important, |
194 |
|
|
C it has to be after the adjoint of the exchanges |
195 |
|
|
C (DO_GTERM_BLOCKING_EXCHANGES). |
196 |
|
|
CALL DUMMY_IN_STEPPING( myTime, myIter, myThid ) |
197 |
|
|
cph I've commented this line since it may conflict with MITgcm's adjoint |
198 |
|
|
cph However, need to check whether that's still consistent |
199 |
|
|
cph with the ecco-branch (it should). |
200 |
|
|
cph CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid ) |
201 |
|
|
#endif |
202 |
|
|
|
203 |
heimbach |
1.49 |
# ifdef ALLOW_SEAICE |
204 |
dimitri |
1.45 |
C-- Call sea ice model to compute forcing/external data fields. In |
205 |
|
|
C addition to computing prognostic sea-ice variables and diagnosing the |
206 |
|
|
C forcing/external data fields that drive the ocean model, SEAICE_MODEL |
207 |
|
|
C also sets theta to the freezing point under sea-ice. The implied |
208 |
|
|
C surface heat flux is then stored in variable surfaceTendencyTice, |
209 |
|
|
C which is needed by KPP package (kpp_calc.F and kpp_transport_t.F) |
210 |
|
|
C to diagnose surface buoyancy fluxes and for the non-local transport |
211 |
|
|
C term. Because this call precedes model thermodynamics, temperature |
212 |
|
|
C under sea-ice may not be "exactly" at the freezing point by the time |
213 |
|
|
C theta is dumped or time-averaged. |
214 |
|
|
IF ( useSEAICE ) THEN |
215 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
216 |
heimbach |
1.57 |
IF ( debugLevel .GE. debLevB ) |
217 |
|
|
& CALL DEBUG_CALL('SEAICE_MODEL',myThid) |
218 |
adcroft |
1.53 |
#endif |
219 |
heimbach |
1.36 |
CALL TIMER_START('SEAICE_MODEL [FORWARD_STEP]',myThid) |
220 |
jmc |
1.41 |
CALL SEAICE_MODEL( myTime, myIter, myThid ) |
221 |
heimbach |
1.36 |
CALL TIMER_STOP ('SEAICE_MODEL [FORWARD_STEP]',myThid) |
222 |
dimitri |
1.45 |
ENDIF |
223 |
dimitri |
1.50 |
# endif /* ALLOW_SEAICE */ |
224 |
dimitri |
1.73 |
|
225 |
heimbach |
1.56 |
#ifdef ALLOW_AUTODIFF_TAMC |
226 |
|
|
# ifdef ALLOW_PTRACERS |
227 |
|
|
cph this replaces _bibj storing of ptracer within thermodynamics |
228 |
|
|
CADJ STORE ptracer = comlev1, key = ikey_dynamics |
229 |
|
|
# endif |
230 |
|
|
#endif |
231 |
stephd |
1.62 |
|
232 |
stephd |
1.101 |
#ifdef ALLOW_OFFLINE |
233 |
|
|
call OFFLINE_FIELDS_LOAD( myTime, myIter, myThid ) |
234 |
|
|
#endif |
235 |
|
|
|
236 |
stephd |
1.62 |
#ifdef ALLOW_PTRACERS |
237 |
|
|
# ifdef ALLOW_GCHEM |
238 |
mlosch |
1.108 |
IF ( useGCHEM ) THEN |
239 |
stephd |
1.62 |
CALL GCHEM_FIELDS_LOAD( mytime, myiter, mythid ) |
240 |
mlosch |
1.108 |
ENDIF |
241 |
stephd |
1.62 |
# endif |
242 |
|
|
#endif |
243 |
jmc |
1.78 |
|
244 |
|
|
#ifdef COMPONENT_MODULE |
245 |
jmc |
1.93 |
IF ( useCoupler .AND. cpl_earlyExpImpCall ) THEN |
246 |
jmc |
1.78 |
C Post coupling data that I export. |
247 |
|
|
C Read in coupling data that I import. |
248 |
|
|
CALL TIMER_START('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
249 |
|
|
CALL CPL_EXPORT_MY_DATA( myIter, myTime, myThid ) |
250 |
|
|
CALL CPL_IMPORT_EXTERNAL_DATA( myIter, myTime, myThid ) |
251 |
|
|
CALL TIMER_STOP ('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
252 |
|
|
ENDIF |
253 |
|
|
#endif /* COMPONENT_MODULE */ |
254 |
stephd |
1.62 |
|
255 |
heimbach |
1.92 |
#ifdef ALLOW_EBM |
256 |
|
|
IF ( useEBM ) THEN |
257 |
|
|
# ifdef ALLOW_DEBUG |
258 |
|
|
IF ( debugLevel .GE. debLevB ) |
259 |
|
|
& CALL DEBUG_CALL('EBM',myThid) |
260 |
|
|
# endif |
261 |
|
|
CALL TIMER_START('EBM [FORWARD_STEP]',mythid) |
262 |
|
|
CALL EBM_DRIVER ( myTime, myIter, myThid ) |
263 |
|
|
CALL TIMER_STOP ('EBM [FORWARD_STEP]',mythid) |
264 |
|
|
ENDIF |
265 |
|
|
#endif |
266 |
molod |
1.79 |
|
267 |
jmc |
1.97 |
C-- Step forward fields and calculate time tendency terms. |
268 |
|
|
|
269 |
|
|
#ifdef ALLOW_DEBUG |
270 |
|
|
IF ( debugLevel .GE. debLevB ) |
271 |
|
|
& CALL DEBUG_CALL('DO_ATMOSPHERIC_PHYS',myThid) |
272 |
|
|
#endif |
273 |
|
|
CALL TIMER_START('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid) |
274 |
|
|
CALL DO_ATMOSPHERIC_PHYS( myTime, myIter, myThid ) |
275 |
|
|
CALL TIMER_STOP ('DO_ATMOSPHERIC_PHYS [FORWARD_STEP]',mythid) |
276 |
|
|
|
277 |
heimbach |
1.104 |
#ifdef ALLOW_AUTODIFF_TAMC |
278 |
|
|
CADJ STORE theta = comlev1, key = ikey_dynamics |
279 |
|
|
CADJ STORE salt = comlev1, key = ikey_dynamics |
280 |
|
|
CADJ STORE totphihyd = comlev1, key = ikey_dynamics |
281 |
|
|
CADJ STORE surfaceforcingtice = comlev1, key = ikey_dynamics |
282 |
|
|
# ifdef ALLOW_KPP |
283 |
|
|
CADJ STORE uvel = comlev1, key = ikey_dynamics |
284 |
|
|
CADJ STORE vvel = comlev1, key = ikey_dynamics |
285 |
|
|
# endif |
286 |
|
|
# ifdef EXACT_CONSERV |
287 |
heimbach |
1.105 |
CADJ STORE empmr = comlev1, key = ikey_dynamics |
288 |
heimbach |
1.104 |
CADJ STORE pmepr = comlev1, key = ikey_dynamics |
289 |
|
|
# endif |
290 |
|
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
291 |
|
|
|
292 |
stephd |
1.101 |
#ifndef ALLOW_OFFLINE |
293 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
294 |
jmc |
1.96 |
IF ( debugLevel .GE. debLevB ) |
295 |
|
|
& CALL DEBUG_CALL('DO_OCEANIC_PHYS',myThid) |
296 |
|
|
#endif |
297 |
|
|
CALL TIMER_START('DO_OCEANIC_PHYS [FORWARD_STEP]',mythid) |
298 |
|
|
CALL DO_OCEANIC_PHYS( myTime, myIter, myThid ) |
299 |
|
|
CALL TIMER_STOP ('DO_OCEANIC_PHYS [FORWARD_STEP]',mythid) |
300 |
stephd |
1.101 |
#endif |
301 |
jmc |
1.96 |
|
302 |
heimbach |
1.104 |
#ifdef ALLOW_AUTODIFF_TAMC |
303 |
|
|
cph needed to be moved here from do_oceanic_physics |
304 |
|
|
cph to be visible down the road |
305 |
|
|
c |
306 |
|
|
CADJ STORE surfaceForcingS = comlev1, key = ikey_dynamics |
307 |
|
|
CADJ STORE surfaceForcingT = comlev1, key = ikey_dynamics |
308 |
|
|
CADJ STORE surfaceForcingTice = comlev1, key = ikey_dynamics |
309 |
|
|
ctest( |
310 |
heimbach |
1.105 |
CADJ STORE IVDConvCount = comlev1, key = ikey_dynamics |
311 |
|
|
ctest) |
312 |
|
|
# ifdef ALLOW_PTRACERS |
313 |
|
|
CADJ STORE surfaceForcingPtr = comlev1, key = ikey_dynamics |
314 |
heimbach |
1.104 |
# endif |
315 |
|
|
c |
316 |
|
|
# ifdef ALLOW_GMREDI |
317 |
|
|
CADJ STORE Kwx = comlev1, key = ikey_dynamics |
318 |
|
|
CADJ STORE Kwy = comlev1, key = ikey_dynamics |
319 |
|
|
CADJ STORE Kwz = comlev1, key = ikey_dynamics |
320 |
|
|
# ifdef GM_BOLUS_ADVEC |
321 |
|
|
CADJ STORE GM_PsiX = comlev1, key = ikey_dynamics |
322 |
|
|
CADJ STORE GM_PsiY = comlev1, key = ikey_dynamics |
323 |
|
|
# endif |
324 |
|
|
# endif |
325 |
|
|
c |
326 |
|
|
# ifdef ALLOW_KPP |
327 |
|
|
CADJ STORE KPPghat = comlev1, key = ikey_dynamics |
328 |
|
|
CADJ STORE KPPfrac = comlev1, key = ikey_dynamics |
329 |
heimbach |
1.105 |
CADJ STORE KPPdiffKzS = comlev1, key = ikey_dynamics |
330 |
|
|
CADJ STORE KPPdiffKzT = comlev1, key = ikey_dynamics |
331 |
heimbach |
1.104 |
# endif |
332 |
|
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
333 |
|
|
|
334 |
jmc |
1.96 |
IF ( .NOT.staggerTimeStep ) THEN |
335 |
|
|
#ifdef ALLOW_DEBUG |
336 |
|
|
IF ( debugLevel .GE. debLevB ) |
337 |
heimbach |
1.57 |
& CALL DEBUG_CALL('THERMODYNAMICS',myThid) |
338 |
adcroft |
1.53 |
#endif |
339 |
heimbach |
1.36 |
CALL TIMER_START('THERMODYNAMICS [FORWARD_STEP]',mythid) |
340 |
adcroft |
1.15 |
CALL THERMODYNAMICS( myTime, myIter, myThid ) |
341 |
heimbach |
1.36 |
CALL TIMER_STOP ('THERMODYNAMICS [FORWARD_STEP]',mythid) |
342 |
jmc |
1.96 |
C-- if not staggerTimeStep: end |
343 |
dimitri |
1.45 |
ENDIF |
344 |
jmc |
1.93 |
|
345 |
|
|
#ifdef COMPONENT_MODULE |
346 |
|
|
IF ( useCoupler .AND. .NOT.cpl_earlyExpImpCall ) THEN |
347 |
|
|
C Post coupling data that I export. |
348 |
|
|
C Read in coupling data that I import. |
349 |
|
|
myItP1 = myIter + 1 |
350 |
|
|
CALL TIMER_START('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
351 |
|
|
CALL CPL_EXPORT_MY_DATA( myItP1, myTime, myThid ) |
352 |
|
|
CALL CPL_IMPORT_EXTERNAL_DATA( myItP1, myTime, myThid ) |
353 |
|
|
CALL TIMER_STOP ('CPL_EXPORT-IMPORT [FORWARD_STEP]',myThid) |
354 |
|
|
# ifndef ALLOW_AIM |
355 |
|
|
IF ( useRealFreshWaterFlux ) THEN |
356 |
|
|
CALL OCN_APPLY_IMPORT( .FALSE., myTime, myIter, myThid ) |
357 |
|
|
ENDIF |
358 |
|
|
# endif |
359 |
|
|
ENDIF |
360 |
|
|
#endif /* COMPONENT_MODULE */ |
361 |
heimbach |
1.12 |
|
362 |
dimitri |
1.45 |
C-- Step forward fields and calculate time tendency terms. |
363 |
stephd |
1.101 |
#ifndef ALLOW_OFFLINE |
364 |
heimbach |
1.61 |
#ifndef ALLOW_AUTODIFF_TAMC |
365 |
dimitri |
1.45 |
IF ( momStepping ) THEN |
366 |
heimbach |
1.61 |
#endif |
367 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
368 |
heimbach |
1.57 |
IF ( debugLevel .GE. debLevB ) |
369 |
|
|
& CALL DEBUG_CALL('DYNAMICS',myThid) |
370 |
adcroft |
1.53 |
#endif |
371 |
heimbach |
1.36 |
CALL TIMER_START('DYNAMICS [FORWARD_STEP]',mythid) |
372 |
heimbach |
1.12 |
CALL DYNAMICS( myTime, myIter, myThid ) |
373 |
heimbach |
1.36 |
CALL TIMER_STOP ('DYNAMICS [FORWARD_STEP]',mythid) |
374 |
heimbach |
1.61 |
#ifndef ALLOW_AUTODIFF_TAMC |
375 |
dimitri |
1.45 |
ENDIF |
376 |
heimbach |
1.61 |
#endif |
377 |
stephd |
1.101 |
#endif |
378 |
heimbach |
1.12 |
|
379 |
adcroft |
1.1 |
#ifdef ALLOW_NONHYDROSTATIC |
380 |
|
|
C-- Step forward W field in N-H algorithm |
381 |
dimitri |
1.45 |
IF ( momStepping .AND. nonHydrostatic ) THEN |
382 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
383 |
heimbach |
1.57 |
IF ( debugLevel .GE. debLevB ) |
384 |
|
|
& CALL DEBUG_CALL('CALC_GW',myThid) |
385 |
adcroft |
1.53 |
#endif |
386 |
dimitri |
1.45 |
CALL TIMER_START('CALC_GW [FORWARD_STEP]',myThid) |
387 |
|
|
CALL CALC_GW(myThid) |
388 |
|
|
CALL TIMER_STOP ('CALC_GW [FORWARD_STEP]',myThid) |
389 |
|
|
ENDIF |
390 |
adcroft |
1.1 |
#endif |
391 |
jmc |
1.18 |
|
392 |
jmc |
1.96 |
C-- Update time-counter |
393 |
|
|
myIter = nIter0 + iLoop |
394 |
|
|
myTime = startTime + deltaTClock * float(iLoop) |
395 |
|
|
|
396 |
|
|
C-- Update geometric factors: |
397 |
jmc |
1.18 |
#ifdef NONLIN_FRSURF |
398 |
jmc |
1.96 |
C- update hfacC,W,S and recip_hFac according to etaH(n+1) : |
399 |
jmc |
1.18 |
IF ( nonlinFreeSurf.GT.0) THEN |
400 |
jmc |
1.48 |
IF ( select_rStar.GT.0 ) THEN |
401 |
|
|
CALL TIMER_START('UPDATE_R_STAR [FORWARD_STEP]',myThid) |
402 |
|
|
CALL UPDATE_R_STAR( myTime, myIter, myThid ) |
403 |
|
|
CALL TIMER_STOP ('UPDATE_R_STAR [FORWARD_STEP]',myThid) |
404 |
|
|
ELSE |
405 |
dimitri |
1.45 |
CALL TIMER_START('UPDATE_SURF_DR [FORWARD_STEP]',myThid) |
406 |
jmc |
1.18 |
CALL UPDATE_SURF_DR( myTime, myIter, myThid ) |
407 |
heimbach |
1.36 |
CALL TIMER_STOP ('UPDATE_SURF_DR [FORWARD_STEP]',myThid) |
408 |
jmc |
1.48 |
ENDIF |
409 |
jmc |
1.18 |
ENDIF |
410 |
|
|
C- update also CG2D matrix (and preconditioner) |
411 |
jmc |
1.33 |
IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN |
412 |
dimitri |
1.45 |
CALL TIMER_START('UPDATE_CG2D [FORWARD_STEP]',myThid) |
413 |
jmc |
1.18 |
CALL UPDATE_CG2D( myTime, myIter, myThid ) |
414 |
jmc |
1.47 |
CALL TIMER_STOP ('UPDATE_CG2D [FORWARD_STEP]',myThid) |
415 |
adcroft |
1.19 |
ENDIF |
416 |
jmc |
1.18 |
#endif |
417 |
adcroft |
1.1 |
|
418 |
jmc |
1.27 |
C-- Apply Filters to u*,v* before SOLVE_FOR_PRESSURE |
419 |
|
|
#ifdef ALLOW_SHAP_FILT |
420 |
|
|
IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN |
421 |
heimbach |
1.36 |
CALL TIMER_START('SHAP_FILT [FORWARD_STEP]',myThid) |
422 |
jmc |
1.27 |
IF (implicDiv2Dflow.LT.1.) THEN |
423 |
|
|
C-- Explicit+Implicit part of the Barotropic Flow Divergence |
424 |
|
|
C => Filtering of uVel,vVel is necessary |
425 |
jmc |
1.59 |
CALL SHAP_FILT_APPLY_UV( uVel,vVel, |
426 |
jmc |
1.96 |
& myTime, myIter, myThid ) |
427 |
jmc |
1.27 |
ENDIF |
428 |
jmc |
1.96 |
CALL SHAP_FILT_APPLY_UV( gU,gV,myTime,myIter,myThid) |
429 |
heimbach |
1.36 |
CALL TIMER_STOP ('SHAP_FILT [FORWARD_STEP]',myThid) |
430 |
jmc |
1.27 |
ENDIF |
431 |
|
|
#endif |
432 |
|
|
#ifdef ALLOW_ZONAL_FILT |
433 |
|
|
IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN |
434 |
heimbach |
1.36 |
CALL TIMER_START('ZONAL_FILT_APPLY [FORWARD_STEP]',myThid) |
435 |
jmc |
1.27 |
IF (implicDiv2Dflow.LT.1.) THEN |
436 |
|
|
C-- Explicit+Implicit part of the Barotropic Flow Divergence |
437 |
|
|
C => Filtering of uVel,vVel is necessary |
438 |
|
|
CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid ) |
439 |
|
|
ENDIF |
440 |
jmc |
1.59 |
CALL ZONAL_FILT_APPLY_UV( gU, gV, myThid ) |
441 |
heimbach |
1.36 |
CALL TIMER_STOP ('ZONAL_FILT_APPLY [FORWARD_STEP]',myThid) |
442 |
jmc |
1.27 |
ENDIF |
443 |
|
|
#endif |
444 |
heimbach |
1.12 |
|
445 |
adcroft |
1.1 |
C-- Solve elliptic equation(s). |
446 |
|
|
C Two-dimensional only for conventional hydrostatic or |
447 |
|
|
C three-dimensional for non-hydrostatic and/or IGW scheme. |
448 |
stephd |
1.101 |
#ifndef ALLOW_OFFLINE |
449 |
adcroft |
1.19 |
IF ( momStepping ) THEN |
450 |
jmc |
1.96 |
CALL TIMER_START('SOLVE_FOR_PRESSURE [FORWARD_STEP]',myThid) |
451 |
|
|
CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid) |
452 |
|
|
CALL TIMER_STOP ('SOLVE_FOR_PRESSURE [FORWARD_STEP]',myThid) |
453 |
|
|
ENDIF |
454 |
stephd |
1.101 |
#endif |
455 |
jmc |
1.96 |
|
456 |
|
|
C-- Correct divergence in flow field and cycle time-stepping momentum |
457 |
|
|
c IF ( momStepping ) THEN |
458 |
stephd |
1.101 |
#ifndef ALLOW_OFFLINE |
459 |
jmc |
1.96 |
CALL TIMER_START('UV_CORRECTION_STEP [FORWARD_STEP]',myThid) |
460 |
|
|
CALL MOMENTUM_CORRECTION_STEP(myTime, myIter, myThid) |
461 |
|
|
CALL TIMER_STOP ('UV_CORRECTION_STEP [FORWARD_STEP]',myThid) |
462 |
stephd |
1.101 |
#endif |
463 |
jmc |
1.96 |
c ENDIF |
464 |
|
|
|
465 |
|
|
#ifdef EXACT_CONSERV |
466 |
|
|
IF (exactConserv) THEN |
467 |
|
|
C-- Update etaH(n+1) : |
468 |
|
|
CALL TIMER_START('UPDATE_ETAH [FORWARD_STEP]',mythid) |
469 |
|
|
CALL UPDATE_ETAH( myTime, myIter, myThid ) |
470 |
|
|
CALL TIMER_STOP ('UPDATE_ETAH [FORWARD_STEP]',mythid) |
471 |
adcroft |
1.19 |
ENDIF |
472 |
jmc |
1.96 |
#endif /* EXACT_CONSERV */ |
473 |
|
|
|
474 |
|
|
#ifdef NONLIN_FRSURF |
475 |
|
|
IF ( select_rStar.NE.0 ) THEN |
476 |
|
|
C-- r* : compute the future level thickness according to etaH(n+1) |
477 |
|
|
CALL TIMER_START('CALC_R_STAR [FORWARD_STEP]',mythid) |
478 |
|
|
CALL CALC_R_STAR(etaH, myTime, myIter, myThid ) |
479 |
|
|
CALL TIMER_STOP ('CALC_R_STAR [FORWARD_STEP]',mythid) |
480 |
|
|
ELSEIF ( nonlinFreeSurf.GT.0) THEN |
481 |
|
|
C-- compute the future surface level thickness according to etaH(n+1) |
482 |
|
|
CALL TIMER_START('CALC_SURF_DR [FORWARD_STEP]',mythid) |
483 |
|
|
CALL CALC_SURF_DR(etaH, myTime, myIter, myThid ) |
484 |
|
|
CALL TIMER_STOP ('CALC_SURF_DR [FORWARD_STEP]',mythid) |
485 |
|
|
ENDIF |
486 |
|
|
#endif /* NONLIN_FRSURF */ |
487 |
|
|
|
488 |
|
|
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
489 |
|
|
IF ( staggerTimeStep ) THEN |
490 |
jmc |
1.98 |
C-- do exchanges of U,V (needed for multiDim) when using stagger time-step : |
491 |
|
|
#ifdef ALLOW_DEBUG |
492 |
|
|
IF ( debugLevel .GE. debLevB ) |
493 |
|
|
& CALL DEBUG_CALL('DO_STAGGER_FIELDS_EXCH.',myThid) |
494 |
|
|
#endif |
495 |
|
|
CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
496 |
|
|
CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid ) |
497 |
|
|
CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
498 |
jmc |
1.96 |
|
499 |
|
|
#ifdef ALLOW_DEBUG |
500 |
|
|
IF ( debugLevel .GE. debLevB ) |
501 |
|
|
& CALL DEBUG_CALL('THERMODYNAMICS',myThid) |
502 |
|
|
#endif |
503 |
|
|
CALL TIMER_START('THERMODYNAMICS [FORWARD_STEP]',mythid) |
504 |
|
|
CALL THERMODYNAMICS( myTime, myIter, myThid ) |
505 |
|
|
CALL TIMER_STOP ('THERMODYNAMICS [FORWARD_STEP]',mythid) |
506 |
|
|
|
507 |
|
|
C-- if staggerTimeStep: end |
508 |
|
|
ENDIF |
509 |
|
|
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
510 |
adcroft |
1.1 |
|
511 |
heimbach |
1.37 |
#ifdef ALLOW_AUTODIFF_TAMC |
512 |
|
|
cph This is needed because convective_adjustment calls |
513 |
|
|
cph find_rho which may use pressure() |
514 |
heimbach |
1.51 |
CADJ STORE totphihyd = comlev1, key = ikey_dynamics |
515 |
heimbach |
1.37 |
#endif |
516 |
jmc |
1.96 |
C-- Cycle time-stepping Tracers arrays (T,S,+pTracers) |
517 |
|
|
CALL TIMER_START('TS_CORRECTION_STEP [FORWARD_STEP]',myThid) |
518 |
|
|
CALL TRACERS_CORRECTION_STEP(myTime, myIter, myThid) |
519 |
|
|
CALL TIMER_STOP ('TS_CORRECTION_STEP [FORWARD_STEP]',myThid) |
520 |
adcroft |
1.5 |
|
521 |
mlosch |
1.107 |
cswdptr -- add for seperate timestepping of chemical/biological/forcing |
522 |
|
|
cswdptr of ptracers --- |
523 |
|
|
#ifdef ALLOW_GCHEM |
524 |
|
|
ceh3 This is broken -- this ifdef should not be visible! |
525 |
|
|
#ifdef PTRACERS_SEPARATE_FORCING |
526 |
mlosch |
1.108 |
IF ( useGCHEM ) THEN |
527 |
|
|
CALL GCHEM_FORCING_SEP( myTime,myIter,myThid ) |
528 |
|
|
ENDIF |
529 |
mlosch |
1.107 |
#endif /* PTRACERS_SEPARATE_FORCING */ |
530 |
|
|
#endif /* ALLOW_GCHEM */ |
531 |
|
|
cswdptr -- end add --- |
532 |
|
|
|
533 |
adcroft |
1.1 |
C-- Do "blocking" sends and receives for tendency "overlap" terms |
534 |
heimbach |
1.36 |
c CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
535 |
jmc |
1.7 |
c CALL DO_GTERM_BLOCKING_EXCHANGES( myThid ) |
536 |
heimbach |
1.36 |
c CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
537 |
adcroft |
1.5 |
|
538 |
|
|
C-- Do "blocking" sends and receives for field "overlap" terms |
539 |
heimbach |
1.36 |
CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
540 |
adcroft |
1.5 |
CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid ) |
541 |
heimbach |
1.36 |
CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
542 |
stephd |
1.54 |
|
543 |
molod |
1.83 |
|
544 |
|
|
C AMM |
545 |
|
|
#ifdef ALLOW_GRIDALT |
546 |
molod |
1.88 |
if (useGRIDALT) then |
547 |
|
|
CALL GRIDALT_UPDATE(myThid) |
548 |
molod |
1.89 |
endif |
549 |
molod |
1.83 |
#endif |
550 |
|
|
C AMM |
551 |
stephd |
1.54 |
|
552 |
molod |
1.79 |
C AMM |
553 |
|
|
#ifdef ALLOW_FIZHI |
554 |
molod |
1.88 |
if( useFIZHI) then |
555 |
molod |
1.90 |
CALL TIMER_START('FIZHI [FORWARD_STEP]',mythid) |
556 |
molod |
1.88 |
CALL STEP_FIZHI_CORR ( myTime, myIter, myThid ) |
557 |
molod |
1.90 |
CALL TIMER_STOP('FIZHI [FORWARD_STEP]',mythid) |
558 |
molod |
1.88 |
endif |
559 |
molod |
1.79 |
#endif |
560 |
|
|
C AMM |
561 |
adcroft |
1.20 |
|
562 |
|
|
#ifdef ALLOW_FLT |
563 |
|
|
C-- Calculate float trajectories |
564 |
|
|
IF (useFLT) THEN |
565 |
heimbach |
1.36 |
CALL TIMER_START('FLOATS [FORWARD_STEP]',myThid) |
566 |
adcroft |
1.20 |
CALL FLT_MAIN(myIter,myTime, myThid) |
567 |
heimbach |
1.36 |
CALL TIMER_STOP ('FLOATS [FORWARD_STEP]',myThid) |
568 |
adcroft |
1.20 |
ENDIF |
569 |
|
|
#endif |
570 |
heimbach |
1.12 |
|
571 |
jmc |
1.97 |
C-- State-variables statistics (time-aver, diagnostics ...) |
572 |
|
|
CALL TIMER_START('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid) |
573 |
|
|
CALL DO_STATEVARS_DIAGS( myTime, myIter, myThid ) |
574 |
|
|
CALL TIMER_STOP ('DO_STATEVARS_DIAGS [FORWARD_STEP]',myThid) |
575 |
|
|
|
576 |
stephd |
1.101 |
#ifndef ALLOW_OFFLINE |
577 |
edhill |
1.70 |
#ifdef ALLOW_MONITOR |
578 |
heimbach |
1.12 |
C-- Check status of solution (statistics, cfl, etc...) |
579 |
dimitri |
1.45 |
CALL TIMER_START('MONITOR [FORWARD_STEP]',myThid) |
580 |
heimbach |
1.12 |
CALL MONITOR( myIter, myTime, myThid ) |
581 |
heimbach |
1.36 |
CALL TIMER_STOP ('MONITOR [FORWARD_STEP]',myThid) |
582 |
edhill |
1.70 |
#endif /* ALLOW_MONITOR */ |
583 |
stephd |
1.101 |
#endif |
584 |
molod |
1.86 |
|
585 |
heimbach |
1.103 |
#ifdef ALLOW_COST |
586 |
|
|
C-- compare model with data and compute cost function |
587 |
|
|
C-- this is done after exchanges to allow interpolation |
588 |
|
|
CALL TIMER_START('COST_TILE [FORWARD_STEP]',myThid) |
589 |
|
|
CALL COST_TILE ( mytime, myiter, myThid ) |
590 |
|
|
CALL TIMER_STOP ('COST_TILE [FORWARD_STEP]',myThid) |
591 |
|
|
#endif |
592 |
|
|
|
593 |
jmc |
1.7 |
C-- Do IO if needed. |
594 |
stephd |
1.101 |
#ifdef ALLOW_OFFLINE |
595 |
heimbach |
1.103 |
CALL TIMER_START('OFFLINE_MODEL_IO [FORWARD_STEP]',myThid) |
596 |
stephd |
1.101 |
CALL OFFLINE_MODEL_IO( myTime, myIter, myThid ) |
597 |
heimbach |
1.103 |
CALL TIMER_STOP ('OFFLINE_MODEL_IO [FORWARD_STEP]',myThid) |
598 |
stephd |
1.101 |
#else |
599 |
heimbach |
1.36 |
CALL TIMER_START('DO_THE_MODEL_IO [FORWARD_STEP]',myThid) |
600 |
heimbach |
1.12 |
CALL DO_THE_MODEL_IO( myTime, myIter, myThid ) |
601 |
heimbach |
1.36 |
CALL TIMER_STOP ('DO_THE_MODEL_IO [FORWARD_STEP]',myThid) |
602 |
stephd |
1.101 |
#endif |
603 |
adcroft |
1.1 |
|
604 |
|
|
C-- Save state for restarts |
605 |
heimbach |
1.36 |
CALL TIMER_START('WRITE_CHECKPOINT [FORWARD_STEP]',myThid) |
606 |
jmc |
1.77 |
CALL PACKAGES_WRITE_PICKUP( |
607 |
|
|
I .FALSE., myTime, myIter, myThid ) |
608 |
stephd |
1.101 |
#ifndef ALLOW_OFFLINE |
609 |
adcroft |
1.1 |
CALL WRITE_CHECKPOINT( |
610 |
jmc |
1.77 |
I .FALSE., myTime, myIter, myThid ) |
611 |
stephd |
1.101 |
#endif |
612 |
heimbach |
1.36 |
CALL TIMER_STOP ('WRITE_CHECKPOINT [FORWARD_STEP]',myThid) |
613 |
adcroft |
1.53 |
|
614 |
edhill |
1.71 |
#ifdef ALLOW_DEBUG |
615 |
heimbach |
1.57 |
IF ( debugLevel .GE. debLevB ) |
616 |
|
|
& CALL DEBUG_LEAVE('FORWARD_STEP',myThid) |
617 |
adcroft |
1.53 |
#endif |
618 |
adcroft |
1.1 |
|
619 |
jmc |
1.77 |
RETURN |
620 |
adcroft |
1.1 |
END |