model/src/initialise_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.28 2004/03/23 05:24:43 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      |-- 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     !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--   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

#ifdef ALLOW_MNC
C     Initialize the MNC state files and write the grid info
      IF (useMNC) THEN
        CALL INI_MNC_IO(myThid)
      ENDIF
#endif

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 )

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