model/src/packages_init_variables.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.35 2004/09/02 09:13:49 mlosch Exp $
C $Name:  $

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

CBOP
C     !ROUTINE: PACKAGES_INIT_VARIABLES
C     !INTERFACE:
      SUBROUTINE PACKAGES_INIT_VARIABLES( myThid )

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE PACKAGES_INIT_VARIABLES                        
C     | o Does initialisation of package-related variable data    
C     *==========================================================*
C     \ev

C     !CALLING SEQUENCE:
C     PACKAGES_INIT_VARIABLES
C       |
C       |-- CD_CODE_INI_VARS
C       |
C       |-- GMREDI_INIT
C       |
C       |-- KPP_INIT
C       |-- KPP_OPEN_DIAGS
C       |
C       |-- PP81_INIT
C       |
C       |-- MY82_INIT
C       |
C       |-- GGL90_INIT
C       |
C       |-- SEAICE_INIT
C       | 
C       |-- OBCS_INIT_VARIABLES
C       |
C       |-- PTRACERS_INIT
C       |
C       |-- LAND_INI_VARS
C       |
C       |-- CTRL_MAP_INI
C       |
C       |-- EXF_INIT
C       |
C       |-- INI_FORCING
C       |
C       |-- ECCO_INIT
C       |
C       |-- COST_INIT
C       |
C       |-- BULKF_INIT
C       |
C       |-- THSICE_INI_VARS
C       |
C       |-- CPL_INI_VARS

C     !USES:
      IMPLICIT NONE
C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#ifdef ALLOW_AUTODIFF_TAMC
# include "DYNVARS.h"
# include "tamc.h"
# include "tamc_keys.h"
#endif

C     !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
C     myThid -  Number of this instances
      INTEGER myThid
CEOP

#ifdef ALLOW_CD_CODE
C--   Initialize CD_CODE variables: 
C- note(jmc): before packaging CD_CODE, was done within ini_fields (=called before),
C             therefore call CD-ini-vars before others pkg.
      IF (useCDscheme) CALL CD_CODE_INI_VARS( myThid )
#endif

#ifdef ALLOW_GMREDI
C--   Initialize GM/Redi parameterization
      IF (useGMRedi) CALL GMREDI_INIT( myThid )
#endif

#ifdef ALLOW_KPP
C--   Initialize KPP vertical mixing scheme.
      IF (useKPP) THEN
       CALL KPP_INIT( myThid )
       CALL KPP_OPEN_DIAGS( myThid )
      ENDIF
#endif

#ifdef ALLOW_PP81
C--   Initialize PP81 vertical mixing scheme.
      IF (usePP81) THEN
       CALL PP81_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_MY82
C--   Initialize MY82 vertical mixing scheme.
      IF (useMY82) THEN
       CALL MY82_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_GGL90
C--   Initialize GGL90 vertical mixing scheme.
      IF (useGGL90) THEN
       CALL GGL90_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_SEAICE
C--   Initialize SEAICE model.
      IF (useSEAICE) CALL SEAICE_INIT( myThid )
#endif

cph-- moved further down
cph#ifdef ALLOW_OBCS
cphC--   Open boundaries data
cph      IF (useOBCS) THEN
cph        CALL OBCS_INIT_VARIABLES( myThid )
cph      ENDIF
cph#endif

#ifdef ALLOW_PTRACERS
# ifndef ALLOW_AUTODIFF_TAMC
      IF ( usePTRACERS ) THEN
# endif
         CALL PTRACERS_INIT( mythid )
#ifdef ALLOW_GCHEM
         CALL GCHEM_INIT_VARI( mythid )
#endif
# ifndef ALLOW_AUTODIFF_TAMC
      ENDIF
# endif
#endif

#ifdef ALLOW_LAND
      IF ( useLAND ) CALL LAND_INI_VARS( mythid )
#endif

#ifdef ALLOW_AUTODIFF
CADJ STORE theta = tapelev3, key = 1
c--   Initialise auxiliary xx_ fields
      CALL CTRL_INIT_VARIABLES ( mythid )
c--   Map the control variables onto the model state.
      CALL CTRL_MAP_INI( mythid )
      _BARRIER
#endif

#ifdef ALLOW_EXF
      CALL EXF_INIT( mythid )
cph#else
#endif
      CALL INI_FORCING( mythid )
cph#endif

#ifdef ALLOW_EBM
# ifdef ALLOW_AUTODIFF
CADJ STORE theta = tapelev3, key = 1
# endif
      IF (useEBM) CALL EBM_INI_VARS( mythid )
#endif

#ifdef ALLOW_COST
c--   Initialise the cost function.
ceh3 needs an IF ( useCOST ) THEN
      CALL COST_INITVARIA( mythid )
      _BARRIER
#endif

#ifdef ALLOW_OBCS
C--   Open boundaries data
      IF (useOBCS) CALL OBCS_INIT_VARIABLES( myThid )
#endif

#ifdef ALLOW_BULK_FORCE
      IF (useBulkForce) CALL BULKF_INIT( mythid)
#endif

#ifdef ALLOW_THSICE
      IF (useThSIce) CALL THSICE_INI_VARS( mythid)
#endif

#ifdef COMPONENT_MODULE
      IF ( useCoupler ) CALL CPL_INI_VARS( mythid )
#endif

C AMM
#ifdef ALLOW_FIZHI
C Initialize FIZHI state variables
      IF (useFIZHI) CALL FIZHI_INIT_VARS( mythid)
#endif
C AMM

      RETURN
      END
1	mlosch	1.36	C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.35 2004/09/02 09:13:49 mlosch Exp $
2	edhill	1.24	C $Name: $
3	adcroft	1.2
4	edhill	1.24	#include "PACKAGES_CONFIG.h"
5	heimbach	1.34	#include "AD_CONFIG.h"
6	adcroft	1.2	#include "CPP_OPTIONS.h"
7
8	cnh	1.8	CBOP
9			C !ROUTINE: PACKAGES_INIT_VARIABLES
10			C !INTERFACE:
11	adcroft	1.2	SUBROUTINE PACKAGES_INIT_VARIABLES( myThid )
12	cnh	1.8
13			C !DESCRIPTION: \bv
14			C ==========================================================
15			C \| SUBROUTINE PACKAGES_INIT_VARIABLES
16			C \| o Does initialisation of package-related variable data
17			C ==========================================================
18			C \ev
19
20			C !CALLING SEQUENCE:
21			C PACKAGES_INIT_VARIABLES
22			C \|
23	jmc	1.29	C \|-- CD_CODE_INI_VARS
24			C \|
25	cnh	1.8	C \|-- GMREDI_INIT
26			C \|
27			C \|-- KPP_INIT
28			C \|-- KPP_OPEN_DIAGS
29			C \|
30	mlosch	1.35	C \|-- PP81_INIT
31			C \|
32			C \|-- MY82_INIT
33			C \|
34	mlosch	1.36	C \|-- GGL90_INIT
35			C \|
36	heimbach	1.14	C \|-- SEAICE_INIT
37	dimitri	1.18	C \|
38			C \|-- OBCS_INIT_VARIABLES
39	heimbach	1.14	C \|
40	dimitri	1.18	C \|-- PTRACERS_INIT
41	cnh	1.8	C \|
42	jmc	1.19	C \|-- LAND_INI_VARS
43			C \|
44	cnh	1.8	C \|-- CTRL_MAP_INI
45			C \|
46	dimitri	1.18	C \|-- EXF_INIT
47			C \|
48			C \|-- INI_FORCING
49			C \|
50			C \|-- ECCO_INIT
51			C \|
52	cnh	1.8	C \|-- COST_INIT
53			C \|
54	dimitri	1.18	C \|-- BULKF_INIT
55	cnh	1.8	C \|
56	jmc	1.28	C \|-- THSICE_INI_VARS
57	jmc	1.30	C \|
58			C \|-- CPL_INI_VARS
59	cnh	1.8
60			C !USES:
61	adcroft	1.2	IMPLICIT NONE
62			C === Global variables ===
63			#include "SIZE.h"
64			#include "EEPARAMS.h"
65			#include "PARAMS.h"
66	heimbach	1.34	#ifdef ALLOW_AUTODIFF_TAMC
67			# include "DYNVARS.h"
68			# include "tamc.h"
69			# include "tamc_keys.h"
70			#endif
71	adcroft	1.2
72	cnh	1.8	C !INPUT/OUTPUT PARAMETERS:
73	adcroft	1.2	C === Routine arguments ===
74			C myThid - Number of this instances
75			INTEGER myThid
76	cnh	1.8	CEOP
77	jmc	1.29
78			#ifdef ALLOW_CD_CODE
79			C-- Initialize CD_CODE variables:
80			C- note(jmc): before packaging CD_CODE, was done within ini_fields (=called before),
81			C therefore call CD-ini-vars before others pkg.
82			IF (useCDscheme) CALL CD_CODE_INI_VARS( myThid )
83			#endif
84	adcroft	1.2
85			#ifdef ALLOW_GMREDI
86			C-- Initialize GM/Redi parameterization
87			IF (useGMRedi) CALL GMREDI_INIT( myThid )
88			#endif
89
90			#ifdef ALLOW_KPP
91			C-- Initialize KPP vertical mixing scheme.
92			IF (useKPP) THEN
93			CALL KPP_INIT( myThid )
94			CALL KPP_OPEN_DIAGS( myThid )
95			ENDIF
96	heimbach	1.14	#endif
97
98	mlosch	1.35	#ifdef ALLOW_PP81
99			C-- Initialize PP81 vertical mixing scheme.
100			IF (usePP81) THEN
101			CALL PP81_INIT( myThid )
102			ENDIF
103			#endif
104
105			#ifdef ALLOW_MY82
106	mlosch	1.36	C-- Initialize MY82 vertical mixing scheme.
107	mlosch	1.35	IF (useMY82) THEN
108			CALL MY82_INIT( myThid )
109			ENDIF
110			#endif
111
112	mlosch	1.36	#ifdef ALLOW_GGL90
113			C-- Initialize GGL90 vertical mixing scheme.
114			IF (useGGL90) THEN
115			CALL GGL90_INIT( myThid )
116			ENDIF
117			#endif
118
119	heimbach	1.14	#ifdef ALLOW_SEAICE
120			C-- Initialize SEAICE model.
121			IF (useSEAICE) CALL SEAICE_INIT( myThid )
122	adcroft	1.2	#endif
123
124	heimbach	1.20	cph-- moved further down
125			cph#ifdef ALLOW_OBCS
126			cphC-- Open boundaries data
127			cph IF (useOBCS) THEN
128			cph CALL OBCS_INIT_VARIABLES( myThid )
129			cph ENDIF
130			cph#endif
131	adcroft	1.11
132			#ifdef ALLOW_PTRACERS
133	heimbach	1.22	# ifndef ALLOW_AUTODIFF_TAMC
134			IF ( usePTRACERS ) THEN
135			# endif
136			CALL PTRACERS_INIT( mythid )
137	stephd	1.23	#ifdef ALLOW_GCHEM
138			CALL GCHEM_INIT_VARI( mythid )
139			#endif
140	heimbach	1.22	# ifndef ALLOW_AUTODIFF_TAMC
141			ENDIF
142			# endif
143	jmc	1.19	#endif
144
145			#ifdef ALLOW_LAND
146			IF ( useLAND ) CALL LAND_INI_VARS( mythid )
147	adcroft	1.2	#endif
148
149	heimbach	1.26	#ifdef ALLOW_AUTODIFF
150	heimbach	1.34	CADJ STORE theta = tapelev3, key = 1
151	heimbach	1.20	c-- Initialise auxiliary xx_ fields
152			CALL CTRL_INIT_VARIABLES ( mythid )
153			c-- Map the control variables onto the model state.
154			CALL CTRL_MAP_INI( mythid )
155	heimbach	1.5	_BARRIER
156	dimitri	1.18	#endif
157
158	edhill	1.27	#ifdef ALLOW_EXF
159	dimitri	1.18	CALL EXF_INIT( mythid )
160	heimbach	1.32	cph#else
161			#endif
162	dimitri	1.18	CALL INI_FORCING( mythid )
163	heimbach	1.32	cph#endif
164	heimbach	1.33
165			#ifdef ALLOW_EBM
166	heimbach	1.34	# ifdef ALLOW_AUTODIFF
167			CADJ STORE theta = tapelev3, key = 1
168			# endif
169	heimbach	1.33	IF (useEBM) CALL EBM_INI_VARS( mythid )
170			#endif
171	heimbach	1.5
172	heimbach	1.20	#ifdef ALLOW_COST
173	heimbach	1.12	c-- Initialise the cost function.
174	edhill	1.24	ceh3 needs an IF ( useCOST ) THEN
175	heimbach	1.20	CALL COST_INITVARIA( mythid )
176	heimbach	1.12	_BARRIER
177	heimbach	1.20	#endif
178
179			#ifdef ALLOW_OBCS
180			C-- Open boundaries data
181			IF (useOBCS) CALL OBCS_INIT_VARIABLES( myThid )
182	adcroft	1.2	#endif
183
184	cheisey	1.17	#ifdef ALLOW_BULK_FORCE
185	jmc	1.28	IF (useBulkForce) CALL BULKF_INIT( mythid)
186	cheisey	1.16	#endif
187
188	jmc	1.28	#ifdef ALLOW_THSICE
189			IF (useThSIce) CALL THSICE_INI_VARS( mythid)
190	cheisey	1.16	#endif
191
192	jmc	1.30	#ifdef COMPONENT_MODULE
193			IF ( useCoupler ) CALL CPL_INI_VARS( mythid )
194			#endif
195	molod	1.31
196			C AMM
197			#ifdef ALLOW_FIZHI
198			C Initialize FIZHI state variables
199			IF (useFIZHI) CALL FIZHI_INIT_VARS( mythid)
200			#endif
201			C AMM
202	cheisey	1.16
203	adcroft	1.2	RETURN
204			END