pkg/ecco/forward_step.F

C $Header: /u/gcmpack/MITgcm/pkg/ecco/forward_step.F,v 1.1 2003/11/06 22:10:08 heimbach Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: FORWARD_STEP
C     !INTERFACE:
      SUBROUTINE FORWARD_STEP( iloop, myTime, myIter, myThid )

C     !DESCRIPTION: \bv
C     *==================================================================
C     | SUBROUTINE forward_step
C     | o Run the ocean model and, optionally, evaluate a cost function.
C     *==================================================================
C     |
C     | THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and
C     | Adjoint Model Compiler (TAMC). For this purpose the initialization
C     | of the model was split into two parts. Those parameters that do
C     | not depend on a specific model run are set in INITIALISE_FIXED,
C     | whereas those that do depend on the specific realization are
C     | initialized in INITIALISE_VARIA.
C     |
C     *==================================================================
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"

C     !LOCAL VARIABLES:
C     == Routine arguments ==
C     note: under the multi-threaded model myiter and
C           mytime 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     myiter - iteration counter for this thread
C     mytime - time counter for this thread
C     mythid - thread number for this instance of the routine.
      integer iloop
      integer mythid
      integer myiter
      _RL     mytime

CEOP

#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_ENTER('FORWARD_STEP',myThid)
#endif

c--  This is a placeholder routine for the ecco setup.
c--  In the ECCO configuration this routine is inlined
c--  in the_main_loop routine for AD-reasons.

      STOP 'S/R forward_step should never be called when ALLOW_ECCO'

      END
1	C $Header: /u/gcmpack/MITgcm/pkg/ecco/forward_step.F,v 1.1 2003/11/06 22:10:08 heimbach Exp $
2	C $Name: $
3
4	#include "PACKAGES_CONFIG.h"
5	#include "CPP_OPTIONS.h"
6
7	CBOP
8	C !ROUTINE: FORWARD_STEP
9	C !INTERFACE:
10	SUBROUTINE FORWARD_STEP( iloop, myTime, myIter, myThid )
11
12	C !DESCRIPTION: \bv
13	C *==================================================================
14	C \| SUBROUTINE forward_step
15	C \| o Run the ocean model and, optionally, evaluate a cost function.
16	C *==================================================================
17	C \|
18	C \| THE_MAIN_LOOP is the toplevel routine for the Tangent Linear and
19	C \| Adjoint Model Compiler (TAMC). For this purpose the initialization
20	C \| of the model was split into two parts. Those parameters that do
21	C \| not depend on a specific model run are set in INITIALISE_FIXED,
22	C \| whereas those that do depend on the specific realization are
23	C \| initialized in INITIALISE_VARIA.
24	C \|
25	C *==================================================================
26	C \ev
27
28	C !USES:
29	IMPLICIT NONE
30	C == Global variables ==
31	#include "SIZE.h"
32	#include "EEPARAMS.h"
33	#include "PARAMS.h"
34
35	C !LOCAL VARIABLES:
36	C == Routine arguments ==
37	C note: under the multi-threaded model myiter and
38	C mytime are local variables passed around as routine
39	C arguments. Although this is fiddly it saves the need to
40	C impose additional synchronisation points when they are
41	C updated.
42	C myiter - iteration counter for this thread
43	C mytime - time counter for this thread
44	C mythid - thread number for this instance of the routine.
45	integer iloop
46	integer mythid
47	integer myiter
48	_RL mytime
49
50	CEOP
51
52	#ifdef ALLOW_DEBUG
53	IF (debugMode) CALL DEBUG_ENTER('FORWARD_STEP',myThid)
54	#endif
55
56	c-- This is a placeholder routine for the ecco setup.
57	c-- In the ECCO configuration this routine is inlined
58	c-- in the_main_loop routine for AD-reasons.
59
60	STOP 'S/R forward_step should never be called when ALLOW_ECCO'
61
62	END