model/src/initialise_fixed.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/initialise_fixed.F,v 1.8 2001/09/26 18:09:15 cnh Exp $
C $Name:  $

#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_DEPTHS
C      |
C      |-- INI_MASKS_ETC
C      |
C      |-- INI_LINEAR_PHSURF
C      |
C      |-- INI_CORI
C      |
C      |-- PACKAGES_BOOT
C      |
C      |-- PACKAGES_READPARMS
C      |
C      |-- PACKAGES_CHECK
C      |
C      |-- PACKAGES_INIT_FIXED
C      |
C      |-- ZONAL_FILT_INIT
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

#ifndef EXCLUDE_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--   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--   Set Bo_surf => define the Linear Relation: Phi_surf(eta)
      CALL INI_LINEAR_PHISURF( myThid )

C--   Set coriolis operators
      CALL INI_CORI( myThid )

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 )

#ifdef ALLOW_ZONAL_FILT
C--   Latitude circle filter initialisation
      CALL ZONAL_FILT_INIT(myThid)
      _BARRIER
#endif

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

      END
1	jmc	1.9	C $Header: /u/gcmpack/models/MITgcmUV/model/src/initialise_fixed.F,v 1.8 2001/09/26 18:09:15 cnh Exp $
2	cnh	1.6	C $Name: $
3	adcroft	1.1
4			#include "CPP_OPTIONS.h"
5
6	cnh	1.8	CBOP
7			C !ROUTINE: INITIALISE_FIXED
8			C !INTERFACE:
9	adcroft	1.1	SUBROUTINE INITIALISE_FIXED(myThid)
10	cnh	1.8
11			C !DESCRIPTION: \bv
12			C ==========================================================
13			C \| SUBROUTINE INITIALISE_FIXED
14			C \| o Routine for setting fixed model arrays such as
15			C \| topography, grid, solver matrices, etc.
16			C ==========================================================
17			C \| INITIALISE_FIXED is invoked at the start of the model to
18			C \| set fixed model arrays. It reads data from an input file
19			C \| and from various binary files.
20			C \| Each thread invokes an instance of this routine as does
21			C \| each process in a multi-process parallel environment like
22			C \| MPI.
23			C ==========================================================
24			C \ev
25
26			C !CALLING SEQUENCE:
27			C INITIALISE_FIXED
28			C \|
29			C \|-- INI_PARMS
30			C \|
31			C \|-- MON_INIT
32			C \|
33			C \|-- INI_GRID
34			C \|
35			C \|-- INI_DEPTHS
36			C \|
37			C \|-- INI_MASKS_ETC
38			C \|
39			C \|-- INI_LINEAR_PHSURF
40			C \|
41			C \|-- INI_CORI
42			C \|
43			C \|-- PACKAGES_BOOT
44			C \|
45			C \|-- PACKAGES_READPARMS
46			C \|
47			C \|-- PACKAGES_CHECK
48			C \|
49			C \|-- PACKAGES_INIT_FIXED
50			C \|
51			C \|-- ZONAL_FILT_INIT
52			C \|
53			C \|-- INI_CG2D
54			C \|
55			C \|-- INI_CG3D
56			C \|
57	jmc	1.9	C \|-- CONFIG_CHECK
58			C \|
59	cnh	1.8	C \|-- CONFIG_SUMMARY
60
61			C !USES:
62	adcroft	1.1	IMPLICIT NONE
63			C == Global variables ==
64			#include "SIZE.h"
65			#include "EEPARAMS.h"
66			#include "PARAMS.h"
67
68	cnh	1.8	C !INPUT/OUTPUT PARAMETERS:
69	adcroft	1.1	C == Routine arguments ==
70			INTEGER myThid
71	cnh	1.8	CEOP
72	adcroft	1.1
73			C-- Set model parameters.
74			C Parameters are set to defaults and then updates are read from
75			C an input file called data.
76	adcroft	1.2	CALL INI_PARMS( myThid )
77	adcroft	1.1	_BARRIER
78	cnh	1.6
79			#ifndef EXCLUDE_MONITOR
80			C-- Initialise MONITOR I/O streams so we can report config. info
81			CALL MON_INIT( myThid )
82			_BARRIER
83			#endif
84
85	adcroft	1.1
86			C-- Set model grid.
87			C Variables defining model grid spacing are defined.
88			CALL INI_GRID( myThid )
89			_BARRIER
90
91			C-- Initialise map of depths
92			CALL INI_DEPTHS( myThid )
93			_BARRIER
94
95			C-- Derive masks, lopping factors and recipricols of quantities.
96			C Volumes and areas are set according to grid and depth map.
97			CALL INI_MASKS_ETC( myThid )
98			_BARRIER
99	jmc	1.7
100			C-- Set Bo_surf => define the Linear Relation: Phi_surf(eta)
101			CALL INI_LINEAR_PHISURF( myThid )
102	adcroft	1.1
103	heimbach	1.3	C-- Set coriolis operators
104			CALL INI_CORI( myThid )
105
106	adcroft	1.4	C-- Configure packages
107			CALL PACKAGES_BOOT( myThid )
108
109			C-- Read configuration parameters for packages
110			CALL PACKAGES_READPARMS( myThid )
111
112			C-- Check dependances between packages
113			CALL PACKAGES_CHECK( myThid )
114
115			C-- Call fixed data initialization phase of packages
116			CALL PACKAGES_INIT_FIXED( myThid )
117
118			#ifdef ALLOW_ZONAL_FILT
119	adcroft	1.1	C-- Latitude circle filter initialisation
120	adcroft	1.4	CALL ZONAL_FILT_INIT(myThid)
121	adcroft	1.1	_BARRIER
122			#endif
123
124			C-- Set laplace operators for use in 2D conjugate gradient solver.
125			CALL INI_CG2D( myThid )
126
127			#ifdef ALLOW_NONHYDROSTATIC
128			C-- Set laplace operators for use in 3D conjugate gradient solver.
129			CALL INI_CG3D( myThid )
130			#endif
131	jmc	1.9
132			C-- Check parameters and model cofiguration
133			CALL CONFIG_CHECK( myThid )
134	heimbach	1.3
135	adcroft	1.1	C-- Finally summarise the model cofiguration
136			CALL CONFIG_SUMMARY( myThid )
137
138			END