model/src/load_fields_driver.F

C $Header: /u/gcmpack/MITgcm/model/src/load_fields_driver.F,v 1.2 2007/04/16 23:31:59 jmc Exp $
C $Name:  $

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

c#ifdef ALLOW_GMREDI
c# include "GMREDI_OPTIONS.h"
c#endif
c#ifdef ALLOW_OBCS
c# include "OBCS_OPTIONS.h"
c#endif

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

C     !DESCRIPTION: \bv
C     *==================================================================
C     | SUBROUTINE LOAD_FIELDS_DRIVER
C     | o Load external forcing fields from file
C     *==================================================================
C     *==================================================================
C     \ev

C     !CALLING SEQUENCE:
C     LOAD_FIELDS_DRIVER
C       |
C       |-- BULKF_FIELDS_LOAD
C       |
C       |-- EXF_GETFORCING
C       |
C       |-- EXTERNAL_FIELDS_LOAD
C       |
C       |-- OFFLINE_FIELDS_LOAD
C       |
C       |-- GCHEM_FIELDS_LOAD
C       |
C       |-- RBCS_FIELDS_LOAD
C       |
C       |-- AIM_FIELDS_LOAD


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

c#ifdef ALLOW_SHAP_FILT
c# include "SHAP_FILT.h"
c#endif
c#ifdef ALLOW_ZONAL_FILT
c# include "ZONAL_FILT.h"
c#endif
c#ifdef COMPONENT_MODULE
c# include "CPL_PARAMS.h"
c#endif

#ifdef ALLOW_AUTODIFF_TAMC

# include "tamc.h"
# include "ctrl.h"
# include "ctrl_dummy.h"
# include "cost.h"
# include "FFIELDS.h"
# include "EOS.h"
c# if (defined NONLIN_FRSURF) || (defined ALLOW_DEPTH_CONTROL)
c#  include "GRID.h"
c# endif
# ifdef ALLOW_EXF
#  include "EXF_FIELDS.h"
#  ifdef ALLOW_BULKFORMULAE
#   include "EXF_CONSTANTS.h"
#  endif
# endif
c# ifdef ALLOW_PTRACERS
c#  include "PTRACERS_SIZE.h"
c#  include "PTRACERS.h"
c# endif
c# ifdef ALLOW_OBCS
c#  include "OBCS.h"
c#  ifdef ALLOW_PTRACERS
c#   include "OBCS_PTRACERS.h"
c#  endif
c# endif
c# ifdef ALLOW_CD_CODE
c#  include "CD_CODE_VARS.h"
c# endif
c# ifdef ALLOW_THSICE
c#  include "THSICE_VARS.h"
c# endif
c# ifdef ALLOW_EBM
c#  include "EBM.h"
c# endif
c# ifdef EXACT_CONSERV
c#  include "SURFACE.h"
c# endif
c# ifdef ALLOW_KPP
c#  include "KPP.h"
c# endif
c# ifdef ALLOW_GMREDI
c#  include "GMREDI.h"
c# endif
#endif /* ALLOW_AUTODIFF_TAMC */

C     !LOCAL VARIABLES:
C     == Routine arguments ==
C     myTime :: time counter for this thread
C     myIter :: iteration counter for this thread
C     myThid :: thread number for this instance of the routine.
      _RL     myTime
      INTEGER myIter
      INTEGER myThid

C     == Local variables ==
CEOP

#ifdef ALLOW_DEBUG
      IF ( debugLevel .GE. debLevB ) 
     &     CALL DEBUG_ENTER( 'LOAD_FIELDS_DRIVER', myThid )
#endif

#ifdef ALLOW_BULK_FORCE
      IF ( useBulkForce ) THEN
C--   Bulk-Formulae pkg: load all forcing fields at current time
#ifdef ALLOW_DEBUG
        IF ( debugLevel .GE. debLevB ) 
     &   CALL DEBUG_CALL('BULKF_FIELDS_LOAD',myThid)
#endif
        CALL TIMER_START('BULKF_FIELDS_LOAD  [LOAD_FLDS_DRIVER]',myThid)
        CALL BULKF_FIELDS_LOAD( myTime, myIter, myThid )
        CALL TIMER_STOP ('BULKF_FIELDS_LOAD  [LOAD_FLDS_DRIVER]',myThid)
      ENDIF
#endif /* ALLOW_BULK_FORCE */

C--   Call external forcing package
#ifdef ALLOW_EXF
# ifdef ALLOW_DEBUG
      IF ( debugLevel .GE. debLevB ) 
     &   CALL DEBUG_CALL('EXF_GETFORCING',myThid)
# endif
        CALL TIMER_START('EXF_GETFORCING     [LOAD_FLDS_DRIVER]',myThid)
        CALL EXF_GETFORCING( myTime, myIter, myThid )
        CALL TIMER_STOP ('EXF_GETFORCING     [LOAD_FLDS_DRIVER]',myThid)
#else /* ALLOW_EXF undef */
cph The following IF-statement creates an additional dependency
cph for the forcing fields requiring additional storing.
cph Therefore, the IF-statement will be put between CPP-OPTIONS,
cph assuming that ALLOW_SEAICE has not yet been differentiated.
# if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM))
      IF ( .NOT. useSEAICE .AND. .NOT. useEBM ) THEN
# endif
# ifdef ALLOW_DEBUG
        IF ( debugLevel .GE. debLevB ) 
     &   CALL DEBUG_CALL('EXTERNAL_FIELDS_LOAD',myThid)
# endif
        CALL TIMER_START('EXTERNAL_FLDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
        CALL EXTERNAL_FIELDS_LOAD( myTime, myIter, myThid )
        CALL TIMER_STOP ('EXTERNAL_FLDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
# ifdef NONLIN_FRSURF
CADJ STORE SST    = comlev1, key = ikey_dynamics
CADJ STORE SSS    = comlev1, key = ikey_dynamics
#  ifdef SHORTWAVE_HEATING
CADJ STORE Qsw    = comlev1, key = ikey_dynamics
#  endif
# endif
# if (defined (ALLOW_SEAICE) || defined (ALLOW_EBM))
      ENDIF
# endif
#endif /* ALLOW_EXF */

#ifdef ALLOW_OFFLINE
      IF ( useOffLine ) THEN
#ifdef ALLOW_DEBUG
        IF ( debugLevel .GE. debLevB )
     &   CALL DEBUG_CALL('OFFLINE_FIELDS_LOAD',myThid)
#endif /* ALLOW_DEBUG */
        CALL TIMER_START('OFFLINE_FLDS_LOAD  [LOAD_FLDS_DRIVER]',myThid)
        CALL OFFLINE_FIELDS_LOAD( myTime, myIter, myThid )
        CALL TIMER_STOP ('OFFLINE_FLDS_LOAD  [LOAD_FLDS_DRIVER]',myThid)
      ENDIF
#endif /* ALLOW_OFFLINE */

#ifdef ALLOW_GCHEM
      IF ( useGCHEM ) THEN
#ifdef ALLOW_DEBUG
        IF ( debugLevel .GE. debLevB ) 
     &   CALL DEBUG_CALL('GCHEM_FIELDS_LOAD',myThid)
#endif /* ALLOW_DEBUG */
        CALL GCHEM_FIELDS_LOAD( myTime, myIter, myThid )
      ENDIF
#endif /* ALLOW_GCHEM */

#ifdef ALLOW_RBCS
      IF ( useRBCS ) THEN
        CALL RBCS_FIELDS_LOAD( myTime, myIter, myThid )
      ENDIF
#endif

#ifdef ALLOW_AIM
      IF ( useAIM ) THEN
C-     Update AIM bottom boundary data
        CALL AIM_FIELDS_LOAD( myTime, myIter, myThid )
      ENDIF
#endif

#ifdef ALLOW_DEBUG
      IF ( debugLevel .GE. debLevB )
     &     CALL DEBUG_LEAVE( 'LOAD_FIELDS_DRIVER', myThid )
#endif

      RETURN
      END
1	heimbach	1.3	C $Header: /u/gcmpack/MITgcm/model/src/load_fields_driver.F,v 1.2 2007/04/16 23:31:59 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#include "PACKAGES_CONFIG.h"
5			#include "CPP_OPTIONS.h"
6
7			c#ifdef ALLOW_GMREDI
8			c# include "GMREDI_OPTIONS.h"
9			c#endif
10			c#ifdef ALLOW_OBCS
11			c# include "OBCS_OPTIONS.h"
12			c#endif
13
14			CBOP
15			C !ROUTINE: LOAD_FIELDS_DRIVER
16			C !INTERFACE:
17			SUBROUTINE LOAD_FIELDS_DRIVER( myTime, myIter, myThid )
18
19			C !DESCRIPTION: \bv
20			C *==================================================================
21			C \| SUBROUTINE LOAD_FIELDS_DRIVER
22			C \| o Load external forcing fields from file
23			C *==================================================================
24			C *==================================================================
25			C \ev
26
27			C !CALLING SEQUENCE:
28			C LOAD_FIELDS_DRIVER
29			C \|
30			C \|-- BULKF_FIELDS_LOAD
31			C \|
32			C \|-- EXF_GETFORCING
33			C \|
34			C \|-- EXTERNAL_FIELDS_LOAD
35			C \|
36			C \|-- OFFLINE_FIELDS_LOAD
37			C \|
38			C \|-- GCHEM_FIELDS_LOAD
39			C \|
40			C \|-- RBCS_FIELDS_LOAD
41			C \|
42			C \|-- AIM_FIELDS_LOAD
43
44
45			C !USES:
46			IMPLICIT NONE
47			C == Global variables ==
48			#include "SIZE.h"
49			#include "EEPARAMS.h"
50			#include "PARAMS.h"
51			c#include "DYNVARS.h"
52
53			c#ifdef ALLOW_SHAP_FILT
54			c# include "SHAP_FILT.h"
55			c#endif
56			c#ifdef ALLOW_ZONAL_FILT
57			c# include "ZONAL_FILT.h"
58			c#endif
59			c#ifdef COMPONENT_MODULE
60			c# include "CPL_PARAMS.h"
61			c#endif
62
63			#ifdef ALLOW_AUTODIFF_TAMC
64
65			# include "tamc.h"
66			# include "ctrl.h"
67			# include "ctrl_dummy.h"
68			# include "cost.h"
69			# include "FFIELDS.h"
70			# include "EOS.h"
71			c# if (defined NONLIN_FRSURF) \|\| (defined ALLOW_DEPTH_CONTROL)
72			c# include "GRID.h"
73			c# endif
74			# ifdef ALLOW_EXF
75	jmc	1.2	# include "EXF_FIELDS.h"
76	jmc	1.1	# ifdef ALLOW_BULKFORMULAE
77	jmc	1.2	# include "EXF_CONSTANTS.h"
78	jmc	1.1	# endif
79			# endif
80			c# ifdef ALLOW_PTRACERS
81			c# include "PTRACERS_SIZE.h"
82			c# include "PTRACERS.h"
83			c# endif
84			c# ifdef ALLOW_OBCS
85			c# include "OBCS.h"
86			c# ifdef ALLOW_PTRACERS
87			c# include "OBCS_PTRACERS.h"
88			c# endif
89			c# endif
90			c# ifdef ALLOW_CD_CODE
91			c# include "CD_CODE_VARS.h"
92			c# endif
93			c# ifdef ALLOW_THSICE
94			c# include "THSICE_VARS.h"
95			c# endif
96			c# ifdef ALLOW_EBM
97			c# include "EBM.h"
98			c# endif
99			c# ifdef EXACT_CONSERV
100			c# include "SURFACE.h"
101			c# endif
102			c# ifdef ALLOW_KPP
103			c# include "KPP.h"
104			c# endif
105			c# ifdef ALLOW_GMREDI
106			c# include "GMREDI.h"
107			c# endif
108			#endif /* ALLOW_AUTODIFF_TAMC */
109
110			C !LOCAL VARIABLES:
111			C == Routine arguments ==
112			C myTime :: time counter for this thread
113			C myIter :: iteration counter for this thread
114			C myThid :: thread number for this instance of the routine.
115			_RL myTime
116			INTEGER myIter
117			INTEGER myThid
118
119			C == Local variables ==
120			CEOP
121
122			#ifdef ALLOW_DEBUG
123			IF ( debugLevel .GE. debLevB )
124			& CALL DEBUG_ENTER( 'LOAD_FIELDS_DRIVER', myThid )
125			#endif
126
127			#ifdef ALLOW_BULK_FORCE
128			IF ( useBulkForce ) THEN
129			C-- Bulk-Formulae pkg: load all forcing fields at current time
130			#ifdef ALLOW_DEBUG
131			IF ( debugLevel .GE. debLevB )
132			& CALL DEBUG_CALL('BULKF_FIELDS_LOAD',myThid)
133			#endif
134			CALL TIMER_START('BULKF_FIELDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
135			CALL BULKF_FIELDS_LOAD( myTime, myIter, myThid )
136			CALL TIMER_STOP ('BULKF_FIELDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
137			ENDIF
138			#endif /* ALLOW_BULK_FORCE */
139
140			C-- Call external forcing package
141			#ifdef ALLOW_EXF
142			# ifdef ALLOW_DEBUG
143			IF ( debugLevel .GE. debLevB )
144			& CALL DEBUG_CALL('EXF_GETFORCING',myThid)
145			# endif
146			CALL TIMER_START('EXF_GETFORCING [LOAD_FLDS_DRIVER]',myThid)
147			CALL EXF_GETFORCING( myTime, myIter, myThid )
148			CALL TIMER_STOP ('EXF_GETFORCING [LOAD_FLDS_DRIVER]',myThid)
149			#else /* ALLOW_EXF undef */
150			cph The following IF-statement creates an additional dependency
151			cph for the forcing fields requiring additional storing.
152			cph Therefore, the IF-statement will be put between CPP-OPTIONS,
153			cph assuming that ALLOW_SEAICE has not yet been differentiated.
154			# if (defined (ALLOW_SEAICE) \|\| defined (ALLOW_EBM))
155			IF ( .NOT. useSEAICE .AND. .NOT. useEBM ) THEN
156			# endif
157			# ifdef ALLOW_DEBUG
158			IF ( debugLevel .GE. debLevB )
159			& CALL DEBUG_CALL('EXTERNAL_FIELDS_LOAD',myThid)
160			# endif
161			CALL TIMER_START('EXTERNAL_FLDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
162			CALL EXTERNAL_FIELDS_LOAD( myTime, myIter, myThid )
163			CALL TIMER_STOP ('EXTERNAL_FLDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
164			# ifdef NONLIN_FRSURF
165			CADJ STORE SST = comlev1, key = ikey_dynamics
166			CADJ STORE SSS = comlev1, key = ikey_dynamics
167			# ifdef SHORTWAVE_HEATING
168			CADJ STORE Qsw = comlev1, key = ikey_dynamics
169			# endif
170			# endif
171			# if (defined (ALLOW_SEAICE) \|\| defined (ALLOW_EBM))
172			ENDIF
173			# endif
174			#endif /* ALLOW_EXF */
175
176			#ifdef ALLOW_OFFLINE
177			IF ( useOffLine ) THEN
178			#ifdef ALLOW_DEBUG
179			IF ( debugLevel .GE. debLevB )
180			& CALL DEBUG_CALL('OFFLINE_FIELDS_LOAD',myThid)
181			#endif /* ALLOW_DEBUG */
182			CALL TIMER_START('OFFLINE_FLDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
183			CALL OFFLINE_FIELDS_LOAD( myTime, myIter, myThid )
184			CALL TIMER_STOP ('OFFLINE_FLDS_LOAD [LOAD_FLDS_DRIVER]',myThid)
185			ENDIF
186			#endif /* ALLOW_OFFLINE */
187
188			#ifdef ALLOW_GCHEM
189			IF ( useGCHEM ) THEN
190			#ifdef ALLOW_DEBUG
191			IF ( debugLevel .GE. debLevB )
192			& CALL DEBUG_CALL('GCHEM_FIELDS_LOAD',myThid)
193			#endif /* ALLOW_DEBUG */
194			CALL GCHEM_FIELDS_LOAD( myTime, myIter, myThid )
195			ENDIF
196			#endif /* ALLOW_GCHEM */
197
198			#ifdef ALLOW_RBCS
199			IF ( useRBCS ) THEN
200			CALL RBCS_FIELDS_LOAD( myTime, myIter, myThid )
201			ENDIF
202			#endif
203
204			#ifdef ALLOW_AIM
205			IF ( useAIM ) THEN
206			C- Update AIM bottom boundary data
207			CALL AIM_FIELDS_LOAD( myTime, myIter, myThid )
208			ENDIF
209			#endif
210
211			#ifdef ALLOW_DEBUG
212			IF ( debugLevel .GE. debLevB )
213			& CALL DEBUG_LEAVE( 'LOAD_FIELDS_DRIVER', myThid )
214			#endif
215
216			RETURN
217			END