1 |
C $Header: /u/gcmpack/MITgcm/model/src/forward_step.F,v 1.35 2002/10/07 16:24:45 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "CPP_OPTIONS.h" |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: FORWARD_STEP |
8 |
C !INTERFACE: |
9 |
SUBROUTINE FORWARD_STEP( iloop, myTime, myIter, myThid ) |
10 |
|
11 |
C !DESCRIPTION: \bv |
12 |
C *================================================================== |
13 |
C | SUBROUTINE forward_step |
14 |
C | o Run the ocean model and, optionally, evaluate a cost function. |
15 |
C *================================================================== |
16 |
C | |
17 |
C | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and |
18 |
C | Adjoint Model Compiler (TAMC). For this purpose the initialization |
19 |
C | of the model was split into two parts. Those parameters that do |
20 |
C | not depend on a specific model run are set in INITIALISE_FIXED, |
21 |
C | whereas those that do depend on the specific realization are |
22 |
C | initialized in INITIALISE_VARIA. |
23 |
C | |
24 |
C *================================================================== |
25 |
C \ev |
26 |
|
27 |
C !USES: |
28 |
IMPLICIT NONE |
29 |
C == Global variables == |
30 |
#include "SIZE.h" |
31 |
#include "EEPARAMS.h" |
32 |
#include "PARAMS.h" |
33 |
#include "DYNVARS.h" |
34 |
#include "FFIELDS.h" |
35 |
|
36 |
#ifdef ALLOW_NONHYDROSTATIC |
37 |
#include "CG3D.h" |
38 |
#endif |
39 |
|
40 |
#ifdef ALLOW_SHAP_FILT |
41 |
#include "SHAP_FILT.h" |
42 |
#endif |
43 |
#ifdef ALLOW_ZONAL_FILT |
44 |
#include "ZONAL_FILT.h" |
45 |
#endif |
46 |
|
47 |
#ifdef ALLOW_AUTODIFF_TAMC |
48 |
# include "tamc.h" |
49 |
# include "ctrl.h" |
50 |
# include "ctrl_dummy.h" |
51 |
# include "cost.h" |
52 |
# ifdef INCLUDE_EXTERNAL_FORCING_PACKAGE |
53 |
# include "exf_fields.h" |
54 |
# ifdef ALLOW_BULKFORMULAE |
55 |
# include "exf_constants.h" |
56 |
# endif |
57 |
# endif |
58 |
# ifdef ALLOW_OBCS |
59 |
# include "OBCS.h" |
60 |
# endif |
61 |
#endif |
62 |
|
63 |
C !LOCAL VARIABLES: |
64 |
C == Routine arguments == |
65 |
C note: under the multi-threaded model myiter and |
66 |
C mytime are local variables passed around as routine |
67 |
C arguments. Although this is fiddly it saves the need to |
68 |
C impose additional synchronisation points when they are |
69 |
C updated. |
70 |
C myiter - iteration counter for this thread |
71 |
C mytime - time counter for this thread |
72 |
C mythid - thread number for this instance of the routine. |
73 |
integer iloop |
74 |
integer mythid |
75 |
integer myiter |
76 |
_RL mytime |
77 |
INTEGER bi,bj |
78 |
|
79 |
CEOP |
80 |
|
81 |
|
82 |
#ifdef ALLOW_AUTODIFF_TAMC |
83 |
C-- Reset the model iteration counter and the model time. |
84 |
myiter = nIter0 + (iloop-1) |
85 |
mytime = startTime + float(iloop-1)*deltaTclock |
86 |
#endif |
87 |
|
88 |
#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_AUTODIFF_MONITOR)) |
89 |
C Include call to a dummy routine. Its adjoint will be |
90 |
C called at the proper place in the adjoint code. |
91 |
C The adjoint routine will print out adjoint values |
92 |
C if requested. The location of the call is important, |
93 |
C it has to be after the adjoint of the exchanges |
94 |
C (DO_GTERM_BLOCKING_EXCHANGES). |
95 |
CALL DUMMY_IN_STEPPING( myTime, myIter, myThid ) |
96 |
CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid ) |
97 |
#endif |
98 |
|
99 |
#ifdef EXACT_CONSERV |
100 |
IF (exactConserv) THEN |
101 |
C-- Update etaH(n+1) : |
102 |
CALL TIMER_START('UPDATE_ETAH [FORWARD_STEP]',mythid) |
103 |
CALL UPDATE_ETAH( myTime, myIter, myThid ) |
104 |
CALL TIMER_STOP ('UPDATE_ETAH [FORWARD_STEP]',mythid) |
105 |
ENDIF |
106 |
#endif /* EXACT_CONSERV */ |
107 |
|
108 |
#ifdef NONLIN_FRSURF |
109 |
C-- compute the future surface level thickness |
110 |
C according to etaH(n+1) |
111 |
IF ( nonlinFreeSurf.GT.0) THEN |
112 |
CALL TIMER_START('CALC_SURF_DR [FORWARD_STEP]',mythid) |
113 |
CALL CALC_SURF_DR(etaH, myTime, myIter, myThid ) |
114 |
CALL TIMER_STOP ('CALC_SURF_DR [FORWARD_STEP]',mythid) |
115 |
ENDIF |
116 |
#endif /* NONLIN_FRSURF */ |
117 |
|
118 |
C-- Load forcing/external data fields. |
119 |
#ifdef ALLOW_AUTODIFF_TAMC |
120 |
c************************************** |
121 |
#include "checkpoint_lev1_directives.h" |
122 |
c************************************** |
123 |
#endif |
124 |
#ifdef INCLUDE_EXTERNAL_FORCING_PACKAGE |
125 |
C NOTE, that although the exf package is part of the |
126 |
C distribution, it is not currently maintained, i.e. |
127 |
C exf is disabled by default in genmake. |
128 |
IF ( .not. useSEAICE ) THEN |
129 |
CALL TIMER_START('EXF_GETFORCING [FORWARD_STEP]',mythid) |
130 |
CALL EXF_GETFORCING( mytime, myiter, mythid ) |
131 |
CALL TIMER_STOP ('EXF_GETFORCING [FORWARD_STEP]',mythid) |
132 |
ENDIF |
133 |
#else |
134 |
IF ( .not. useSEAICE ) THEN |
135 |
CALL TIMER_START('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid) |
136 |
CALL EXTERNAL_FIELDS_LOAD( mytime, myiter, mythid ) |
137 |
CALL TIMER_STOP ('EXTERNAL_FIELDS_LOAD[FORWARD_STEP]',mythid) |
138 |
ENDIF |
139 |
#endif /* INCLUDE_EXTERNAL_FORCING_PACKAGE */ |
140 |
|
141 |
#ifdef ALLOW_SEAICE |
142 |
C-- Call sea ice model to compute forcing/external data fields. In |
143 |
C addition to computing prognostic sea-ice variables and diagnosing the |
144 |
C forcing/external data fields that drive the ocean model, SEAICE_MODEL |
145 |
C also sets theta to the freezing point under sea-ice. The implied |
146 |
C surface heat flux is then stored in variable surfaceTendencyTice, |
147 |
C which is needed by KPP package (kpp_calc.F and kpp_transport_t.F) |
148 |
C to diagnose surface buoyancy fluxes and for the non-local transport |
149 |
C term. Because this call precedes model thermodynamics, temperature |
150 |
C under sea-ice may not be "exactly" at the freezing point by the time |
151 |
C theta is dumped or time-averaged. |
152 |
IF ( useSEAICE ) THEN |
153 |
CALL TIMER_START('SEAICE_MODEL [FORWARD_STEP]',myThid) |
154 |
CALL SEAICE_MODEL( myTime, myIter, myThid ) |
155 |
CALL TIMER_STOP ('SEAICE_MODEL [FORWARD_STEP]',myThid) |
156 |
ENDIF |
157 |
#endif ALLOW_SEAICE |
158 |
|
159 |
C-- Step forward fields and calculate time tendency terms. |
160 |
CALL TIMER_START('THERMODYNAMICS [FORWARD_STEP]',mythid) |
161 |
CALL THERMODYNAMICS( myTime, myIter, myThid ) |
162 |
CALL TIMER_STOP ('THERMODYNAMICS [FORWARD_STEP]',mythid) |
163 |
|
164 |
C-- do exchanges (needed for DYNAMICS) when using stagger time-step : |
165 |
CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
166 |
CALL DO_STAGGER_FIELDS_EXCHANGES( myTime, myIter, myThid ) |
167 |
CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
168 |
|
169 |
#ifdef ALLOW_SHAP_FILT |
170 |
IF (useSHAP_FILT .AND. |
171 |
& staggerTimeStep .AND. shap_filt_TrStagg ) THEN |
172 |
CALL TIMER_START('SHAP_FILT [FORWARD_STEP]',myThid) |
173 |
CALL SHAP_FILT_APPLY_TS( gT, gS, myTime, myIter, myThid ) |
174 |
CALL TIMER_STOP ('SHAP_FILT [FORWARD_STEP]',myThid) |
175 |
ENDIF |
176 |
#endif |
177 |
#ifdef ALLOW_ZONAL_FILT |
178 |
IF (useZONAL_FILT .AND. |
179 |
& staggerTimeStep .AND. zonal_filt_TrStagg ) THEN |
180 |
CALL TIMER_START('ZONAL_FILT_APPLY [FORWARD_STEP]',myThid) |
181 |
CALL ZONAL_FILT_APPLY_TS( gT, gS, myThid ) |
182 |
CALL TIMER_STOP ('ZONAL_FILT_APPLY [FORWARD_STEP]',myThid) |
183 |
ENDIF |
184 |
#endif |
185 |
|
186 |
C-- Step forward fields and calculate time tendency terms. |
187 |
IF ( momStepping ) THEN |
188 |
CALL TIMER_START('DYNAMICS [FORWARD_STEP]',mythid) |
189 |
CALL DYNAMICS( myTime, myIter, myThid ) |
190 |
CALL TIMER_STOP ('DYNAMICS [FORWARD_STEP]',mythid) |
191 |
ENDIF |
192 |
|
193 |
#ifdef ALLOW_NONHYDROSTATIC |
194 |
C-- Step forward W field in N-H algorithm |
195 |
IF ( momStepping .AND. nonHydrostatic ) THEN |
196 |
CALL TIMER_START('CALC_GW [FORWARD_STEP]',myThid) |
197 |
CALL CALC_GW(myThid) |
198 |
CALL TIMER_STOP ('CALC_GW [FORWARD_STEP]',myThid) |
199 |
ENDIF |
200 |
#endif |
201 |
|
202 |
#ifdef NONLIN_FRSURF |
203 |
C-- update hfacC,W,S and recip_hFac according to etaH(n+1) : |
204 |
IF ( nonlinFreeSurf.GT.0) THEN |
205 |
CALL TIMER_START('UPDATE_SURF_DR [FORWARD_STEP]',mythid) |
206 |
CALL UPDATE_SURF_DR( myTime, myIter, myThid ) |
207 |
CALL TIMER_STOP ('UPDATE_SURF_DR [FORWARD_STEP]',myThid) |
208 |
ENDIF |
209 |
C- update also CG2D matrix (and preconditioner) |
210 |
IF ( momStepping .AND. nonlinFreeSurf.GT.2 ) THEN |
211 |
CALL TIMER_START('UPDATE_CG2D [FORWARD_STEP]',mythid) |
212 |
CALL UPDATE_CG2D( myTime, myIter, myThid ) |
213 |
CALL TIMER_START('UPDATE_CG2D [FORWARD_STEP]',mythid) |
214 |
ENDIF |
215 |
#endif |
216 |
|
217 |
C-- Apply Filters to u*,v* before SOLVE_FOR_PRESSURE |
218 |
#ifdef ALLOW_SHAP_FILT |
219 |
IF (useSHAP_FILT .AND. shap_filt_uvStar) THEN |
220 |
CALL TIMER_START('SHAP_FILT [FORWARD_STEP]',myThid) |
221 |
CALL SHAP_FILT_APPLY_UV( gUnm1,gVnm1, myTime,myIter,myThid ) |
222 |
IF (implicDiv2Dflow.LT.1.) THEN |
223 |
C-- Explicit+Implicit part of the Barotropic Flow Divergence |
224 |
C => Filtering of uVel,vVel is necessary |
225 |
CALL SHAP_FILT_APPLY_UV( uVel,vVel, myTime,myIter,myThid ) |
226 |
ENDIF |
227 |
CALL TIMER_STOP ('SHAP_FILT [FORWARD_STEP]',myThid) |
228 |
ENDIF |
229 |
#endif |
230 |
#ifdef ALLOW_ZONAL_FILT |
231 |
IF (useZONAL_FILT .AND. zonal_filt_uvStar) THEN |
232 |
CALL TIMER_START('ZONAL_FILT_APPLY [FORWARD_STEP]',myThid) |
233 |
CALL ZONAL_FILT_APPLY_UV( gUnm1, gVnm1, myThid ) |
234 |
IF (implicDiv2Dflow.LT.1.) THEN |
235 |
C-- Explicit+Implicit part of the Barotropic Flow Divergence |
236 |
C => Filtering of uVel,vVel is necessary |
237 |
CALL ZONAL_FILT_APPLY_UV( uVel, vVel, myThid ) |
238 |
ENDIF |
239 |
CALL TIMER_STOP ('ZONAL_FILT_APPLY [FORWARD_STEP]',myThid) |
240 |
ENDIF |
241 |
#endif |
242 |
|
243 |
C-- Solve elliptic equation(s). |
244 |
C Two-dimensional only for conventional hydrostatic or |
245 |
C three-dimensional for non-hydrostatic and/or IGW scheme. |
246 |
IF ( momStepping ) THEN |
247 |
CALL TIMER_START('SOLVE_FOR_PRESSURE [FORWARD_STEP]',myThid) |
248 |
CALL SOLVE_FOR_PRESSURE(myTime, myIter, myThid) |
249 |
CALL TIMER_STOP ('SOLVE_FOR_PRESSURE [FORWARD_STEP]',myThid) |
250 |
ENDIF |
251 |
|
252 |
C-- Correct divergence in flow field and cycle time-stepping |
253 |
C arrays (for all fields) ; update time-counter |
254 |
myIter = nIter0 + iLoop |
255 |
myTime = startTime + deltaTClock * float(iLoop) |
256 |
CALL TIMER_START('THE_CORRECTION_STEP [FORWARD_STEP]',myThid) |
257 |
CALL THE_CORRECTION_STEP(myTime, myIter, myThid) |
258 |
CALL TIMER_STOP ('THE_CORRECTION_STEP [FORWARD_STEP]',myThid) |
259 |
|
260 |
C-- Do "blocking" sends and receives for tendency "overlap" terms |
261 |
c CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
262 |
c CALL DO_GTERM_BLOCKING_EXCHANGES( myThid ) |
263 |
c CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
264 |
|
265 |
C-- Do "blocking" sends and receives for field "overlap" terms |
266 |
CALL TIMER_START('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
267 |
CALL DO_FIELDS_BLOCKING_EXCHANGES( myThid ) |
268 |
CALL TIMER_STOP ('BLOCKING_EXCHANGES [FORWARD_STEP]',myThid) |
269 |
|
270 |
#ifdef ALLOW_FLT |
271 |
C-- Calculate float trajectories |
272 |
IF (useFLT) THEN |
273 |
CALL TIMER_START('FLOATS [FORWARD_STEP]',myThid) |
274 |
CALL FLT_MAIN(myIter,myTime, myThid) |
275 |
CALL TIMER_STOP ('FLOATS [FORWARD_STEP]',myThid) |
276 |
ENDIF |
277 |
#endif |
278 |
|
279 |
#ifndef EXCLUDE_MONITOR |
280 |
C-- Check status of solution (statistics, cfl, etc...) |
281 |
CALL TIMER_START('MONITOR [FORWARD_STEP]',mythid) |
282 |
CALL MONITOR( myIter, myTime, myThid ) |
283 |
CALL TIMER_STOP ('MONITOR [FORWARD_STEP]',myThid) |
284 |
#endif /* EXCLUDE_MONITOR */ |
285 |
|
286 |
C-- Do IO if needed. |
287 |
CALL TIMER_START('DO_THE_MODEL_IO [FORWARD_STEP]',myThid) |
288 |
CALL DO_THE_MODEL_IO( myTime, myIter, myThid ) |
289 |
CALL TIMER_STOP ('DO_THE_MODEL_IO [FORWARD_STEP]',myThid) |
290 |
|
291 |
C-- Save state for restarts |
292 |
C Note: (jmc: is it still the case after ckp35 ?) |
293 |
C ===== |
294 |
C Because of the ordering of the timestepping code and |
295 |
C tendency term code at end of loop model arrays hold |
296 |
C U,V,T,S at "time-level" N but gu, gv, gs, gt, guNM1,... |
297 |
C at "time-level" N+1/2 (guNM1 at "time-level" N+1/2 is |
298 |
C gu at "time-level" N-1/2) and etaN at "time-level" N+1/2. |
299 |
C where N = I+timeLevBase-1 |
300 |
C Thus a checkpoint contains U.0000000000, GU.0000000001 and |
301 |
C etaN.0000000001 in the indexing scheme used for the model |
302 |
C "state" files. This example is referred to as a checkpoint |
303 |
C at time level 1 |
304 |
CALL TIMER_START('WRITE_CHECKPOINT [FORWARD_STEP]',myThid) |
305 |
CALL WRITE_CHECKPOINT( |
306 |
& .FALSE., myTime, myIter, myThid ) |
307 |
CALL TIMER_STOP ('WRITE_CHECKPOINT [FORWARD_STEP]',myThid) |
308 |
|
309 |
END |