model/src/packages_init_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.87 2015/12/25 15:19:30 gforget Exp $
C $Name:  $

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

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

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE PACKAGES_INIT_FIXED
C     | o Does initialisation of package-related fixed fields
C     *==========================================================*
C     \ev

C     !CALLING SEQUENCE:
C     PACKAGES_INIT_FIXED
C       |
C       |-- RUNCLOCK_INIT
C       |
C       |-- CAL_INIT_FIXED
C       |
C       |-- DIAGNOSTICS_INIT_EARLY
C       |-- DIAGNOSTICS_MAIN_INIT
C       |
C       |-- GAD_INIT_FIXED
C       |
C       |-- MOM_INIT_FIXED
C       |
C       |-- CD_CODE_INIT_FIXED
C       |
C       |-- OBCS_INIT_FIXED
C       |
C       |-- SHAP_FILT_INIT_FIZED
C       |
C       |-- ZONAL_FILT_INIT
C       |
C       |-- EXF_INIT_FIXED
C       |
C       |-- CHEAPAML_INIT_FIXED
C       |
C       |-- OPPS_INIT
C       |
C       |-- PP81_INIT_FIXED
C       |
C       |-- KL10_INIT_FIXED
C       |
C       |-- MY82_INIT_FIXED
C       |
C       |-- GGL90_INIT_FIXED
C       |
C       |-- KPP_INIT_FIXED
C       |
C       |-- GMREDI_INIT_FIXED
C       |
C       |-- BBL_INIT_FIXED
C       |
C       |-- DWNSLP_INIT_FIXED
C       |
C       |-- SEAICE_COST_INIT_FIXED
C       |
C       |-- SMOOTH_INIT_FIXED
C       |
C       |-- ECCO_COST_INIT_FIXED
C       |
C       |-- PROFILES_INIT_FIXED
C       |
C       |-- FLT_INIT_FIXED
C       |
C       |-- LONGSTEP_INIT_FIXED
C       |
C       |-- PTRACERS_INIT_FIXED
C       |
C       |-- GCHEM_INIT_FIXED
C       |
C       |-- RBCS_INIT_FIXED
C       |
C       |-- FRAZIL_INIT_FIXED
C       |
C       |-- SEAICE_INIT_FIXED
C       |
C       |-- SALT_PLUME_INIT_FIXED
C       |
C       |-- SHELFICE_INIT_FIXED
C       |
C       |-- STREAMICE_INIT_FIXED
C       |
C       |-- ICEFRONT_INIT_FIXED
C       |
C       |-- THSICE_INIT_FIXED
C       |
C       |-- LAND_INIT_FIXED
C       |
C       |-- ATM2D_INIT_FIXED
C       |
C       |-- AIM_INITIALISE
C       |
C       |-- ATM_PHYS_INIT_FIXED
C       |
C       |-- FIZHI_INIT_FIXED
C       |
C       |-- GRIDALT_INITIALISE
C       |
C       |-- TIMEAVE_INIT_FIXED
C       |
C       |-- REGRID_INIT_FIXED
C       |
C       |-- LAYERS_INIT_FIXED
C       |
C       |-- CPL_INIT_FIXED
C       |
C       |-- OASIS_INIT_FIXED
C       |
C       |-- EMBED_FILES_INIT
C       |
C       |-- MYPACKAGE_INIT_FIXED
C       |
C       |-- CTRL_INIT
C       |-- CTRL_ADMTLM
C       |
C       |-- DIAGNOSTICS_INIT_FIXED

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 :: my Thread Id Number
      INTEGER myThid
CEOP

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

#ifdef ALLOW_RUNCLOCK
      IF ( useRunClock ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('RUNCLOCK_INIT',myThid)
# endif
        CALL RUNCLOCK_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_CAL
C--   Initialise the calendar package.
      IF ( useCAL ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('CAL_INIT_FIXED',myThid)
# endif
        CALL CAL_INIT_FIXED( myThid )
      ENDIF
#endif /* ALLOW_CAL */

#ifdef ALLOW_DIAGNOSTICS
      IF ( useDiagnostics ) THEN
C-    needs to call DIAGNOSTICS_INIT_EARLY before all package-diag-init calls
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('DIAGNOSTICS_INIT_EARLY',myThid)
# endif
        CALL DIAGNOSTICS_INIT_EARLY( myThid )
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('DIAGNOSTICS_MAIN_INIT',myThid)
# endif
        CALL DIAGNOSTICS_MAIN_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_GENERIC_ADVDIFF
C--   Initialize fixed params for GAD
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('GAD_INIT_FIXED',myThid)
# endif
      CALL GAD_INIT_FIXED( myThid )
#endif

#ifdef ALLOW_MOM_COMMON
C--   Initialize fixed params for Momentum pkgs (common, fluxform, vecinv)
      IF ( momStepping ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('MOM_INIT_FIXED',myThid)
# endif
        CALL MOM_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_CD_CODE
      IF (useCDscheme) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('CD_CODE_INIT_FIXED',myThid)
# endif
        CALL CD_CODE_INIT_FIXED(myThid)
      ENDIF
#endif

C--   Initialize fixed arrays for OBCS
#ifdef ALLOW_OBCS
      IF (useOBCS) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('OBCS_INIT_FIXED',myThid)
# endif
        CALL OBCS_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_SHAP_FILT
C--   Shapiro filter initialisation
      IF (useSHAP_FILT) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('SHAP_FILT_INIT_FIXED',myThid)
# endif
        CALL SHAP_FILT_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_ZONAL_FILT
C--   Latitude circle filter initialisation
      IF (useZONAL_FILT) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('ZONAL_FILT_INIT',myThid)
# endif
        CALL ZONAL_FILT_INIT(myThid)
      ENDIF
#endif

#ifdef ALLOW_EXF
C--   Initialize fixed arrays for EXF
      IF ( useEXF ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('EXF_INIT_FIXED',myThid)
# endif
        CALL EXF_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_CHEAPAML
      IF ( useCheapAML ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('CHEAPAML_INIT_FIXED',myThid)
# endif
        CALL CHEAPAML_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_OPPS
      IF (useOPPS) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('OPPS_INIT',myThid)
# endif
        CALL OPPS_INIT( myThid )
      ENDIF
#endif /* ALLOW_OPPS */

#ifdef ALLOW_PP81
C--   Initialize fixed arrays for PP81
      IF ( usePP81 ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('PP81_INIT_FIXED',myThid)
# endif
        CALL PP81_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_KL10
C--   Initialize fixed arrays for KL10
      IF ( useKL10 ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('KL10_INIT_FIXED',myThid)
# endif
        CALL KL10_INIT_FIXED( myThid )
      ENDIF
#endif /* ALLOW_KL10 */

#ifdef ALLOW_MY82
C--   Initialize fixed arrays for MY82
      IF ( useMY82 ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('MY82_INIT_FIXED',myThid)
# endif
        CALL MY82_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_GGL90
C--   Initialize fixed arrays for GGL90
      IF ( useGGL90 ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('GGL90_INIT_FIXED',myThid)
# endif
        CALL GGL90_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_KPP
C--   Initialize fixed arrays for KPP
      IF ( useKPP ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('KPP_INIT_FIXED',myThid)
# endif
        CALL KPP_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_GMREDI
C--   Initialize fixed arrays for GM-Redi
      IF ( useGMRedi ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('GMREDI_INIT_FIXED',myThid)
# endif
        CALL GMREDI_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_BBL
C--   Initialize fixed arrays for BBL pkg
      IF ( useBBL ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('BBL_INIT_FIXED',myThid)
# endif
        CALL BBL_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_DOWN_SLOPE
C--   Initialize fixed arrays for Down-Slope pkg
      IF ( useDOWN_SLOPE ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('DWNSLP_INIT_FIXED',myThid)
# endif
        CALL DWNSLP_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_SEAICE
C--   Initialise ecco-specific cost function.
C--   This needs to preceed the call ctrl_init
C--   in order to provide the weight files
      IF (useSEAICE) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('SEAICE_COST_INIT_FIXED',myThid)
# endif
        CALL SEAICE_COST_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_SMOOTH
      IF (useSMOOTH) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('SMOOTH_INIT_FIXED',myThid)
# endif
        CALL SMOOTH_INIT_FIXED(myThid)
      ENDIF
#endif /* ALLOW_SMOOTH */

#ifdef ALLOW_ECCO
      IF (useECCO) THEN
C--   Initialise ecco-specific cost function. This needs to preceed 
C     the call ctrl_init in order to provide the weight files
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('ECCO_COST_INIT_FIXED',myThid)
# endif
        CALL ECCO_COST_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_PROFILES
      IF (usePROFILES) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('PROFILES_INIT_FIXED',myThid)
# endif
        CALL PROFILES_INIT_FIXED( myThid )
      ENDIF
#endif

C--   Old place where CTRL_INIT & CTRL_ADMTLM used to be called

#ifdef ALLOW_FLT
C--   Initialise fixed array for Float pkg
      IF ( useFLT ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('FLT_INIT_FIXED',myThid)
# endif
        CALL FLT_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_LONGSTEP
      IF (usePTRACERS) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('LONGSTEP_INIT_FIXED',myThid)
# endif
        CALL LONGSTEP_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_PTRACERS
      IF (usePTRACERS) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('PTRACERS_INIT_FIXED',myThid)
# endif
        CALL PTRACERS_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_GCHEM
      IF (useGCHEM) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('GCHEM_INIT_FIXED',myThid)
# endif
        CALL GCHEM_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_RBCS
      IF (useRBCS) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('RBCS_INIT_FIXED',myThid)
# endif
        CALL RBCS_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_FRAZIL
      IF (useFRAZIL) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('FRAZIL_INIT_FIXED',myThid)
# endif
        CALL FRAZIL_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_SEAICE
      IF (useSEAICE) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('SEAICE_INIT_FIXED',myThid)
# endif
        CALL SEAICE_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_SALT_PLUME
      IF (useSALT_PLUME) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('SALT_PLUME_INIT_FIXED',myThid)
# endif
        CALL SALT_PLUME_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_SHELFICE
      IF (useShelfIce) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('SHELFICE_INIT_FIXED',myThid)
# endif
        CALL SHELFICE_INIT_FIXED( myThid )
      ENDIF
#endif /* ALLOW_SHELFICE */

#ifdef ALLOW_STREAMICE
      IF (useStreamIce) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('STREAMICE_INIT_FIXED',myThid)
# endif
#ifndef ALLOW_OPENAD
       CALL STREAMICE_INIT_FIXED( myThid )
#else
       CALL OPENAD_STREAMICE_INIT_FIXED( myThid )
#endif
      ENDIF
#endif /* ALLOW_STREAMICE */

#ifdef ALLOW_ICEFRONT
      IF (useICEFRONT) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('ICEFRONT_INIT_FIXED',myThid)
# endif
        CALL ICEFRONT_INIT_FIXED( myThid )
      ENDIF
#endif /* ALLOW_ICEFRONT */

#ifdef ALLOW_THSICE
      IF (useThSIce) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('THSICE_INIT_FIXED',myThid)
# endif
        CALL THSICE_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_LAND
C--   Initialise Land package
      IF ( useLand ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('LAND_INIT_FIXED',myThid)
# endif
        CALL LAND_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_ATM2D
      IF ( useAtm2d ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('ATM2D_INIT_FIXED',myThid)
# endif
        CALL ATM2D_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_AIM
C--   Initialise & Read AIM physical parameters
      IF (useAIM) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('AIM_INITIALISE',myThid)
# endif
        CALL AIM_INITIALISE( myThid )
      ENDIF
#endif

#ifdef ALLOW_ATM_PHYS
C--   Initialise Atm_Phys pkg
      IF ( useAtm_Phys ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('ATM_PHYS_INIT_FIXED',myThid)
# endif
        CALL ATM_PHYS_INIT_FIXED( myThid )
      ENDIF
#endif /* ALLOW_ATM_PHYS */

#ifdef ALLOW_FIZHI
C--   Initialise & Read FIZHI physical parameters
      IF (useFIZHI) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('FIZHI_INIT_FIXED',myThid)
# endif
        CALL FIZHI_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_GRIDALT
C--   Initialise GRIDALT parameters - the alternative grid
      IF (useGRIDALT) then
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('GRIDALT_INITIALISE',myThid)
# endif
        CALL GRIDALT_INITIALISE( myThid )
      ENDIF
#endif

#ifdef ALLOW_TIMEAVE
C     IF (useTIMEAVE) THEN
      IF ( taveFreq.GT.0. ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('TIMEAVE_INIT_FIXED',myThid)
# endif
        CALL TIMEAVE_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_REGRID
      IF ( useREGRID ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('REGRID_INIT_FIXED',myThid)
# endif
        CALL REGRID_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_LAYERS
      IF ( useLayers ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('LAYERS_INIT_FIXED',myThid)
# endif
        CALL LAYERS_INIT_FIXED( myThid )
      ENDIF
#endif /* ALLOW_LAYERS */

#ifdef COMPONENT_MODULE
      IF ( useCoupler ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('CPL_INIT_FIXED',myThid)
# endif
        CALL CPL_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_OASIS
C--   needs to be called after the OASIS_INIT
      IF (useOASIS) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('OASIS_INIT_FIXED',myThid)
# endif
        CALL OASIS_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_EMBED_FILES
      IF ( useEMBED_FILES ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('EMBED_FILES_INIT',myThid)
# endif
        CALL EMBED_FILES_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_MYPACKAGE
      IF (useMYPACKAGE) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('MYPACKAGE_INIT_FIXED',myThid)
# endif
        CALL MYPACKAGE_INIT_FIXED(myThid)
      ENDIF
#endif

#ifdef ALLOW_CTRL
      IF (useCTRL) THEN
C--   Initialise the control variables. Moved to the end of this S/R 
C     to allow other pkgs to set mask and weight fields.
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('CTRL_INIT',myThid)
# endif
        CALL CTRL_INIT( myThid )
      ENDIF

# ifdef ALLOW_ADMTLM
      IF (useCTRL) THEN
C--   Initialise ADMTLM
#  ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('CTRL_ADMTLM',myThid)
#  endif
        CALL CTRL_ADMTLM( myThid )
      ENDIF
# endif /* ALLOW_ADMTLM */
#endif /* ALLOW_CTRL */

#ifdef ALLOW_DIAGNOSTICS
C-    needs to call DIAGNOSTICS_INIT_FIXED after all package-diag-init calls
      IF ( useDiagnostics ) THEN
# ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('DIAGNOSTICS_INIT_FIXED',myThid)
# endif
        CALL DIAGNOSTICS_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_LEAVE('PACKAGES_INIT_FIXED',myThid)
#endif

      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.87 2015/12/25 15:19:30 gforget Exp $
2	C $Name: $
3
4	#include "PACKAGES_CONFIG.h"
5	#include "CPP_OPTIONS.h"
6
7	CBOP
8	C !ROUTINE: PACKAGES_INIT_FIXED
9	C !INTERFACE:
10	SUBROUTINE PACKAGES_INIT_FIXED( myThid )
11
12	C !DESCRIPTION: \bv
13	C ==========================================================
14	C \| SUBROUTINE PACKAGES_INIT_FIXED
15	C \| o Does initialisation of package-related fixed fields
16	C ==========================================================
17	C \ev
18
19	C !CALLING SEQUENCE:
20	C PACKAGES_INIT_FIXED
21	C \|
22	C \|-- RUNCLOCK_INIT
23	C \|
24	C \|-- CAL_INIT_FIXED
25	C \|
26	C \|-- DIAGNOSTICS_INIT_EARLY
27	C \|-- DIAGNOSTICS_MAIN_INIT
28	C \|
29	C \|-- GAD_INIT_FIXED
30	C \|
31	C \|-- MOM_INIT_FIXED
32	C \|
33	C \|-- CD_CODE_INIT_FIXED
34	C \|
35	C \|-- OBCS_INIT_FIXED
36	C \|
37	C \|-- SHAP_FILT_INIT_FIZED
38	C \|
39	C \|-- ZONAL_FILT_INIT
40	C \|
41	C \|-- EXF_INIT_FIXED
42	C \|
43	C \|-- CHEAPAML_INIT_FIXED
44	C \|
45	C \|-- OPPS_INIT
46	C \|
47	C \|-- PP81_INIT_FIXED
48	C \|
49	C \|-- KL10_INIT_FIXED
50	C \|
51	C \|-- MY82_INIT_FIXED
52	C \|
53	C \|-- GGL90_INIT_FIXED
54	C \|
55	C \|-- KPP_INIT_FIXED
56	C \|
57	C \|-- GMREDI_INIT_FIXED
58	C \|
59	C \|-- BBL_INIT_FIXED
60	C \|
61	C \|-- DWNSLP_INIT_FIXED
62	C \|
63	C \|-- SEAICE_COST_INIT_FIXED
64	C \|
65	C \|-- SMOOTH_INIT_FIXED
66	C \|
67	C \|-- ECCO_COST_INIT_FIXED
68	C \|
69	C \|-- PROFILES_INIT_FIXED
70	C \|
71	C \|-- FLT_INIT_FIXED
72	C \|
73	C \|-- LONGSTEP_INIT_FIXED
74	C \|
75	C \|-- PTRACERS_INIT_FIXED
76	C \|
77	C \|-- GCHEM_INIT_FIXED
78	C \|
79	C \|-- RBCS_INIT_FIXED
80	C \|
81	C \|-- FRAZIL_INIT_FIXED
82	C \|
83	C \|-- SEAICE_INIT_FIXED
84	C \|
85	C \|-- SALT_PLUME_INIT_FIXED
86	C \|
87	C \|-- SHELFICE_INIT_FIXED
88	C \|
89	C \|-- STREAMICE_INIT_FIXED
90	C \|
91	C \|-- ICEFRONT_INIT_FIXED
92	C \|
93	C \|-- THSICE_INIT_FIXED
94	C \|
95	C \|-- LAND_INIT_FIXED
96	C \|
97	C \|-- ATM2D_INIT_FIXED
98	C \|
99	C \|-- AIM_INITIALISE
100	C \|
101	C \|-- ATM_PHYS_INIT_FIXED
102	C \|
103	C \|-- FIZHI_INIT_FIXED
104	C \|
105	C \|-- GRIDALT_INITIALISE
106	C \|
107	C \|-- TIMEAVE_INIT_FIXED
108	C \|
109	C \|-- REGRID_INIT_FIXED
110	C \|
111	C \|-- LAYERS_INIT_FIXED
112	C \|
113	C \|-- CPL_INIT_FIXED
114	C \|
115	C \|-- OASIS_INIT_FIXED
116	C \|
117	C \|-- EMBED_FILES_INIT
118	C \|
119	C \|-- MYPACKAGE_INIT_FIXED
120	C \|
121	C \|-- CTRL_INIT
122	C \|-- CTRL_ADMTLM
123	C \|
124	C \|-- DIAGNOSTICS_INIT_FIXED
125
126	C !USES:
127	IMPLICIT NONE
128	C === Global variables ===
129	#include "SIZE.h"
130	#include "EEPARAMS.h"
131	#include "PARAMS.h"
132
133	C !INPUT/OUTPUT PARAMETERS:
134	C === Routine arguments ===
135	C myThid :: my Thread Id Number
136	INTEGER myThid
137	CEOP
138
139	#ifdef ALLOW_DEBUG
140	IF (debugMode) CALL DEBUG_ENTER('PACKAGES_INIT_FIXED',myThid)
141	#endif
142
143	#ifdef ALLOW_RUNCLOCK
144	IF ( useRunClock ) THEN
145	# ifdef ALLOW_DEBUG
146	IF (debugMode) CALL DEBUG_CALL('RUNCLOCK_INIT',myThid)
147	# endif
148	CALL RUNCLOCK_INIT( myThid )
149	ENDIF
150	#endif
151
152	#ifdef ALLOW_CAL
153	C-- Initialise the calendar package.
154	IF ( useCAL ) THEN
155	# ifdef ALLOW_DEBUG
156	IF (debugMode) CALL DEBUG_CALL('CAL_INIT_FIXED',myThid)
157	# endif
158	CALL CAL_INIT_FIXED( myThid )
159	ENDIF
160	#endif /* ALLOW_CAL */
161
162	#ifdef ALLOW_DIAGNOSTICS
163	IF ( useDiagnostics ) THEN
164	C- needs to call DIAGNOSTICS_INIT_EARLY before all package-diag-init calls
165	# ifdef ALLOW_DEBUG
166	IF (debugMode) CALL DEBUG_CALL('DIAGNOSTICS_INIT_EARLY',myThid)
167	# endif
168	CALL DIAGNOSTICS_INIT_EARLY( myThid )
169	# ifdef ALLOW_DEBUG
170	IF (debugMode) CALL DEBUG_CALL('DIAGNOSTICS_MAIN_INIT',myThid)
171	# endif
172	CALL DIAGNOSTICS_MAIN_INIT( myThid )
173	ENDIF
174	#endif
175
176	#ifdef ALLOW_GENERIC_ADVDIFF
177	C-- Initialize fixed params for GAD
178	# ifdef ALLOW_DEBUG
179	IF (debugMode) CALL DEBUG_CALL('GAD_INIT_FIXED',myThid)
180	# endif
181	CALL GAD_INIT_FIXED( myThid )
182	#endif
183
184	#ifdef ALLOW_MOM_COMMON
185	C-- Initialize fixed params for Momentum pkgs (common, fluxform, vecinv)
186	IF ( momStepping ) THEN
187	# ifdef ALLOW_DEBUG
188	IF (debugMode) CALL DEBUG_CALL('MOM_INIT_FIXED',myThid)
189	# endif
190	CALL MOM_INIT_FIXED( myThid )
191	ENDIF
192	#endif
193
194	#ifdef ALLOW_CD_CODE
195	IF (useCDscheme) THEN
196	# ifdef ALLOW_DEBUG
197	IF (debugMode) CALL DEBUG_CALL('CD_CODE_INIT_FIXED',myThid)
198	# endif
199	CALL CD_CODE_INIT_FIXED(myThid)
200	ENDIF
201	#endif
202
203	C-- Initialize fixed arrays for OBCS
204	#ifdef ALLOW_OBCS
205	IF (useOBCS) THEN
206	# ifdef ALLOW_DEBUG
207	IF (debugMode) CALL DEBUG_CALL('OBCS_INIT_FIXED',myThid)
208	# endif
209	CALL OBCS_INIT_FIXED( myThid )
210	ENDIF
211	#endif
212
213	#ifdef ALLOW_SHAP_FILT
214	C-- Shapiro filter initialisation
215	IF (useSHAP_FILT) THEN
216	# ifdef ALLOW_DEBUG
217	IF (debugMode) CALL DEBUG_CALL('SHAP_FILT_INIT_FIXED',myThid)
218	# endif
219	CALL SHAP_FILT_INIT_FIXED( myThid )
220	ENDIF
221	#endif
222
223	#ifdef ALLOW_ZONAL_FILT
224	C-- Latitude circle filter initialisation
225	IF (useZONAL_FILT) THEN
226	# ifdef ALLOW_DEBUG
227	IF (debugMode) CALL DEBUG_CALL('ZONAL_FILT_INIT',myThid)
228	# endif
229	CALL ZONAL_FILT_INIT(myThid)
230	ENDIF
231	#endif
232
233	#ifdef ALLOW_EXF
234	C-- Initialize fixed arrays for EXF
235	IF ( useEXF ) THEN
236	# ifdef ALLOW_DEBUG
237	IF (debugMode) CALL DEBUG_CALL('EXF_INIT_FIXED',myThid)
238	# endif
239	CALL EXF_INIT_FIXED( myThid )
240	ENDIF
241	#endif
242
243	#ifdef ALLOW_CHEAPAML
244	IF ( useCheapAML ) THEN
245	# ifdef ALLOW_DEBUG
246	IF (debugMode) CALL DEBUG_CALL('CHEAPAML_INIT_FIXED',myThid)
247	# endif
248	CALL CHEAPAML_INIT_FIXED( myThid )
249	ENDIF
250	#endif
251
252	#ifdef ALLOW_OPPS
253	IF (useOPPS) THEN
254	# ifdef ALLOW_DEBUG
255	IF (debugMode) CALL DEBUG_CALL('OPPS_INIT',myThid)
256	# endif
257	CALL OPPS_INIT( myThid )
258	ENDIF
259	#endif /* ALLOW_OPPS */
260
261	#ifdef ALLOW_PP81
262	C-- Initialize fixed arrays for PP81
263	IF ( usePP81 ) THEN
264	# ifdef ALLOW_DEBUG
265	IF (debugMode) CALL DEBUG_CALL('PP81_INIT_FIXED',myThid)
266	# endif
267	CALL PP81_INIT_FIXED( myThid )
268	ENDIF
269	#endif
270
271	#ifdef ALLOW_KL10
272	C-- Initialize fixed arrays for KL10
273	IF ( useKL10 ) THEN
274	# ifdef ALLOW_DEBUG
275	IF (debugMode) CALL DEBUG_CALL('KL10_INIT_FIXED',myThid)
276	# endif
277	CALL KL10_INIT_FIXED( myThid )
278	ENDIF
279	#endif /* ALLOW_KL10 */
280
281	#ifdef ALLOW_MY82
282	C-- Initialize fixed arrays for MY82
283	IF ( useMY82 ) THEN
284	# ifdef ALLOW_DEBUG
285	IF (debugMode) CALL DEBUG_CALL('MY82_INIT_FIXED',myThid)
286	# endif
287	CALL MY82_INIT_FIXED( myThid )
288	ENDIF
289	#endif
290
291	#ifdef ALLOW_GGL90
292	C-- Initialize fixed arrays for GGL90
293	IF ( useGGL90 ) THEN
294	# ifdef ALLOW_DEBUG
295	IF (debugMode) CALL DEBUG_CALL('GGL90_INIT_FIXED',myThid)
296	# endif
297	CALL GGL90_INIT_FIXED( myThid )
298	ENDIF
299	#endif
300
301	#ifdef ALLOW_KPP
302	C-- Initialize fixed arrays for KPP
303	IF ( useKPP ) THEN
304	# ifdef ALLOW_DEBUG
305	IF (debugMode) CALL DEBUG_CALL('KPP_INIT_FIXED',myThid)
306	# endif
307	CALL KPP_INIT_FIXED( myThid )
308	ENDIF
309	#endif
310
311	#ifdef ALLOW_GMREDI
312	C-- Initialize fixed arrays for GM-Redi
313	IF ( useGMRedi ) THEN
314	# ifdef ALLOW_DEBUG
315	IF (debugMode) CALL DEBUG_CALL('GMREDI_INIT_FIXED',myThid)
316	# endif
317	CALL GMREDI_INIT_FIXED( myThid )
318	ENDIF
319	#endif
320
321	#ifdef ALLOW_BBL
322	C-- Initialize fixed arrays for BBL pkg
323	IF ( useBBL ) THEN
324	# ifdef ALLOW_DEBUG
325	IF (debugMode) CALL DEBUG_CALL('BBL_INIT_FIXED',myThid)
326	# endif
327	CALL BBL_INIT_FIXED( myThid )
328	ENDIF
329	#endif
330
331	#ifdef ALLOW_DOWN_SLOPE
332	C-- Initialize fixed arrays for Down-Slope pkg
333	IF ( useDOWN_SLOPE ) THEN
334	# ifdef ALLOW_DEBUG
335	IF (debugMode) CALL DEBUG_CALL('DWNSLP_INIT_FIXED',myThid)
336	# endif
337	CALL DWNSLP_INIT_FIXED( myThid )
338	ENDIF
339	#endif
340
341	#ifdef ALLOW_SEAICE
342	C-- Initialise ecco-specific cost function.
343	C-- This needs to preceed the call ctrl_init
344	C-- in order to provide the weight files
345	IF (useSEAICE) THEN
346	# ifdef ALLOW_DEBUG
347	IF (debugMode) CALL DEBUG_CALL('SEAICE_COST_INIT_FIXED',myThid)
348	# endif
349	CALL SEAICE_COST_INIT_FIXED( myThid )
350	ENDIF
351	#endif
352
353	#ifdef ALLOW_SMOOTH
354	IF (useSMOOTH) THEN
355	# ifdef ALLOW_DEBUG
356	IF (debugMode) CALL DEBUG_CALL('SMOOTH_INIT_FIXED',myThid)
357	# endif
358	CALL SMOOTH_INIT_FIXED(myThid)
359	ENDIF
360	#endif /* ALLOW_SMOOTH */
361
362	#ifdef ALLOW_ECCO
363	IF (useECCO) THEN
364	C-- Initialise ecco-specific cost function. This needs to preceed
365	C the call ctrl_init in order to provide the weight files
366	# ifdef ALLOW_DEBUG
367	IF (debugMode) CALL DEBUG_CALL('ECCO_COST_INIT_FIXED',myThid)
368	# endif
369	CALL ECCO_COST_INIT_FIXED( myThid )
370	ENDIF
371	#endif
372
373	#ifdef ALLOW_PROFILES
374	IF (usePROFILES) THEN
375	# ifdef ALLOW_DEBUG
376	IF (debugMode) CALL DEBUG_CALL('PROFILES_INIT_FIXED',myThid)
377	# endif
378	CALL PROFILES_INIT_FIXED( myThid )
379	ENDIF
380	#endif
381
382	C-- Old place where CTRL_INIT & CTRL_ADMTLM used to be called
383
384	#ifdef ALLOW_FLT
385	C-- Initialise fixed array for Float pkg
386	IF ( useFLT ) THEN
387	# ifdef ALLOW_DEBUG
388	IF (debugMode) CALL DEBUG_CALL('FLT_INIT_FIXED',myThid)
389	# endif
390	CALL FLT_INIT_FIXED( myThid )
391	ENDIF
392	#endif
393
394	#ifdef ALLOW_LONGSTEP
395	IF (usePTRACERS) THEN
396	# ifdef ALLOW_DEBUG
397	IF (debugMode) CALL DEBUG_CALL('LONGSTEP_INIT_FIXED',myThid)
398	# endif
399	CALL LONGSTEP_INIT_FIXED(myThid)
400	ENDIF
401	#endif
402
403	#ifdef ALLOW_PTRACERS
404	IF (usePTRACERS) THEN
405	# ifdef ALLOW_DEBUG
406	IF (debugMode) CALL DEBUG_CALL('PTRACERS_INIT_FIXED',myThid)
407	# endif
408	CALL PTRACERS_INIT_FIXED(myThid)
409	ENDIF
410	#endif
411
412	#ifdef ALLOW_GCHEM
413	IF (useGCHEM) THEN
414	# ifdef ALLOW_DEBUG
415	IF (debugMode) CALL DEBUG_CALL('GCHEM_INIT_FIXED',myThid)
416	# endif
417	CALL GCHEM_INIT_FIXED(myThid)
418	ENDIF
419	#endif
420
421	#ifdef ALLOW_RBCS
422	IF (useRBCS) THEN
423	# ifdef ALLOW_DEBUG
424	IF (debugMode) CALL DEBUG_CALL('RBCS_INIT_FIXED',myThid)
425	# endif
426	CALL RBCS_INIT_FIXED(myThid)
427	ENDIF
428	#endif
429
430	#ifdef ALLOW_FRAZIL
431	IF (useFRAZIL) THEN
432	# ifdef ALLOW_DEBUG
433	IF (debugMode) CALL DEBUG_CALL('FRAZIL_INIT_FIXED',myThid)
434	# endif
435	CALL FRAZIL_INIT_FIXED(myThid)
436	ENDIF
437	#endif
438
439	#ifdef ALLOW_SEAICE
440	IF (useSEAICE) THEN
441	# ifdef ALLOW_DEBUG
442	IF (debugMode) CALL DEBUG_CALL('SEAICE_INIT_FIXED',myThid)
443	# endif
444	CALL SEAICE_INIT_FIXED(myThid)
445	ENDIF
446	#endif
447
448	#ifdef ALLOW_SALT_PLUME
449	IF (useSALT_PLUME) THEN
450	# ifdef ALLOW_DEBUG
451	IF (debugMode) CALL DEBUG_CALL('SALT_PLUME_INIT_FIXED',myThid)
452	# endif
453	CALL SALT_PLUME_INIT_FIXED(myThid)
454	ENDIF
455	#endif
456
457	#ifdef ALLOW_SHELFICE
458	IF (useShelfIce) THEN
459	# ifdef ALLOW_DEBUG
460	IF (debugMode) CALL DEBUG_CALL('SHELFICE_INIT_FIXED',myThid)
461	# endif
462	CALL SHELFICE_INIT_FIXED( myThid )
463	ENDIF
464	#endif /* ALLOW_SHELFICE */
465
466	#ifdef ALLOW_STREAMICE
467	IF (useStreamIce) THEN
468	# ifdef ALLOW_DEBUG
469	IF (debugMode) CALL DEBUG_CALL('STREAMICE_INIT_FIXED',myThid)
470	# endif
471	#ifndef ALLOW_OPENAD
472	CALL STREAMICE_INIT_FIXED( myThid )
473	#else
474	CALL OPENAD_STREAMICE_INIT_FIXED( myThid )
475	#endif
476	ENDIF
477	#endif /* ALLOW_STREAMICE */
478
479	#ifdef ALLOW_ICEFRONT
480	IF (useICEFRONT) THEN
481	# ifdef ALLOW_DEBUG
482	IF (debugMode) CALL DEBUG_CALL('ICEFRONT_INIT_FIXED',myThid)
483	# endif
484	CALL ICEFRONT_INIT_FIXED( myThid )
485	ENDIF
486	#endif /* ALLOW_ICEFRONT */
487
488	#ifdef ALLOW_THSICE
489	IF (useThSIce) THEN
490	# ifdef ALLOW_DEBUG
491	IF (debugMode) CALL DEBUG_CALL('THSICE_INIT_FIXED',myThid)
492	# endif
493	CALL THSICE_INIT_FIXED(myThid)
494	ENDIF
495	#endif
496
497	#ifdef ALLOW_LAND
498	C-- Initialise Land package
499	IF ( useLand ) THEN
500	# ifdef ALLOW_DEBUG
501	IF (debugMode) CALL DEBUG_CALL('LAND_INIT_FIXED',myThid)
502	# endif
503	CALL LAND_INIT_FIXED( myThid )
504	ENDIF
505	#endif
506
507	#ifdef ALLOW_ATM2D
508	IF ( useAtm2d ) THEN
509	# ifdef ALLOW_DEBUG
510	IF (debugMode) CALL DEBUG_CALL('ATM2D_INIT_FIXED',myThid)
511	# endif
512	CALL ATM2D_INIT_FIXED( myThid )
513	ENDIF
514	#endif
515
516	#ifdef ALLOW_AIM
517	C-- Initialise & Read AIM physical parameters
518	IF (useAIM) THEN
519	# ifdef ALLOW_DEBUG
520	IF (debugMode) CALL DEBUG_CALL('AIM_INITIALISE',myThid)
521	# endif
522	CALL AIM_INITIALISE( myThid )
523	ENDIF
524	#endif
525
526	#ifdef ALLOW_ATM_PHYS
527	C-- Initialise Atm_Phys pkg
528	IF ( useAtm_Phys ) THEN
529	# ifdef ALLOW_DEBUG
530	IF (debugMode) CALL DEBUG_CALL('ATM_PHYS_INIT_FIXED',myThid)
531	# endif
532	CALL ATM_PHYS_INIT_FIXED( myThid )
533	ENDIF
534	#endif /* ALLOW_ATM_PHYS */
535
536	#ifdef ALLOW_FIZHI
537	C-- Initialise & Read FIZHI physical parameters
538	IF (useFIZHI) THEN
539	# ifdef ALLOW_DEBUG
540	IF (debugMode) CALL DEBUG_CALL('FIZHI_INIT_FIXED',myThid)
541	# endif
542	CALL FIZHI_INIT_FIXED( myThid )
543	ENDIF
544	#endif
545
546	#ifdef ALLOW_GRIDALT
547	C-- Initialise GRIDALT parameters - the alternative grid
548	IF (useGRIDALT) then
549	# ifdef ALLOW_DEBUG
550	IF (debugMode) CALL DEBUG_CALL('GRIDALT_INITIALISE',myThid)
551	# endif
552	CALL GRIDALT_INITIALISE( myThid )
553	ENDIF
554	#endif
555
556	#ifdef ALLOW_TIMEAVE
557	C IF (useTIMEAVE) THEN
558	IF ( taveFreq.GT.0. ) THEN
559	# ifdef ALLOW_DEBUG
560	IF (debugMode) CALL DEBUG_CALL('TIMEAVE_INIT_FIXED',myThid)
561	# endif
562	CALL TIMEAVE_INIT_FIXED( myThid )
563	ENDIF
564	#endif
565
566	#ifdef ALLOW_REGRID
567	IF ( useREGRID ) THEN
568	# ifdef ALLOW_DEBUG
569	IF (debugMode) CALL DEBUG_CALL('REGRID_INIT_FIXED',myThid)
570	# endif
571	CALL REGRID_INIT_FIXED( myThid )
572	ENDIF
573	#endif
574
575	#ifdef ALLOW_LAYERS
576	IF ( useLayers ) THEN
577	# ifdef ALLOW_DEBUG
578	IF (debugMode) CALL DEBUG_CALL('LAYERS_INIT_FIXED',myThid)
579	# endif
580	CALL LAYERS_INIT_FIXED( myThid )
581	ENDIF
582	#endif /* ALLOW_LAYERS */
583
584	#ifdef COMPONENT_MODULE
585	IF ( useCoupler ) THEN
586	# ifdef ALLOW_DEBUG
587	IF (debugMode) CALL DEBUG_CALL('CPL_INIT_FIXED',myThid)
588	# endif
589	CALL CPL_INIT_FIXED( myThid )
590	ENDIF
591	#endif
592
593	#ifdef ALLOW_OASIS
594	C-- needs to be called after the OASIS_INIT
595	IF (useOASIS) THEN
596	# ifdef ALLOW_DEBUG
597	IF (debugMode) CALL DEBUG_CALL('OASIS_INIT_FIXED',myThid)
598	# endif
599	CALL OASIS_INIT_FIXED(myThid)
600	ENDIF
601	#endif
602
603	#ifdef ALLOW_EMBED_FILES
604	IF ( useEMBED_FILES ) THEN
605	# ifdef ALLOW_DEBUG
606	IF (debugMode) CALL DEBUG_CALL('EMBED_FILES_INIT',myThid)
607	# endif
608	CALL EMBED_FILES_INIT( myThid )
609	ENDIF
610	#endif
611
612	#ifdef ALLOW_MYPACKAGE
613	IF (useMYPACKAGE) THEN
614	# ifdef ALLOW_DEBUG
615	IF (debugMode) CALL DEBUG_CALL('MYPACKAGE_INIT_FIXED',myThid)
616	# endif
617	CALL MYPACKAGE_INIT_FIXED(myThid)
618	ENDIF
619	#endif
620
621	#ifdef ALLOW_CTRL
622	IF (useCTRL) THEN
623	C-- Initialise the control variables. Moved to the end of this S/R
624	C to allow other pkgs to set mask and weight fields.
625	# ifdef ALLOW_DEBUG
626	IF (debugMode) CALL DEBUG_CALL('CTRL_INIT',myThid)
627	# endif
628	CALL CTRL_INIT( myThid )
629	ENDIF
630
631	# ifdef ALLOW_ADMTLM
632	IF (useCTRL) THEN
633	C-- Initialise ADMTLM
634	# ifdef ALLOW_DEBUG
635	IF (debugMode) CALL DEBUG_CALL('CTRL_ADMTLM',myThid)
636	# endif
637	CALL CTRL_ADMTLM( myThid )
638	ENDIF
639	# endif /* ALLOW_ADMTLM */
640	#endif /* ALLOW_CTRL */
641
642	#ifdef ALLOW_DIAGNOSTICS
643	C- needs to call DIAGNOSTICS_INIT_FIXED after all package-diag-init calls
644	IF ( useDiagnostics ) THEN
645	# ifdef ALLOW_DEBUG
646	IF (debugMode) CALL DEBUG_CALL('DIAGNOSTICS_INIT_FIXED',myThid)
647	# endif
648	CALL DIAGNOSTICS_INIT_FIXED( myThid )
649	ENDIF
650	#endif
651
652	#ifdef ALLOW_DEBUG
653	IF (debugMode) CALL DEBUG_LEAVE('PACKAGES_INIT_FIXED',myThid)
654	#endif
655
656	RETURN
657	END