model/src/initialise_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.35 2004/10/10 06:08:47 edhill 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      |-- MNC_INIT + MNC_CW_INIT
C      |
C      |-- MON_INIT
C      |
C      |-- INI_GRID
C      |
C      |-- INI_EOS
C      |
C      |-- INI_DEPTHS
C      |
C      |-- INI_MASKS_ETC
C      |
C      |-- PACKAGES_BOOT
C      |
C      |-- PACKAGES_READPARMS
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      |-- INI_MODEL_IO
C      |
C      |-- WRITE_GRID

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

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

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 )
      _BARRIER

#ifdef ALLOW_MNC
C     Initialize MNC look-up tables
      IF (useMNC) THEN
        CALL MNC_INIT(myThid)
        CALL MNC_CW_INIT(sNx,sNy,OLx,OLy,nSx,nSy,nPx,nPy,
     &       Nr,myThid)
        IF ( mnc_echo_gvtypes ) THEN
          CALL MNC_CW_DUMP( myThid )
        ENDIF
      ENDIF
#endif

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

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

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

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

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 )
      _BARRIER

C--   Configure packages
      CALL PACKAGES_BOOT( myThid )

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

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 units/set precision/etc for I/O of variables/arrays belonging
C     to the core dynamical model
      CALL INI_MODEL_IO( myThid )

C--   Write grid data and geometry arrays
      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---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

      RETURN
      END
1	edhill	1.36	C $Header: /u/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.35 2004/10/10 06:08:47 edhill 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			C \|-- INI_PARMS
31			C \|
32	edhill	1.32	C \|-- MNC_INIT + MNC_CW_INIT
33			C \|
34	cnh	1.8	C \|-- MON_INIT
35			C \|
36			C \|-- INI_GRID
37			C \|
38	mlosch	1.10	C \|-- INI_EOS
39			C \|
40	cnh	1.8	C \|-- INI_DEPTHS
41			C \|
42			C \|-- INI_MASKS_ETC
43			C \|
44			C \|-- PACKAGES_BOOT
45			C \|
46			C \|-- PACKAGES_READPARMS
47			C \|
48	jmc	1.15	C \|-- PACKAGES_INIT_FIXED
49			C \|
50	cnh	1.8	C \|-- PACKAGES_CHECK
51			C \|
52	jmc	1.12	C \|-- INI_LINEAR_PHSURF
53			C \|
54			C \|-- INI_CORI
55	cnh	1.8	C \|
56			C \|-- INI_CG2D
57			C \|
58			C \|-- INI_CG3D
59			C \|
60	jmc	1.9	C \|-- CONFIG_CHECK
61			C \|
62	cnh	1.8	C \|-- CONFIG_SUMMARY
63	adcroft	1.33	C \|
64			C \|-- INI_MODEL_IO
65			C \|
66			C \|-- WRITE_GRID
67	cnh	1.8
68			C !USES:
69	adcroft	1.1	IMPLICIT NONE
70			C == Global variables ==
71			#include "SIZE.h"
72			#include "EEPARAMS.h"
73			#include "PARAMS.h"
74	edhill	1.36	#ifdef ALLOW_MNC
75			#include "MNC_PARAMS.h"
76			#endif
77	adcroft	1.1
78	cnh	1.8	C !INPUT/OUTPUT PARAMETERS:
79	adcroft	1.1	C == Routine arguments ==
80			INTEGER myThid
81	cnh	1.8	CEOP
82	adcroft	1.1
83			C-- Set model parameters.
84			C Parameters are set to defaults and then updates are read from
85			C an input file called data.
86	adcroft	1.2	CALL INI_PARMS( myThid )
87	adcroft	1.1	_BARRIER
88	cnh	1.6
89	edhill	1.26	#ifdef ALLOW_MNC
90			C Initialize MNC look-up tables
91			IF (useMNC) THEN
92			CALL MNC_INIT(myThid)
93	edhill	1.31	CALL MNC_CW_INIT(sNx,sNy,OLx,OLy,nSx,nSy,nPx,nPy,
94	edhill	1.32	& Nr,myThid)
95	edhill	1.28	IF ( mnc_echo_gvtypes ) THEN
96	edhill	1.26	CALL MNC_CW_DUMP( myThid )
97			ENDIF
98			ENDIF
99			#endif
100
101	edhill	1.14	#ifdef ALLOW_MONITOR
102	cnh	1.6	C-- Initialise MONITOR I/O streams so we can report config. info
103			CALL MON_INIT( myThid )
104			_BARRIER
105			#endif
106	adcroft	1.1
107			C-- Set model grid.
108			C Variables defining model grid spacing are defined.
109			CALL INI_GRID( myThid )
110	mlosch	1.10	_BARRIER
111	edhill	1.29
112	mlosch	1.10	C-- Set equation of state parameters.
113			CALL INI_EOS( myThid )
114	adcroft	1.1	_BARRIER
115
116			C-- Initialise map of depths
117			CALL INI_DEPTHS( myThid )
118			_BARRIER
119
120			C-- Derive masks, lopping factors and recipricols of quantities.
121			C Volumes and areas are set according to grid and depth map.
122			CALL INI_MASKS_ETC( myThid )
123			_BARRIER
124	jmc	1.7
125	adcroft	1.4	C-- Configure packages
126			CALL PACKAGES_BOOT( myThid )
127
128			C-- Read configuration parameters for packages
129			CALL PACKAGES_READPARMS( myThid )
130
131	jmc	1.15	C-- Call fixed data initialization phase of packages
132			CALL PACKAGES_INIT_FIXED( myThid )
133
134	adcroft	1.4	C-- Check dependances between packages
135			CALL PACKAGES_CHECK( myThid )
136	adcroft	1.1
137	jmc	1.12	C-- Set Bo_surf => define the Linear Relation: Phi_surf(eta)
138			CALL INI_LINEAR_PHISURF( myThid )
139
140			C-- Set coriolis operators
141			CALL INI_CORI( myThid )
142
143	adcroft	1.1	C-- Set laplace operators for use in 2D conjugate gradient solver.
144			CALL INI_CG2D( myThid )
145
146			#ifdef ALLOW_NONHYDROSTATIC
147			C-- Set laplace operators for use in 3D conjugate gradient solver.
148	edhill	1.13	ceh3 needs an IF ( useNONHYDROSTATIC ) THEN
149	adcroft	1.1	CALL INI_CG3D( myThid )
150			#endif
151	jmc	1.9
152			C-- Check parameters and model cofiguration
153			CALL CONFIG_CHECK( myThid )
154	heimbach	1.3
155	adcroft	1.1	C-- Finally summarise the model cofiguration
156			CALL CONFIG_SUMMARY( myThid )
157	adcroft	1.30
158			C-- Write units/set precision/etc for I/O of variables/arrays belonging
159			C to the core dynamical model
160			CALL INI_MODEL_IO( myThid )
161
162			C-- Write grid data and geometry arrays
163			CALL WRITE_GRID( myThid )
164	jmc	1.16
165			#ifdef COMPONENT_MODULE
166			C-- Post component-model configuration information to coupler
167			C and get config. info for other component(s).
168			IF ( useCoupler ) CALL CPL_EXCH_CONFIGS( myThid )
169	edhill	1.17	#endif
170
171	edhill	1.23	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
172	adcroft	1.1
173	jmc	1.12	RETURN
174	adcroft	1.1	END