model/src/initialise_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.46 2006/07/29 21:02:12 jmc Exp $
C $Name:  $

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

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

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE INITIALISE_FIXED                               
C     | o Routine for setting fixed model arrays such as          
C     |   topography, grid, solver matrices, etc.                 
C     *==========================================================*
C     | INITIALISE_FIXED is invoked at the start of the model to  
C     | set fixed model arrays. It reads data from an input file  
C     | and from various binary files.                            
C     | Each thread invokes an instance of this routine as does   
C     | each process in a multi-process parallel environment like 
C     | MPI.                                                      
C     *==========================================================*
C     \ev

C     !CALLING SEQUENCE:
C     INITIALISE_FIXED
C      |
C      |-- INI_PARMS
C      |
C      |-- PACKAGES_BOOT
C      |
C      |-- PACKAGES_READPARMS
C      | |
C      | | - MNC_INIT + MNC_CW_INIT
C      | |
C      | | - ${PKG}_READPARMS
C      |
C      |-- SET_PARMS
C      |
C      |-- INI_MODEL_IO
C      |
C      |-- MON_INIT
C      |
C      |-- INI_GRID
C      |
C      |-- INI_EOS
C      |
C      |-- INI_PHIREF
C      |
C      |-- INI_DEPTHS
C      |
C      |-- INI_MASKS_ETC
C      |
C      |-- PACKAGES_INIT_FIXED
C      |
C      |-- PACKAGES_CHECK
C      |
C      |-- INI_LINEAR_PHSURF
C      |
C      |-- INI_CORI
C      |
C      |-- INI_CG2D
C      |
C      |-- INI_CG3D
C      |
C      |-- CONFIG_CHECK
C      |
C      |-- CONFIG_SUMMARY
C      |
C      |-- WRITE_GRID
C      |
C      |-- CPL_EXCH_CONFIGS

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

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
      INTEGER myThid
CEOP

C-    here is a way to deliberately break the barrier syncronization
C     by adding a BARRIER on thread XXX only ; Used to test BAR_CHECK.
c     IF ( myThid.EQ.XXX ) THEN
c       _BARRIER
c       CALL SYSTEM('sleep 1')
c     ENDIF
C--   Check barrier synchronization:
      CALL BAR_CHECK( 2, myThid )

C--   Set model parameters.
C     Parameters are set to defaults and then updates are read from
C     an input file called data.
      CALL INI_PARMS( myThid )

C--   Configure packages
      CALL PACKAGES_BOOT( myThid )

C--   Read configuration parameters for packages
      CALL PACKAGES_READPARMS( myThid )

C--   Set (or reset) parameters (at this point, know which packages are used);
C     after this call, main model parameters are not supposed to be modified.
      CALL SET_PARMS( myThid )

C--   Write units/set precision/etc for I/O of variables/arrays belonging
C     to the core dynamical model
      CALL INI_MODEL_IO( myThid )

#ifdef ALLOW_MONITOR
C--   Initialise MONITOR I/O streams so we can report config. info
      CALL MON_INIT( myThid )
#endif

C--   Set model grid.
C     Variables defining model grid spacing are defined.
      CALL INI_GRID( myThid )

C--   Set equation of state parameters.
      CALL INI_EOS( myThid )

C--   Set pressure/geopotential reference profile
      CALL INI_PHIREF( myThid )

C--   Initialise map of depths
      CALL INI_DEPTHS( myThid )

C--   Derive masks, lopping factors and recipricols of quantities.
C     Volumes and areas are set according to grid and depth map.
      CALL INI_MASKS_ETC( myThid )

C--   Synchronize all threads after setting masks and before pkgs init.
      _BARRIER

C--   Call fixed data initialization phase of packages
      CALL PACKAGES_INIT_FIXED( myThid )

C--   Check dependances between packages
      CALL PACKAGES_CHECK( myThid )

C--   Set Bo_surf => define the Linear Relation: Phi_surf(eta)
      CALL INI_LINEAR_PHISURF( myThid )

C--   Set coriolis operators
      CALL INI_CORI( myThid )

C--   Set laplace operators for use in 2D conjugate gradient solver.
      CALL INI_CG2D( myThid )

#ifdef ALLOW_NONHYDROSTATIC
C--   Set laplace operators for use in 3D conjugate gradient solver.
ceh3 needs an IF ( useNONHYDROSTATIC ) THEN
      CALL INI_CG3D( myThid )
#endif

C--   Check parameters and model cofiguration
      CALL CONFIG_CHECK( myThid )

C--   Finally summarise the model cofiguration
      CALL CONFIG_SUMMARY( myThid )

C--   Write grid data and geometry arrays
      IF ( debugLevel.GE.debLevA .OR.
     &     startTime.EQ.baseTime ) CALL WRITE_GRID( myThid )

#ifdef COMPONENT_MODULE
C--   Post component-model configuration information to coupler
C     and get config. info for other component(s).
      IF ( useCoupler ) CALL CPL_EXCH_CONFIGS( myThid )
#endif

C--   Check barrier synchronization:
      CALL BAR_CHECK( 3, myThid )

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

      RETURN
      END
1	jmc	1.47	C $Header: /u/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.46 2006/07/29 21:02:12 jmc Exp $
2	jmc	1.11	C $Name: $
3	adcroft	1.1
4	edhill	1.13	#include "PACKAGES_CONFIG.h"
5	adcroft	1.1	#include "CPP_OPTIONS.h"
6
7	cnh	1.8	CBOP
8			C !ROUTINE: INITIALISE_FIXED
9			C !INTERFACE:
10	adcroft	1.1	SUBROUTINE INITIALISE_FIXED(myThid)
11	cnh	1.8
12			C !DESCRIPTION: \bv
13			C ==========================================================
14			C \| SUBROUTINE INITIALISE_FIXED
15			C \| o Routine for setting fixed model arrays such as
16			C \| topography, grid, solver matrices, etc.
17			C ==========================================================
18			C \| INITIALISE_FIXED is invoked at the start of the model to
19			C \| set fixed model arrays. It reads data from an input file
20			C \| and from various binary files.
21			C \| Each thread invokes an instance of this routine as does
22			C \| each process in a multi-process parallel environment like
23			C \| MPI.
24			C ==========================================================
25			C \ev
26
27			C !CALLING SEQUENCE:
28			C INITIALISE_FIXED
29			C \|
30	jmc	1.38	C \|-- INI_PARMS
31			C \|
32	edhill	1.37	C \|-- PACKAGES_BOOT
33			C \|
34			C \|-- PACKAGES_READPARMS
35	jmc	1.38	C \| \|
36	jmc	1.43	C \| \| - MNC_INIT + MNC_CW_INIT
37	jmc	1.38	C \| \|
38			C \| \| - ${PKG}_READPARMS
39	edhill	1.32	C \|
40	jmc	1.45	C \|-- SET_PARMS
41			C \|
42	jmc	1.43	C \|-- INI_MODEL_IO
43			C \|
44	cnh	1.8	C \|-- MON_INIT
45			C \|
46			C \|-- INI_GRID
47			C \|
48	jmc	1.44	C \|-- INI_EOS
49			C \|
50			C \|-- INI_PHIREF
51			C \|
52	jmc	1.38	C \|-- INI_DEPTHS
53			C \|
54	cnh	1.8	C \|-- INI_MASKS_ETC
55			C \|
56	jmc	1.15	C \|-- PACKAGES_INIT_FIXED
57			C \|
58	cnh	1.8	C \|-- PACKAGES_CHECK
59			C \|
60	jmc	1.12	C \|-- INI_LINEAR_PHSURF
61			C \|
62			C \|-- INI_CORI
63	cnh	1.8	C \|
64			C \|-- INI_CG2D
65			C \|
66			C \|-- INI_CG3D
67			C \|
68	jmc	1.9	C \|-- CONFIG_CHECK
69			C \|
70	cnh	1.8	C \|-- CONFIG_SUMMARY
71	adcroft	1.33	C \|
72			C \|-- WRITE_GRID
73	jmc	1.38	C \|
74			C \|-- CPL_EXCH_CONFIGS
75	cnh	1.8
76			C !USES:
77	adcroft	1.1	IMPLICIT NONE
78			C == Global variables ==
79			#include "SIZE.h"
80			#include "EEPARAMS.h"
81			#include "PARAMS.h"
82
83	cnh	1.8	C !INPUT/OUTPUT PARAMETERS:
84	adcroft	1.1	C == Routine arguments ==
85			INTEGER myThid
86	cnh	1.8	CEOP
87	adcroft	1.1
88	jmc	1.46	C- here is a way to deliberately break the barrier syncronization
89			C by adding a BARRIER on thread XXX only ; Used to test BAR_CHECK.
90			c IF ( myThid.EQ.XXX ) THEN
91			c _BARRIER
92			c CALL SYSTEM('sleep 1')
93			c ENDIF
94			C-- Check barrier synchronization:
95			CALL BAR_CHECK( 2, myThid )
96
97	adcroft	1.1	C-- Set model parameters.
98			C Parameters are set to defaults and then updates are read from
99			C an input file called data.
100	adcroft	1.2	CALL INI_PARMS( myThid )
101	cnh	1.6
102	edhill	1.37	C-- Configure packages
103			CALL PACKAGES_BOOT( myThid )
104
105			C-- Read configuration parameters for packages
106			CALL PACKAGES_READPARMS( myThid )
107	edhill	1.26
108	jmc	1.45	C-- Set (or reset) parameters (at this point, know which packages are used);
109			C after this call, main model parameters are not supposed to be modified.
110			CALL SET_PARMS( myThid )
111
112	jmc	1.43	C-- Write units/set precision/etc for I/O of variables/arrays belonging
113			C to the core dynamical model
114			CALL INI_MODEL_IO( myThid )
115
116	edhill	1.14	#ifdef ALLOW_MONITOR
117	cnh	1.6	C-- Initialise MONITOR I/O streams so we can report config. info
118			CALL MON_INIT( myThid )
119			#endif
120	adcroft	1.1
121			C-- Set model grid.
122			C Variables defining model grid spacing are defined.
123			CALL INI_GRID( myThid )
124	edhill	1.29
125	mlosch	1.10	C-- Set equation of state parameters.
126			CALL INI_EOS( myThid )
127	adcroft	1.1
128	jmc	1.44	C-- Set pressure/geopotential reference profile
129			CALL INI_PHIREF( myThid )
130
131	adcroft	1.1	C-- Initialise map of depths
132			CALL INI_DEPTHS( myThid )
133
134			C-- Derive masks, lopping factors and recipricols of quantities.
135			C Volumes and areas are set according to grid and depth map.
136			CALL INI_MASKS_ETC( myThid )
137	jmc	1.47
138			C-- Synchronize all threads after setting masks and before pkgs init.
139	adcroft	1.1	_BARRIER
140	jmc	1.7
141	jmc	1.15	C-- Call fixed data initialization phase of packages
142			CALL PACKAGES_INIT_FIXED( myThid )
143
144	adcroft	1.4	C-- Check dependances between packages
145			CALL PACKAGES_CHECK( myThid )
146	adcroft	1.1
147	jmc	1.12	C-- Set Bo_surf => define the Linear Relation: Phi_surf(eta)
148			CALL INI_LINEAR_PHISURF( myThid )
149
150			C-- Set coriolis operators
151			CALL INI_CORI( myThid )
152
153	adcroft	1.1	C-- Set laplace operators for use in 2D conjugate gradient solver.
154			CALL INI_CG2D( myThid )
155
156			#ifdef ALLOW_NONHYDROSTATIC
157			C-- Set laplace operators for use in 3D conjugate gradient solver.
158	edhill	1.13	ceh3 needs an IF ( useNONHYDROSTATIC ) THEN
159	adcroft	1.1	CALL INI_CG3D( myThid )
160			#endif
161	jmc	1.9
162			C-- Check parameters and model cofiguration
163			CALL CONFIG_CHECK( myThid )
164	heimbach	1.3
165	adcroft	1.1	C-- Finally summarise the model cofiguration
166			CALL CONFIG_SUMMARY( myThid )
167	adcroft	1.30
168			C-- Write grid data and geometry arrays
169	jmc	1.43	IF ( debugLevel.GE.debLevA .OR.
170	jmc	1.41	& startTime.EQ.baseTime ) CALL WRITE_GRID( myThid )
171	jmc	1.16
172			#ifdef COMPONENT_MODULE
173			C-- Post component-model configuration information to coupler
174			C and get config. info for other component(s).
175			IF ( useCoupler ) CALL CPL_EXCH_CONFIGS( myThid )
176	edhill	1.17	#endif
177
178	jmc	1.46	C-- Check barrier synchronization:
179			CALL BAR_CHECK( 3, myThid )
180
181	edhill	1.23	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
182	adcroft	1.1
183	jmc	1.12	RETURN
184	adcroft	1.1	END