model/src/the_main_loop.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/the_main_loop.F,v 1.2 2001/02/04 14:38:48 cnh Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

      SUBROUTINE THE_MAIN_LOOP(myCurrentTime, myCurrentIter, myThid )
C     /==========================================================\
C     | SUBROUTINE THE_MAIN_LOOP                                 |
C     | o This contains the principal time loop                  |
C     |==========================================================|
C     | THE_MAIN_LOOP is invoked by THE_MODEL_MAIN               |
C     \==========================================================/
      IMPLICIT NONE
C
C     Call Tree
C     =========
C     
C       |-THE_MODEL_MAIN
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 /|\   |  |  | 
C  |    |  |  |
C  |<== |  |  | ** Time stepping loop finishes here **
C 

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

C     == Routine arguments ==
C     myCurrentTime - Time counter for this thread
C     myCurrentIter - Iteration counter for this thread
C     myThid - Thread number for this instance of the routine.
      INTEGER myCurrentIter, myThid
      _RL     myCurrentTime

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     ILOOP         - Loop counter
      INTEGER ILOOP

      CALL TIMER_START('SPIN-UP            [THE_MAIN_LOOP]',myThid)

C--   Set initial conditions (variable arrays)
      CALL TIMER_START('INITIALISE_VARIA   [THE_MAIN_LOOP]',myThid)
      CALL INITIALISE_VARIA( myThid )
      CALL TIMER_STOP ('INITIALISE_VARIA   [THE_MAIN_LOOP]',myThid)

C--   Dump starting state
      CALL TIMER_START('I/O (WRITE)        [THE_MAIN_LOOP]',myThid)
      CALL WRITE_STATE( .TRUE., myCurrentTime, myCurrentIter, myThid )
      CALL TIMER_STOP ('I/O (WRITE)        [THE_MAIN_LOOP]',myThid)

      CALL TIMER_STOP ('SPIN-UP            [THE_MAIN_LOOP]',myThid)

C     ===========================================================
C--   Begin time stepping loop
      CALL TIMER_START('MAIN LOOP          [THE_MAIN_LOOP]',myThid)
      DO ILOOP=1, nTimeSteps

C--    Step forward fields and calculate time tendency terms
       CALL TIMER_START('FORWARD_STEP       [THE_MAIN_LOOP]',myThid)
       CALL FORWARD_STEP( .FALSE., ILOOP,
     &                    myCurrentTime, myCurrentIter, myThid )
       CALL TIMER_STOP ('FORWARD_STEP       [THE_MAIN_LOOP]',myThid)

      ENDDO
      CALL TIMER_STOP ('MAIN LOOP          [THE_MAIN_LOOP]',myThid)
C     ===========================================================

      CALL TIMER_START('SPIN-DOWN          [THE_MAIN_LOOP]',myThid)

C--   Final checkpoint (incase the in-loop checkpoint was missed)
      CALL TIMER_START('I/O (WRITE)        [THE_MAIN_LOOP]',myThid)
      CALL WRITE_CHECKPOINT(
     &        .TRUE., myCurrentTime, myCurrentIter, myThid )
      CALL TIMER_STOP ('I/O (WRITE)        [THE_MAIN_LOOP]',myThid)

C--   Step forward fields for purposes of final I/O processing
      CALL TIMER_START('FORWARD_STEP       [THE_MAIN_LOOP]',myThid)
      CALL FORWARD_STEP( .TRUE., ILOOP,
     &                   myCurrentTime, myCurrentIter, myThid )
      CALL TIMER_STOP ('FORWARD_STEP       [THE_MAIN_LOOP]',myThid)

      CALL TIMER_STOP ('SPIN-DOWN          [THE_MAIN_LOOP]',myThid)

      RETURN
      END
1	jmc	1.3	C $Header: /u/gcmpack/models/MITgcmUV/model/src/the_main_loop.F,v 1.2 2001/02/04 14:38:48 cnh Exp $
2			C $Name: $
3	adcroft	1.1
4			#include "CPP_OPTIONS.h"
5
6	jmc	1.3	SUBROUTINE THE_MAIN_LOOP(myCurrentTime, myCurrentIter, myThid )
7	adcroft	1.1	C /==========================================================\
8			C \| SUBROUTINE THE_MAIN_LOOP \|
9			C \| o This contains the principal time loop \|
10			C \|==========================================================\|
11			C \| THE_MAIN_LOOP is invoked by THE_MODEL_MAIN \|
12			C \==========================================================/
13			IMPLICIT NONE
14			C
15			C Call Tree
16			C =========
17			C
18			C \|-THE_MODEL_MAIN
19			C \| \|
20			C \| \|-THE_MAIN_LOOP
21			C \| \| \|
22			C \| \| \|--INITIALISE_VARIA
23			C \| \| \| o Set initial conditions (variable arrays)
24			C \| \| \|
25			C ==> \| \| \| Time stepping loop starts here
26			C \| \| \| \|
27			C /\|\ \| \| \|
28			C \| \| \| \|--FORWARD_STEP
29			C /\|\ \| \| \|
30			C \| \| \| \|
31			C \|<== \| \| \| Time stepping loop finishes here
32			C
33
34			C == Global variables ===
35			#include "SIZE.h"
36			#include "EEPARAMS.h"
37			#include "PARAMS.h"
38			#include "DYNVARS.h"
39			#include "CG2D.h"
40			#ifdef ALLOW_NONHYDROSTATIC
41			#include "CG3D.h"
42			#endif
43
44			C == Routine arguments ==
45	jmc	1.3	C myCurrentTime - Time counter for this thread
46			C myCurrentIter - Iteration counter for this thread
47	adcroft	1.1	C myThid - Thread number for this instance of the routine.
48	jmc	1.3	INTEGER myCurrentIter, myThid
49			_RL myCurrentTime
50	adcroft	1.1
51			C == Local variables ==
52			C Note: Under the multi-threaded model myCurrentIter and
53			C myCurrentTime are local variables passed around as routine
54			C arguments. Although this is fiddly it saves the need to
55			C impose additional synchronisation points when they are
56			C updated.
57			C ILOOP - Loop counter
58			INTEGER ILOOP
59
60			CALL TIMER_START('SPIN-UP [THE_MAIN_LOOP]',myThid)
61
62			C-- Set initial conditions (variable arrays)
63			CALL TIMER_START('INITIALISE_VARIA [THE_MAIN_LOOP]',myThid)
64			CALL INITIALISE_VARIA( myThid )
65			CALL TIMER_STOP ('INITIALISE_VARIA [THE_MAIN_LOOP]',myThid)
66
67			C-- Dump starting state
68			CALL TIMER_START('I/O (WRITE) [THE_MAIN_LOOP]',myThid)
69			CALL WRITE_STATE( .TRUE., myCurrentTime, myCurrentIter, myThid )
70			CALL TIMER_STOP ('I/O (WRITE) [THE_MAIN_LOOP]',myThid)
71
72			CALL TIMER_STOP ('SPIN-UP [THE_MAIN_LOOP]',myThid)
73
74			C ===========================================================
75			C-- Begin time stepping loop
76			CALL TIMER_START('MAIN LOOP [THE_MAIN_LOOP]',myThid)
77			DO ILOOP=1, nTimeSteps
78
79			C-- Step forward fields and calculate time tendency terms
80			CALL TIMER_START('FORWARD_STEP [THE_MAIN_LOOP]',myThid)
81			CALL FORWARD_STEP( .FALSE., ILOOP,
82			& myCurrentTime, myCurrentIter, myThid )
83			CALL TIMER_STOP ('FORWARD_STEP [THE_MAIN_LOOP]',myThid)
84
85			ENDDO
86			CALL TIMER_STOP ('MAIN LOOP [THE_MAIN_LOOP]',myThid)
87			C ===========================================================
88
89			CALL TIMER_START('SPIN-DOWN [THE_MAIN_LOOP]',myThid)
90
91			C-- Final checkpoint (incase the in-loop checkpoint was missed)
92			CALL TIMER_START('I/O (WRITE) [THE_MAIN_LOOP]',myThid)
93			CALL WRITE_CHECKPOINT(
94			& .TRUE., myCurrentTime, myCurrentIter, myThid )
95			CALL TIMER_STOP ('I/O (WRITE) [THE_MAIN_LOOP]',myThid)
96
97			C-- Step forward fields for purposes of final I/O processing
98			CALL TIMER_START('FORWARD_STEP [THE_MAIN_LOOP]',myThid)
99			CALL FORWARD_STEP( .TRUE., ILOOP,
100			& myCurrentTime, myCurrentIter, myThid )
101			CALL TIMER_STOP ('FORWARD_STEP [THE_MAIN_LOOP]',myThid)
102
103			CALL TIMER_STOP ('SPIN-DOWN [THE_MAIN_LOOP]',myThid)
104
105			RETURN
106			END