model/src/initialise_fixed.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/initialise_fixed.F,v 1.7 2001/07/06 21:39:37 jmc 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_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--   Finally summarise the model cofiguration
      CALL CONFIG_SUMMARY( myThid )

      END
1	C $Header: /u/gcmpack/models/MITgcmUV/model/src/initialise_fixed.F,v 1.7 2001/07/06 21:39:37 jmc Exp $
2	C $Name: $
3
4	#include "CPP_OPTIONS.h"
5
6	CBOP
7	C !ROUTINE: INITIALISE_FIXED
8	C !INTERFACE:
9	SUBROUTINE INITIALISE_FIXED(myThid)
10
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	C \|-- CONFIG_SUMMARY
58
59	C !USES:
60	IMPLICIT NONE
61	C == Global variables ==
62	#include "SIZE.h"
63	#include "EEPARAMS.h"
64	#include "PARAMS.h"
65
66	C !INPUT/OUTPUT PARAMETERS:
67	C == Routine arguments ==
68	INTEGER myThid
69	CEOP
70
71	C-- Set model parameters.
72	C Parameters are set to defaults and then updates are read from
73	C an input file called data.
74	CALL INI_PARMS( myThid )
75	_BARRIER
76
77	#ifndef EXCLUDE_MONITOR
78	C-- Initialise MONITOR I/O streams so we can report config. info
79	CALL MON_INIT( myThid )
80	_BARRIER
81	#endif
82
83
84	C-- Set model grid.
85	C Variables defining model grid spacing are defined.
86	CALL INI_GRID( myThid )
87	_BARRIER
88
89	C-- Initialise map of depths
90	CALL INI_DEPTHS( myThid )
91	_BARRIER
92
93	C-- Derive masks, lopping factors and recipricols of quantities.
94	C Volumes and areas are set according to grid and depth map.
95	CALL INI_MASKS_ETC( myThid )
96	_BARRIER
97
98	C-- Set Bo_surf => define the Linear Relation: Phi_surf(eta)
99	CALL INI_LINEAR_PHISURF( myThid )
100
101	C-- Set coriolis operators
102	CALL INI_CORI( myThid )
103
104	C-- Configure packages
105	CALL PACKAGES_BOOT( myThid )
106
107	C-- Read configuration parameters for packages
108	CALL PACKAGES_READPARMS( myThid )
109
110	C-- Check dependances between packages
111	CALL PACKAGES_CHECK( myThid )
112
113	C-- Call fixed data initialization phase of packages
114	CALL PACKAGES_INIT_FIXED( myThid )
115
116	#ifdef ALLOW_ZONAL_FILT
117	C-- Latitude circle filter initialisation
118	CALL ZONAL_FILT_INIT(myThid)
119	_BARRIER
120	#endif
121
122	C-- Set laplace operators for use in 2D conjugate gradient solver.
123	CALL INI_CG2D( myThid )
124
125	#ifdef ALLOW_NONHYDROSTATIC
126	C-- Set laplace operators for use in 3D conjugate gradient solver.
127	CALL INI_CG3D( myThid )
128	#endif
129
130	C-- Finally summarise the model cofiguration
131	CALL CONFIG_SUMMARY( myThid )
132
133	END