model/src/packages_init_variables.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.31 2003/12/15 23:00:44 molod Exp $
C $Name:  $

#include "PACKAGES_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       |-- 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"

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