model/src/the_model_main.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/the_model_main.F,v 1.35 2001/02/14 22:50:10 jmc Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

      SUBROUTINE THE_MODEL_MAIN(myThid)
C     /==========================================================\
C     | SUBROUTINE THE_MODEL_MAIN                                |
C     | o Master controlling routine for model using the MITgcm  |
C     |   UV parallel wrapper.                                   |
C     |==========================================================|
C     | THE_MODEL_MAIN is invoked by the MITgcm UV parallel      |
C     | wrapper with a single integer argument "myThid". This    |
C     | variable identifies the thread number of an instance of  |
C     | THE_MODEL_MAIN. Each instance of THE_MODEL_MAIN works    |
C     | on a particular region of the models domain and          |
C     | synchronises with other instances as necessary. The      |
C     | routine has to "understand" the MITgcm parallel          |
C     | environment and the numerical algorithm. Editing this    |
C     | routine is best done with some knowledge of both aspects.|
C     | Notes                                                    |
C     | =====                                                    |
C     | C*P* comments indicating place holders for which code is |
C     |      presently being developed.                          |
C     \==========================================================/
      IMPLICIT NONE
C
C     Call Tree
C     =========
C     
C      main ( eesupp )
C       |
C       .
C       .
C       . Generic environment initialisation ( see eesupp/src and
C       .                                      eesupp/inc )      
C       . multiple threads and/or processes are created in here
C       .
C       .
C       .
C       |
C       |-THE_MODEL_MAIN - Begin specific model. One instance
C       |  |               of this codes exists for each thread
C       |  |               and/or instance. Each instance manages
C       |  |               a specifc set of tiles.               
C       |  |
C       |  |--INITIALISE_FIXED
C       |  |   o Set model configuration (fixed arrays)
C       |  |     Topography, hydrography, timestep, grid, etc..
C       |  | 
C       |  |--THE_MAIN_LOOP
C       |  |  |
C       |  |  |--INITIALISE_VARIA
C       |  |  |   o Set initial conditions (variable arrays)
C       |  |  |
C  ==>  |  |  | ** Time stepping loop starts here **
C  |    |  |  |
C /|\   |  |  |
C  |    |  |  |--FORWARD_STEP
C /|\   |  |  |  |  o Does a single forward step of the model
C  |    |  |  |  | 
C /|\   |  |  |  |
C  |    |  |  |  |--LOAD_EXTERNAL_DATA
C /|\   |  |  |  |   o Load and/or set time dependent forcing fields
C  |    |  |  |  |
C /|\   |  |  |  |--DYNAMICS
C  |    |  |  |  |   o Evaluate "forward" terms
C /|\   |  |  |  |
C  |    |  |  |  |--SOLVE_FOR_PRESSURE
C /|\   |  |  |  |   o Find pressure field to keep flow non-divergent
C  |    |  |  |  |
C /|\   |  |  |  |--THE_CORRECTION_STEP
C  |    |  |  |  |   o Correct flow field with and cycle time-stepping arrays
C /|\   |  |  |  |
C  |    |  |  |  |--DO_GTERM_BLOCKING_EXCHANGES
C /|\   |  |  |  |   o Update overlap regions
C  |    |  |  |  |
C /|\   |  |  |  |--DO_THE_MODEL_IO
C  |    |  |  |  |   o Write model state
C /|\   |  |  |  |
C  |    |  |  |  |--WRITE_CHECKPOINT
C /|\   |  |  |  |   o Write restart file(s)
C  |    |  |  |
C /|\   |  |  |
C  |<== |  |  | ** Time stepping loop finishes here **
C       |  |  |
C       |  |  |--
C       |  |
C       |  |--WRITE_STATE
C       |  |--WRITE_CHECKPOINT
C       |
C       .
C       .
C       . Generic environment termination ( see eesupp/src and
C       .                                      eesupp/inc )      
C       .
C       .

C     == Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "DYNVARS.h"
#ifdef ALLOW_NONHYDROSTATIC
#include "CG3D.h"
#endif

C     == Routine arguments ==
C     myThid - Thread number for this instance of the routine.
      INTEGER myThid  

C     == Local variables ==
C     Note: Under the multi-threaded model myCurrentIter and 
C           myCurrentTime are local variables passed around as routine 
C           arguments. Although this is fiddly it saves the need to 
C           impose additional synchronisation points when they are 
C           updated.
C     myCurrentTime - Time counter for this thread
C     myCurrentIter - Iteration counter for this thread
      INTEGER myCurrentIter
      _RL     myCurrentTime

C--   This timer encompasses the whole code
      CALL TIMER_START('ALL                [THE_MODEL_MAIN]',myThid)


C--   Set model configuration (fixed arrays)
      CALL TIMER_START('INITIALISE_FIXED   [THE_MODEL_MAIN]',myThid)
      CALL INITIALISE_FIXED( myThid )
      CALL TIMER_STOP ('INITIALISE_FIXED   [THE_MODEL_MAIN]',myThid)


      myCurrentTime = startTime
      myCurrentIter = nIter0

C--   Call time stepping loop of full model
      CALL TIMER_START('THE_MAIN_LOOP      [THE_MODEL_MAIN]',myThid)
      CALL THE_MAIN_LOOP(myCurrentTime, myCurrentIter, myThid )
      CALL TIMER_STOP ('THE_MAIN_LOOP      [THE_MODEL_MAIN]',myThid)


      CALL TIMER_STOP ('ALL                [THE_MODEL_MAIN]',myThid)

C--   Write timer statistics
      IF ( myThid .EQ. 1 ) THEN
       CALL TIMER_PRINTALL( myThid )
       CALL COMM_STATS
      ENDIF

      RETURN
      END
1	jmc	1.36	C $Header: /u/gcmpack/models/MITgcmUV/model/src/the_model_main.F,v 1.35 2001/02/14 22:50:10 jmc Exp $
2			C $Name: $
3	cnh	1.1
4	adcroft	1.18	#include "CPP_OPTIONS.h"
5	cnh	1.1
6			SUBROUTINE THE_MODEL_MAIN(myThid)
7			C /==========================================================\
8			C \| SUBROUTINE THE_MODEL_MAIN \|
9			C \| o Master controlling routine for model using the MITgcm \|
10			C \| UV parallel wrapper. \|
11			C \|==========================================================\|
12			C \| THE_MODEL_MAIN is invoked by the MITgcm UV parallel \|
13			C \| wrapper with a single integer argument "myThid". This \|
14			C \| variable identifies the thread number of an instance of \|
15			C \| THE_MODEL_MAIN. Each instance of THE_MODEL_MAIN works \|
16			C \| on a particular region of the models domain and \|
17			C \| synchronises with other instances as necessary. The \|
18			C \| routine has to "understand" the MITgcm parallel \|
19			C \| environment and the numerical algorithm. Editing this \|
20			C \| routine is best done with some knowledge of both aspects.\|
21			C \| Notes \|
22			C \| ===== \|
23			C \| CP comments indicating place holders for which code is \|
24			C \| presently being developed. \|
25			C \==========================================================/
26	adcroft	1.24	IMPLICIT NONE
27	cnh	1.10	C
28			C Call Tree
29			C =========
30			C
31			C main ( eesupp )
32			C \|
33			C .
34			C .
35			C . Generic environment initialisation ( see eesupp/src and
36			C . eesupp/inc )
37			C . multiple threads and/or processes are created in here
38			C .
39			C .
40			C .
41			C \|
42			C \|-THE_MODEL_MAIN - Begin specific model. One instance
43			C \| \| of this codes exists for each thread
44			C \| \| and/or instance. Each instance manages
45			C \| \| a specifc set of tiles.
46			C \| \|
47	adcroft	1.32	C \| \|--INITIALISE_FIXED
48			C \| \| o Set model configuration (fixed arrays)
49	cnh	1.10	C \| \| Topography, hydrography, timestep, grid, etc..
50			C \| \|
51	adcroft	1.32	C \| \|--THE_MAIN_LOOP
52			C \| \| \|
53			C \| \| \|--INITIALISE_VARIA
54			C \| \| \| o Set initial conditions (variable arrays)
55			C \| \| \|
56			C ==> \| \| \| Time stepping loop starts here
57			C \| \| \| \|
58			C /\|\ \| \| \|
59			C \| \| \| \|--FORWARD_STEP
60			C /\|\ \| \| \| \| o Does a single forward step of the model
61			C \| \| \| \| \|
62			C /\|\ \| \| \| \|
63			C \| \| \| \| \|--LOAD_EXTERNAL_DATA
64			C /\|\ \| \| \| \| o Load and/or set time dependent forcing fields
65			C \| \| \| \| \|
66			C /\|\ \| \| \| \|--DYNAMICS
67			C \| \| \| \| \| o Evaluate "forward" terms
68			C /\|\ \| \| \| \|
69	jmc	1.35	C \| \| \| \| \|--SOLVE_FOR_PRESSURE
70			C /\|\ \| \| \| \| o Find pressure field to keep flow non-divergent
71	adcroft	1.32	C \| \| \| \| \|
72	jmc	1.35	C /\|\ \| \| \| \|--THE_CORRECTION_STEP
73			C \| \| \| \| \| o Correct flow field with and cycle time-stepping arrays
74	adcroft	1.32	C /\|\ \| \| \| \|
75			C \| \| \| \| \|--DO_GTERM_BLOCKING_EXCHANGES
76			C /\|\ \| \| \| \| o Update overlap regions
77			C \| \| \| \| \|
78	jmc	1.35	C /\|\ \| \| \| \|--DO_THE_MODEL_IO
79			C \| \| \| \| \| o Write model state
80			C /\|\ \| \| \| \|
81			C \| \| \| \| \|--WRITE_CHECKPOINT
82			C /\|\ \| \| \| \| o Write restart file(s)
83			C \| \| \| \|
84	adcroft	1.32	C /\|\ \| \| \|
85			C \|<== \| \| \| Time stepping loop finishes here
86			C \| \| \|
87			C \| \| \|--
88	cnh	1.10	C \| \|
89			C \| \|--WRITE_STATE
90	adcroft	1.17	C \| \|--WRITE_CHECKPOINT
91	cnh	1.10	C \|
92			C .
93			C .
94			C . Generic environment termination ( see eesupp/src and
95			C . eesupp/inc )
96			C .
97			C .
98	cnh	1.1
99			C == Global variables ===
100			#include "SIZE.h"
101			#include "EEPARAMS.h"
102			#include "PARAMS.h"
103	adcroft	1.26	#include "DYNVARS.h"
104	adcroft	1.27	#ifdef ALLOW_NONHYDROSTATIC
105	adcroft	1.26	#include "CG3D.h"
106	adcroft	1.27	#endif
107	cnh	1.1
108			C == Routine arguments ==
109			C myThid - Thread number for this instance of the routine.
110	cnh	1.6	INTEGER myThid
111	cnh	1.1
112			C == Local variables ==
113	cnh	1.7	C Note: Under the multi-threaded model myCurrentIter and
114			C myCurrentTime are local variables passed around as routine
115			C arguments. Although this is fiddly it saves the need to
116			C impose additional synchronisation points when they are
117			C updated.
118	jmc	1.34	C myCurrentTime - Time counter for this thread
119			C myCurrentIter - Iteration counter for this thread
120			INTEGER myCurrentIter
121			_RL myCurrentTime
122	cnh	1.1
123	adcroft	1.19	C-- This timer encompasses the whole code
124	adcroft	1.32	CALL TIMER_START('ALL [THE_MODEL_MAIN]',myThid)
125	adcroft	1.19
126
127	adcroft	1.32	C-- Set model configuration (fixed arrays)
128			CALL TIMER_START('INITIALISE_FIXED [THE_MODEL_MAIN]',myThid)
129			CALL INITIALISE_FIXED( myThid )
130			CALL TIMER_STOP ('INITIALISE_FIXED [THE_MODEL_MAIN]',myThid)
131	adcroft	1.26
132	adcroft	1.14
133	jmc	1.34	myCurrentTime = startTime
134			myCurrentIter = nIter0
135
136	adcroft	1.32	C-- Call time stepping loop of full model
137			CALL TIMER_START('THE_MAIN_LOOP [THE_MODEL_MAIN]',myThid)
138	jmc	1.34	CALL THE_MAIN_LOOP(myCurrentTime, myCurrentIter, myThid )
139	adcroft	1.32	CALL TIMER_STOP ('THE_MAIN_LOOP [THE_MODEL_MAIN]',myThid)
140	adcroft	1.12
141	adcroft	1.19
142	adcroft	1.32	CALL TIMER_STOP ('ALL [THE_MODEL_MAIN]',myThid)
143	cnh	1.7
144	adcroft	1.19	C-- Write timer statistics
145	cnh	1.20	IF ( myThid .EQ. 1 ) THEN
146			CALL TIMER_PRINTALL( myThid )
147			CALL COMM_STATS
148			ENDIF
149	cnh	1.1
150			RETURN
151			END