1 |
C $Header: /u/gcmpack/models/MITgcmUV/model/src/the_model_main.F,v 1.22 1998/11/06 22:44:49 cnh Exp $ |
2 |
|
3 |
#include "CPP_OPTIONS.h" |
4 |
|
5 |
SUBROUTINE THE_MODEL_MAIN(myThid) |
6 |
C /==========================================================\ |
7 |
C | SUBROUTINE THE_MODEL_MAIN | |
8 |
C | o Master controlling routine for model using the MITgcm | |
9 |
C | UV parallel wrapper. | |
10 |
C |==========================================================| |
11 |
C | THE_MODEL_MAIN is invoked by the MITgcm UV parallel | |
12 |
C | wrapper with a single integer argument "myThid". This | |
13 |
C | variable identifies the thread number of an instance of | |
14 |
C | THE_MODEL_MAIN. Each instance of THE_MODEL_MAIN works | |
15 |
C | on a particular region of the models domain and | |
16 |
C | synchronises with other instances as necessary. The | |
17 |
C | routine has to "understand" the MITgcm parallel | |
18 |
C | environment and the numerical algorithm. Editing this | |
19 |
C | routine is best done with some knowledge of both aspects.| |
20 |
C | Notes | |
21 |
C | ===== | |
22 |
C | C*P* comments indicating place holders for which code is | |
23 |
C | presently being developed. | |
24 |
C \==========================================================/ |
25 |
C |
26 |
C Call Tree |
27 |
C ========= |
28 |
C |
29 |
C main ( eesupp ) |
30 |
C | |
31 |
C . |
32 |
C . |
33 |
C . Generic environment initialisation ( see eesupp/src and |
34 |
C . eesupp/inc ) |
35 |
C . multiple threads and/or processes are created in here |
36 |
C . |
37 |
C . |
38 |
C . |
39 |
C | |
40 |
C |-THE_MODEL_MAIN - Begin specific model. One instance |
41 |
C | | of this codes exists for each thread |
42 |
C | | and/or instance. Each instance manages |
43 |
C | | a specifc set of tiles. |
44 |
C | | |
45 |
C | |--INITIALISE |
46 |
C | | o Set initial conditions and model configuration |
47 |
C | | Topography, hydrography, timestep, grid, etc.. |
48 |
C | | |
49 |
C ==> | | ** Time stepping loop starts here ** |
50 |
C | | | |
51 |
C /|\ | | |
52 |
C | | |--LOAD_EXTERNAL_DATA |
53 |
C /|\ | | o Load and/or set time dependent forcing fields |
54 |
C | | | |
55 |
C /|\ | |--DYNAMICS |
56 |
C | | | o Evaluate "forward" terms |
57 |
C /|\ | | |
58 |
C | | |--DO_THE_MODEL_IO |
59 |
C /|\ | | o Write model state |
60 |
C | | | |
61 |
C /|\ | |--SOLVE_FOR_PRESSURE |
62 |
C | | | o Find pressure field to keep flow non-divergent |
63 |
C /|\ | | |
64 |
C | | |--DO_GTERM_BLOCKING_EXCHANGES |
65 |
C /|\ | | o Update overlap regions |
66 |
C | | | |
67 |
C /|\ | |--WRITE_CHECKPOINT |
68 |
C | | | o Write restart file(s) |
69 |
C /|\ | | |
70 |
C | | | |
71 |
C |<== | | ** Time stepping loop finishes here ** |
72 |
C | | |
73 |
C | |--WRITE_STATE |
74 |
C | |--WRITE_CHECKPOINT |
75 |
C | |
76 |
C . |
77 |
C . |
78 |
C . Generic environment termination ( see eesupp/src and |
79 |
C . eesupp/inc ) |
80 |
C . |
81 |
C . |
82 |
|
83 |
C == Global variables === |
84 |
#include "SIZE.h" |
85 |
#include "EEPARAMS.h" |
86 |
#include "PARAMS.h" |
87 |
#include "CG2D.h" |
88 |
#include "DYNVARS.h" |
89 |
#include "AVER.h" |
90 |
|
91 |
C == Routine arguments == |
92 |
C myThid - Thread number for this instance of the routine. |
93 |
INTEGER myThid |
94 |
|
95 |
C == Local variables == |
96 |
C Note: Under the multi-threaded model myCurrentIter and |
97 |
C myCurrentTime are local variables passed around as routine |
98 |
C arguments. Although this is fiddly it saves the need to |
99 |
C impose additional synchronisation points when they are |
100 |
C updated. |
101 |
C myCurrentIter - Iteration counter for this thread |
102 |
C myCurrentTime - Time counter for this thread |
103 |
C I - Loop counter |
104 |
INTEGER I, myCurrentIter |
105 |
REAL myCurrentTime |
106 |
|
107 |
C-- This timer encompasses the whole code |
108 |
CALL TIMER_START('ALL',myThid) |
109 |
|
110 |
CALL TIMER_START('SPIN-UP',myThid) |
111 |
|
112 |
C-- Set model initial conditions |
113 |
CALL TIMER_START('INITIALISE [SPIN-UP]',myThid) |
114 |
CALL INITIALISE( myThid ) |
115 |
myCurrentTime = startTime |
116 |
myCurrentIter = nIter0 |
117 |
CALL TIMER_STOP ('INITIALISE [SPIN-UP]',myThid) |
118 |
|
119 |
C-- Dump for start state |
120 |
CALL TIMER_START('I/O (WRITE) [SPIN-UP]',myThid) |
121 |
CALL WRITE_STATE( .TRUE., myCurrentTime, myCurrentIter, myThid ) |
122 |
CALL TIMER_STOP ('I/O (WRITE) [SPIN-UP]',myThid) |
123 |
|
124 |
CALL TIMER_STOP ('SPIN-UP',myThid) |
125 |
|
126 |
C-- Begin time stepping loop |
127 |
CALL TIMER_START('MAIN LOOP',myThid) |
128 |
DO I=1, nTimeSteps |
129 |
|
130 |
C-- Load forcing/external data fields |
131 |
CALL TIMER_START('I/O (READ) [MAIN LOOP]',myThid) |
132 |
CALL LOAD_EXTERNAL_FIELDS( myCurrentTime, myCurrentIter, myThid ) |
133 |
CALL TIMER_STOP ('I/O (READ) [MAIN LOOP]',myThid) |
134 |
|
135 |
#ifdef INCLUDE_SHAPIRO_FILTER_CODE |
136 |
C-- Step forward all tiles, filter and exchange. |
137 |
CALL TIMER_START('SHAP_FILT [MAIN LOOP]',myThid) |
138 |
CALL SHAP_FILT( myCurrentTime, myCurrentIter, myThid ) |
139 |
CALL TIMER_STOP ('SHAP_FILT [MAIN LOOP]',myThid) |
140 |
#endif |
141 |
|
142 |
C-- Set Open Boundaries Values |
143 |
IF (openBoundaries) THEN |
144 |
CALL TIMER_START('OBCS [MAIN LOOP]',myThid) |
145 |
CALL SET_OBCS( myCurrentTime, myThid ) |
146 |
CALL TIMER_STOP ('OBCS [MAIN LOOP]',myThid) |
147 |
ENDIF |
148 |
|
149 |
C-- Step forward fields and calculate time tendency terms |
150 |
CALL TIMER_START('DYNAMICS [MAIN LOOP]',myThid) |
151 |
CALL DYNAMICS( myCurrentTime, myCurrentIter, myThid ) |
152 |
CALL TIMER_STOP ('DYNAMICS [MAIN LOOP]',myThid) |
153 |
|
154 |
C-- Do time averages |
155 |
#ifdef INCLUDE_DIAGNOSTICS_INTERFACE_CODE |
156 |
CALL TIMER_START('I/O (WRITE) [MAIN LOOP]',myThid) |
157 |
IF (taveFreq.GT.0.) THEN |
158 |
CALL WRITE_TIME_AVERAGES( myCurrentTime, myCurrentIter, myThid ) |
159 |
ENDIF |
160 |
CALL TIMER_STOP ('I/O (WRITE) [MAIN LOOP]',myThid) |
161 |
#endif |
162 |
|
163 |
C-- Do IO if needed. |
164 |
C Note: |
165 |
C ===== |
166 |
C At this point model arrays hold U,V,T,S at "time-level" N |
167 |
C and cg2d_x at "time-level" N-1/2 where N = I+timeLevBase-1. |
168 |
C By convention this is taken to be the model "state". |
169 |
CALL TIMER_START('I/O (WRITE) [MAIN LOOP]',myThid) |
170 |
CALL DO_THE_MODEL_IO( myCurrentTime, myCurrentIter, myThid ) |
171 |
CALL TIMER_STOP ('I/O (WRITE) [MAIN LOOP]',myThid) |
172 |
|
173 |
C-- Solve elliptic equation(s). |
174 |
C Two-dimensional only for conventional hydrostatic or |
175 |
C three-dimensional for non-hydrostatic and/or IGW scheme. |
176 |
CALL TIMER_START('SOLVE_FOR_PRESSURE [MAIN LOOP]',myThid) |
177 |
CALL SOLVE_FOR_PRESSURE( myThid ) |
178 |
CALL TIMER_STOP ('SOLVE_FOR_PRESSURE [MAIN LOOP]',myThid) |
179 |
|
180 |
C-- Do "blocking" sends and receives for tendency "overlap" terms |
181 |
CALL TIMER_START('BLOCKING_EXCHANGES [MAIN LOOP]',myThid) |
182 |
CALL DO_GTERM_BLOCKING_EXCHANGES( myThid ) |
183 |
CALL TIMER_STOP ('BLOCKING_EXCHANGES [MAIN LOOP]',myThid) |
184 |
|
185 |
myCurrentIter = myCurrentIter + 1 |
186 |
myCurrentTime = myCurrentTime + deltaTClock |
187 |
|
188 |
C-- Save state for restarts |
189 |
C Note: |
190 |
C ===== |
191 |
C Because of the ordering of the timestepping code and |
192 |
C tendency term code at end of loop model arrays hold |
193 |
C U,V,T,S at "time-level" N but gu, gv, gs, gt, guNM1,... |
194 |
C at "time-level" N+1/2 (guNM1 at "time-level" N+1/2 is |
195 |
C gu at "time-level" N-1/2) and cg2d_x at "time-level" N+1/2. |
196 |
C where N = I+timeLevBase-1 |
197 |
C Thus a checkpoint contains U.0000000000, GU.0000000001 and |
198 |
C cg2d_x.0000000001 in the indexing scheme used for the model |
199 |
C "state" files. This example is referred to as a checkpoint |
200 |
C at time level 1 |
201 |
CALL TIMER_START('I/O (WRITE) [MAIN LOOP]',myThid) |
202 |
CALL |
203 |
& WRITE_CHECKPOINT( .FALSE., myCurrentTime, myCurrentIter, myThid ) |
204 |
CALL TIMER_STOP ('I/O (WRITE) [MAIN LOOP]',myThid) |
205 |
|
206 |
ENDDO |
207 |
CALL TIMER_STOP ('MAIN LOOP',myThid) |
208 |
CALL TIMER_START('SPIN-DOWN',myThid) |
209 |
|
210 |
C-- Final checkpoint (incase the in-loop checkpoint was missed) |
211 |
CALL TIMER_START('I/O (WRITE) [SPIN-DOWN]',myThid) |
212 |
CALL |
213 |
& WRITE_CHECKPOINT( .TRUE., myCurrentTime, myCurrentIter, myThid ) |
214 |
CALL TIMER_STOP ('I/O (WRITE) [SPIN-DOWN]',myThid) |
215 |
|
216 |
C-- Set Open Boundaries Values |
217 |
IF (openBoundaries) THEN |
218 |
CALL TIMER_START('OBCS [SPIN_DOWN]',myThid) |
219 |
CALL SET_OBCS( myCurrentTime, myThid ) |
220 |
CALL TIMER_STOP ('OBCS [SPIN_DOWN]',myThid) |
221 |
ENDIF |
222 |
|
223 |
C-- Step-forward U/V/Theta/Salt for purposes of final I/O dump |
224 |
CALL TIMER_START('DYNAMICS [SPIN-DOWN]',myThid) |
225 |
CALL DYNAMICS( myCurrentTime, myCurrentIter, myThid ) |
226 |
CALL TIMER_STOP ('DYNAMICS [SPIN-DOWN]',myThid) |
227 |
|
228 |
C-- Do time averages |
229 |
#ifdef ALLOW_DIAGNOSTICS |
230 |
IF (taveFreq.GT.0.) THEN |
231 |
CALL TIMER_START('I/O (WRITE) [SPIN-DOWN]',myThid) |
232 |
CALL WRITE_TIME_AVERAGES( myCurrentTime, myCurrentIter, myThid ) |
233 |
CALL TIMER_STOP ('I/O (WRITE) [SPIN-DOWN]',myThid) |
234 |
ENDIF |
235 |
#endif |
236 |
|
237 |
C-- Dump for end state |
238 |
CALL TIMER_START('I/O (WRITE) [SPIN-DOWN]',myThid) |
239 |
CALL WRITE_STATE( .FALSE., myCurrentTime, myCurrentIter, myThid ) |
240 |
CALL TIMER_STOP ('I/O (WRITE) [SPIN-DOWN]',myThid) |
241 |
|
242 |
CALL TIMER_STOP ('SPIN-DOWN',myThid) |
243 |
CALL TIMER_STOP ('ALL',myThid) |
244 |
|
245 |
C-- Write timer statistics |
246 |
IF ( myThid .EQ. 1 ) THEN |
247 |
CALL TIMER_PRINTALL( myThid ) |
248 |
CALL COMM_STATS |
249 |
ENDIF |
250 |
|
251 |
RETURN |
252 |
END |