model/src/packages_init_variables.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.25 2003/10/23 04:41:40 edhill 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       |-- 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       |-- ICE_INIT

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_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 INCLUDE_EXTERNAL_FORCING_PACKAGE
      CALL EXF_INIT( mythid )
#else
      CALL INI_FORCING( 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

cswdblk -- begin add ---
#ifdef ALLOW_BULK_FORCE
      IF (useBulkForce) call BULKF_INIT( mythid)
#endif
cswdblk ---end add ---

cswdice ---begin add ---
#ifdef ALLOW_THERM_SEAICE
      IF (useThermSeaIce) call ICE_INIT( mythid)
#endif
cswdice ---end add ---


      RETURN
      END
1	heimbach	1.26	C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.25 2003/10/23 04:41:40 edhill 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			C \|-- GMREDI_INIT
23			C \|
24			C \|-- KPP_INIT
25			C \|-- KPP_OPEN_DIAGS
26			C \|
27	heimbach	1.14	C \|-- SEAICE_INIT
28	dimitri	1.18	C \|
29			C \|-- OBCS_INIT_VARIABLES
30	heimbach	1.14	C \|
31	dimitri	1.18	C \|-- PTRACERS_INIT
32	cnh	1.8	C \|
33	jmc	1.19	C \|-- LAND_INI_VARS
34			C \|
35	cnh	1.8	C \|-- CTRL_MAP_INI
36			C \|
37	dimitri	1.18	C \|-- EXF_INIT
38			C \|
39			C \|-- INI_FORCING
40			C \|
41			C \|-- ECCO_INIT
42			C \|
43	cnh	1.8	C \|-- COST_INIT
44			C \|
45	dimitri	1.18	C \|-- BULKF_INIT
46	cnh	1.8	C \|
47	dimitri	1.18	C \|-- ICE_INIT
48	cnh	1.8
49			C !USES:
50	adcroft	1.2	IMPLICIT NONE
51			C === Global variables ===
52			#include "SIZE.h"
53			#include "EEPARAMS.h"
54			#include "PARAMS.h"
55
56	cnh	1.8	C !INPUT/OUTPUT PARAMETERS:
57	adcroft	1.2	C === Routine arguments ===
58			C myThid - Number of this instances
59			INTEGER myThid
60	cnh	1.8	CEOP
61	adcroft	1.2
62			#ifdef ALLOW_GMREDI
63			C-- Initialize GM/Redi parameterization
64			IF (useGMRedi) CALL GMREDI_INIT( myThid )
65			#endif
66
67			#ifdef ALLOW_KPP
68			C-- Initialize KPP vertical mixing scheme.
69			IF (useKPP) THEN
70			CALL KPP_INIT( myThid )
71			CALL KPP_OPEN_DIAGS( myThid )
72			ENDIF
73	heimbach	1.14	#endif
74
75			#ifdef ALLOW_SEAICE
76			C-- Initialize SEAICE model.
77			IF (useSEAICE) CALL SEAICE_INIT( myThid )
78	adcroft	1.2	#endif
79
80	heimbach	1.20	cph-- moved further down
81			cph#ifdef ALLOW_OBCS
82			cphC-- Open boundaries data
83			cph IF (useOBCS) THEN
84			cph CALL OBCS_INIT_VARIABLES( myThid )
85			cph ENDIF
86			cph#endif
87	adcroft	1.11
88			#ifdef ALLOW_PTRACERS
89	heimbach	1.22	# ifndef ALLOW_AUTODIFF_TAMC
90			IF ( usePTRACERS ) THEN
91			# endif
92			CALL PTRACERS_INIT( mythid )
93	stephd	1.23	#ifdef ALLOW_GCHEM
94			CALL GCHEM_INIT_VARI( mythid )
95			#endif
96	heimbach	1.22	# ifndef ALLOW_AUTODIFF_TAMC
97			ENDIF
98			# endif
99	jmc	1.19	#endif
100
101			#ifdef ALLOW_LAND
102			IF ( useLAND ) CALL LAND_INI_VARS( mythid )
103	adcroft	1.2	#endif
104
105	heimbach	1.26	#ifdef ALLOW_AUTODIFF
106	heimbach	1.20	c-- Initialise auxiliary xx_ fields
107			CALL CTRL_INIT_VARIABLES ( mythid )
108			c-- Map the control variables onto the model state.
109			CALL CTRL_MAP_INI( mythid )
110	heimbach	1.5	_BARRIER
111	dimitri	1.18	#endif
112
113			#ifdef INCLUDE_EXTERNAL_FORCING_PACKAGE
114			CALL EXF_INIT( mythid )
115			#else
116			CALL INI_FORCING( mythid )
117	heimbach	1.5	#endif
118
119	heimbach	1.20	#ifdef ALLOW_COST
120	heimbach	1.12	c-- Initialise the cost function.
121	edhill	1.24	ceh3 needs an IF ( useCOST ) THEN
122	heimbach	1.20	CALL COST_INITVARIA( mythid )
123	heimbach	1.12	_BARRIER
124	heimbach	1.20	#endif
125
126			#ifdef ALLOW_OBCS
127			C-- Open boundaries data
128			IF (useOBCS) CALL OBCS_INIT_VARIABLES( myThid )
129	adcroft	1.2	#endif
130
131	cheisey	1.16	cswdblk -- begin add ---
132	cheisey	1.17	#ifdef ALLOW_BULK_FORCE
133			IF (useBulkForce) call BULKF_INIT( mythid)
134	cheisey	1.16	#endif
135			cswdblk ---end add ---
136
137			cswdice ---begin add ---
138	cheisey	1.17	#ifdef ALLOW_THERM_SEAICE
139			IF (useThermSeaIce) call ICE_INIT( mythid)
140	cheisey	1.16	#endif
141			cswdice ---end add ---
142
143
144	adcroft	1.2	RETURN
145			END