/[MITgcm]/MITgcm/model/src/the_model_main.F
ViewVC logotype

Diff of /MITgcm/model/src/the_model_main.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.5 by cnh, Fri Apr 24 03:32:40 1998 UTC revision 1.25 by adcroft, Fri Mar 12 16:44:04 1999 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    
3  #include "CPP_EEOPTIONS.h"  #include "CPP_OPTIONS.h"
4    
5        SUBROUTINE THE_MODEL_MAIN(myThid)        SUBROUTINE THE_MODEL_MAIN(myThid)
6  C     /==========================================================\  C     /==========================================================\
# Line 22  C     | ===== Line 22  C     | =====
22  C     | C*P* comments indicating place holders for which code is |  C     | C*P* comments indicating place holders for which code is |
23  C     |      presently being developed.                          |  C     |      presently being developed.                          |
24  C     \==========================================================/  C     \==========================================================/
25          IMPLICIT NONE
26    C
27    C     Call Tree
28    C     =========
29    C    
30    C      main ( eesupp )
31    C       |
32    C       .
33    C       .
34    C       . Generic environment initialisation ( see eesupp/src and
35    C       .                                      eesupp/inc )      
36    C       . multiple threads and/or processes are created in here
37    C       .
38    C       .
39    C       .
40    C       |
41    C       |-THE_MODEL_MAIN - Begin specific model. One instance
42    C       |  |               of this codes exists for each thread
43    C       |  |               and/or instance. Each instance manages
44    C       |  |               a specifc set of tiles.              
45    C       |  |
46    C       |  |--INITIALISE
47    C       |  |   o Set initial conditions and model configuration
48    C       |  |     Topography, hydrography, timestep, grid, etc..
49    C       |  |
50    C  ==>  |  | ** Time stepping loop starts here **
51    C  |    |  |
52    C /|\   |  |
53    C  |    |  |--LOAD_EXTERNAL_DATA
54    C /|\   |  |   o Load and/or set time dependent forcing fields
55    C  |    |  |
56    C /|\   |  |--DYNAMICS
57    C  |    |  |   o Evaluate "forward" terms
58    C /|\   |  |
59    C  |    |  |--DO_THE_MODEL_IO
60    C /|\   |  |   o Write model state
61    C  |    |  |
62    C /|\   |  |--SOLVE_FOR_PRESSURE
63    C  |    |  |   o Find pressure field to keep flow non-divergent
64    C /|\   |  |
65    C  |    |  |--DO_GTERM_BLOCKING_EXCHANGES
66    C /|\   |  |   o Update overlap regions
67    C  |    |  |
68    C /|\   |  |--WRITE_CHECKPOINT
69    C  |    |  |   o Write restart file(s)
70    C /|\   |  |
71    C  |    |  |
72    C  |<== |  | ** Time stepping loop finishes here **
73    C       |  |
74    C       |  |--WRITE_STATE
75    C       |  |--WRITE_CHECKPOINT
76    C       |
77    C       .
78    C       .
79    C       . Generic environment termination ( see eesupp/src and
80    C       .                                      eesupp/inc )      
81    C       .
82    C       .
83    
84  C     == Global variables ===  C     == Global variables ===
85  #include "SIZE.h"  #include "SIZE.h"
# Line 32  C     == Global variables === Line 90  C     == Global variables ===
90    
91  C     == Routine arguments ==  C     == Routine arguments ==
92  C     myThid - Thread number for this instance of the routine.  C     myThid - Thread number for this instance of the routine.
93        INTEGER myThid        INTEGER myThid  
94    
95  C     == Local variables ==  C     == Local variables ==
96  C     Note: Under the multi-threaded model myCurrentIter and myCurrentTime  C     Note: Under the multi-threaded model myCurrentIter and
97  C           are local variables passed around as routine arguments. Although  C           myCurrentTime are local variables passed around as routine
98  C           this is fiddly it saves the need to impose additional synchronisation  C           arguments. Although this is fiddly it saves the need to
99  C           points when they are updated.  C           impose additional synchronisation points when they are
100    C           updated.
101  C     myCurrentIter - Iteration counter for this thread  C     myCurrentIter - Iteration counter for this thread
102  C     myCurrentTime - Time counter for this thread  C     myCurrentTime - Time counter for this thread
103  C     I             - Loop counter  C     I             - Loop counter
104        INTEGER I, myCurrentIter        INTEGER I, myCurrentIter
105        REAL    myCurrentTime        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  C--   Set model initial conditions
113          CALL TIMER_START('INITIALISE          [SPIN-UP]',myThid)
114        CALL INITIALISE( myThid )        CALL INITIALISE( myThid )
115        myCurrentTime = startTime        myCurrentTime = startTime
116        myCurrentIter = nIter0        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  C--   Begin time stepping loop
127          CALL TIMER_START('MAIN LOOP',myThid)
128        DO I=1, nTimeSteps        DO I=1, nTimeSteps
129    
130  C--    Do IO if needed.  C--    Load forcing/external data fields
131         CALL DO_THE_MODEL_IO( myCurrentIter, myThid )         CALL TIMER_START('I/O (READ)         [MAIN LOOP]',myThid)
132           CALL LOAD_EXTERNAL_FIELDS( myCurrentTime, myCurrentIter, myThid )
133  C--    Load offline tracer fields         CALL TIMER_STOP ('I/O (READ)         [MAIN LOOP]',myThid)
134         IF ( MOD(myCurrentIter,numStepsPerPickup) .EQ. 1 ) THEN  
135  C       I/O  #ifdef INCLUDE_SHAPIRO_FILTER_CODE
136  C       o Writes to arrays are performed by their own thread (to ensure  C--    Step forward all tiles, filter and exchange.
137  C         physical memory allocation will pair with thread).         CALL TIMER_START('SHAP_FILT          [MAIN LOOP]',myThid)
138  C       o Thread 1 reads into a buffer.         CALL SHAP_FILT( myCurrentTime, myCurrentIter, myThid )
139  C       CALL LOAD_OFFLINE_FIELDS( myCurrentTime, myCurrentIter, myThid )         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         ENDIF
148    
149  C--    Step forward fields and calculate time tendency terms  C--    Step forward fields and calculate time tendency terms
150         CALL DYNAMICS( myThid )         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).  C--    Solve elliptic equation(s).
174  C      Two-dimensional only for conventional hydrostatic or three-dimensional  C      Two-dimensional only for conventional hydrostatic or
175  C      for non-hydrostatic and/or IGW scheme.  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 )         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  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 )         CALL DO_GTERM_BLOCKING_EXCHANGES( myThid )
183           CALL TIMER_STOP ('BLOCKING_EXCHANGES [MAIN LOOP]',myThid)
184    
185         myCurrentIter = myCurrentIter + 1         myCurrentIter = myCurrentIter + 1
186         myCurrentTime = myCurrentTime  + deltaTtracer         myCurrentTime = myCurrentTime + deltaTClock
187    
188  C--    Save state for restarts  C--    Save state for restarts
189  C*P*   CALL CHECKPOINT( myThid )  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        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        RETURN
252        END        END
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.25
  ViewVC Help
Powered by ViewVC 1.1.22