model/src/initialise_fixed.F

C $Header: /u/u3/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.18 2004/01/15 04:31:24 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      |
C      |-- MNC_INIT
C      |-- MNC_W_GRIDINFO

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

#ifdef ALLOW_MNC
C     Test MNC
      CALL MNC_INIT(myThid)
      CALL MNC_W_GRIDINFO(myThid, 'test')
#endif

      RETURN
      END
1	C $Header: /u/u3/gcmpack/MITgcm/model/src/initialise_fixed.F,v 1.18 2004/01/15 04:31:24 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_INIT_FIXED
47	C \|
48	C \|-- PACKAGES_CHECK
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	C \|
62	C \|-- MNC_INIT
63	C \|-- MNC_W_GRIDINFO
64
65	C !USES:
66	IMPLICIT NONE
67	C == Global variables ==
68	#include "SIZE.h"
69	#include "EEPARAMS.h"
70	#include "PARAMS.h"
71
72	C !INPUT/OUTPUT PARAMETERS:
73	C == Routine arguments ==
74	INTEGER myThid
75	CEOP
76
77	C-- Set model parameters.
78	C Parameters are set to defaults and then updates are read from
79	C an input file called data.
80	CALL INI_PARMS( myThid )
81	_BARRIER
82
83	#ifdef ALLOW_MONITOR
84	C-- Initialise MONITOR I/O streams so we can report config. info
85	CALL MON_INIT( myThid )
86	_BARRIER
87	#endif
88
89
90	C-- Set model grid.
91	C Variables defining model grid spacing are defined.
92	CALL INI_GRID( myThid )
93	_BARRIER
94
95	C-- Set equation of state parameters.
96	CALL INI_EOS( myThid )
97	_BARRIER
98
99	C-- Initialise map of depths
100	CALL INI_DEPTHS( myThid )
101	_BARRIER
102
103	C-- Derive masks, lopping factors and recipricols of quantities.
104	C Volumes and areas are set according to grid and depth map.
105	CALL INI_MASKS_ETC( myThid )
106	_BARRIER
107
108	C-- Configure packages
109	CALL PACKAGES_BOOT( myThid )
110
111	C-- Read configuration parameters for packages
112	CALL PACKAGES_READPARMS( myThid )
113
114	C-- Call fixed data initialization phase of packages
115	CALL PACKAGES_INIT_FIXED( myThid )
116
117	C-- Check dependances between packages
118	CALL PACKAGES_CHECK( myThid )
119
120	C-- Set Bo_surf => define the Linear Relation: Phi_surf(eta)
121	CALL INI_LINEAR_PHISURF( myThid )
122
123	C-- Set coriolis operators
124	CALL INI_CORI( myThid )
125
126	C-- Set laplace operators for use in 2D conjugate gradient solver.
127	CALL INI_CG2D( myThid )
128
129	#ifdef ALLOW_NONHYDROSTATIC
130	C-- Set laplace operators for use in 3D conjugate gradient solver.
131	ceh3 needs an IF ( useNONHYDROSTATIC ) THEN
132	CALL INI_CG3D( myThid )
133	#endif
134
135	C-- Check parameters and model cofiguration
136	CALL CONFIG_CHECK( myThid )
137
138	C-- Finally summarise the model cofiguration
139	CALL CONFIG_SUMMARY( myThid )
140
141	#ifdef COMPONENT_MODULE
142	C-- Post component-model configuration information to coupler
143	C and get config. info for other component(s).
144	IF ( useCoupler ) CALL CPL_EXCH_CONFIGS( myThid )
145	#endif
146
147	#ifdef ALLOW_MNC
148	C Test MNC
149	CALL MNC_INIT(myThid)
150	CALL MNC_W_GRIDINFO(myThid, 'test')
151	#endif
152
153	RETURN
154	END