model/src/initialise_fixed.F

C $Header: /u/u3/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.13 2003/10/09 04:19:18 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_CHECK
C      |
C      |-- PACKAGES_INIT_FIXED
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_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--   Check dependances between packages
      CALL PACKAGES_CHECK( myThid )

C--   Call fixed data initialization phase of packages
      CALL PACKAGES_INIT_FIXED( 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 )

      RETURN
      END
1	C $Header: /u/u3/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.13 2003/10/09 04:19:18 edhill Exp $
2	C $Name: $
3
4	#include "PACKAGES_CONFIG.h"
5	#include "CPP_OPTIONS.h"
6
7	CBOP
8	C !ROUTINE: INITIALISE_FIXED
9	C !INTERFACE:
10	SUBROUTINE INITIALISE_FIXED(myThid)
11
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	C \|-- INI_EOS
37	C \|
38	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	C \|-- PACKAGES_CHECK
47	C \|
48	C \|-- PACKAGES_INIT_FIXED
49	C \|
50	C \|-- INI_LINEAR_PHSURF
51	C \|
52	C \|-- INI_CORI
53	C \|
54	C \|-- INI_CG2D
55	C \|
56	C \|-- INI_CG3D
57	C \|
58	C \|-- CONFIG_CHECK
59	C \|
60	C \|-- CONFIG_SUMMARY
61
62	C !USES:
63	IMPLICIT NONE
64	C == Global variables ==
65	#include "SIZE.h"
66	#include "EEPARAMS.h"
67	#include "PARAMS.h"
68
69	C !INPUT/OUTPUT PARAMETERS:
70	C == Routine arguments ==
71	INTEGER myThid
72	CEOP
73
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	CALL INI_PARMS( myThid )
78	_BARRIER
79
80	#ifdef ALLOW_MONITOR
81	C-- Initialise MONITOR I/O streams so we can report config. info
82	CALL MON_INIT( myThid )
83	_BARRIER
84	#endif
85
86
87	C-- Set model grid.
88	C Variables defining model grid spacing are defined.
89	CALL INI_GRID( myThid )
90	_BARRIER
91
92	C-- Set equation of state parameters.
93	CALL INI_EOS( myThid )
94	_BARRIER
95
96	C-- Initialise map of depths
97	CALL INI_DEPTHS( myThid )
98	_BARRIER
99
100	C-- Derive masks, lopping factors and recipricols of quantities.
101	C Volumes and areas are set according to grid and depth map.
102	CALL INI_MASKS_ETC( myThid )
103	_BARRIER
104
105	C-- Configure packages
106	CALL PACKAGES_BOOT( myThid )
107
108	C-- Read configuration parameters for packages
109	CALL PACKAGES_READPARMS( myThid )
110
111	C-- Check dependances between packages
112	CALL PACKAGES_CHECK( myThid )
113
114	C-- Call fixed data initialization phase of packages
115	CALL PACKAGES_INIT_FIXED( myThid )
116
117	C-- Set Bo_surf => define the Linear Relation: Phi_surf(eta)
118	CALL INI_LINEAR_PHISURF( myThid )
119
120	C-- Set coriolis operators
121	CALL INI_CORI( myThid )
122
123	C-- Set laplace operators for use in 2D conjugate gradient solver.
124	CALL INI_CG2D( myThid )
125
126	#ifdef ALLOW_NONHYDROSTATIC
127	C-- Set laplace operators for use in 3D conjugate gradient solver.
128	ceh3 needs an IF ( useNONHYDROSTATIC ) THEN
129	CALL INI_CG3D( myThid )
130	#endif
131
132	C-- Check parameters and model cofiguration
133	CALL CONFIG_CHECK( myThid )
134
135	C-- Finally summarise the model cofiguration
136	CALL CONFIG_SUMMARY( myThid )
137
138	RETURN
139	END