model/src/ini_grid.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/ini_grid.F,v 1.6 1998/12/09 16:11:52 adcroft Exp $
C $Name: $

#include "CPP_OPTIONS.h"

CStartOfInterface
      SUBROUTINE INI_GRID( myThid )
C     /==========================================================\
C     | SUBROUTINE INI_GRID                                      |
C     | o Initialise model grid                                  |
C     |==========================================================|
C     | These arrays are used throughout the code in evaluating  |
C     | gradients, integrals and spatial avarages. This routine  |
C     | is called separately by each thread and initialise only  |
C     | the region of the domain it is "responsible" for.        |
C     | Notes:                                                   |
C     | Two examples are shown in this code. One illustrates the |
C     | initialisation of a cartesian grid. The other shows the  |
C     | inialisation of a spherical polar grid. Other orthonormal|
C     | grids can be fitted into this design. In this case       |
C     | custom metric terms also need adding to account for the  |
C     | projections of velocity vectors onto these grids.        |
C     | The structure used here also makes it possible to        |
C     | implement less regular grid mappings. In particular      |
C     | o Schemes which leave out blocks of the domain that are  |
C     |   all land could be supported.                           |
C     | o Multi-level schemes such as icosohedral or cubic       |
C     |   grid projectedions onto a sphere can also be fitted    |
C     |   within the strategy we use.                            |
C     |   Both of the above also require modifying the support   |
C     |   routines that map computational blocks to simulation   |
C     |   domain blocks.                                         |
C     \==========================================================/
      IMPLICIT NONE

C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"

C     == Routine arguments ==
C     myThid -  Number of this instance of INI_GRID
      INTEGER myThid
CEndOfInterface

C     == Local variables ==
C     msgBuf - Used for informational I/O.
      CHARACTER*(MAX_LEN_MBUF) msgBuf

C--   Set up vertical grid and coordinate system
      CALL INI_VERTICAL_GRID( myThid )

C--   Set up horizontal grid and coordinate system
      IF ( usingCartesianGrid ) THEN
       CALL INI_CARTESIAN_GRID( myThid )
      ELSEIF ( usingSphericalPolarGrid ) THEN
       CALL INI_SPHERICAL_POLAR_GRID( myThid )
      ELSE
       _BEGIN_MASTER(myThid)
        WRITE(msgBuf,'(A)') 
     &   'S/R INI_GRID: No grid coordinate system has been selected'
         CALL PRINT_ERROR( msgBuf , myThid)
         STOP 'ABNORMAL END: S/R INI_GRID'
       _END_MASTER(myThid)
      ENDIF
C
      RETURN
      END
1	C $Header: /u/gcmpack/models/MITgcmUV/model/src/ini_grid.F,v 1.6 1998/12/09 16:11:52 adcroft Exp $
2	C $Name: $
3
4	#include "CPP_OPTIONS.h"
5
6	CStartOfInterface
7	SUBROUTINE INI_GRID( myThid )
8	C /==========================================================\
9	C \| SUBROUTINE INI_GRID \|
10	C \| o Initialise model grid \|
11	C \|==========================================================\|
12	C \| These arrays are used throughout the code in evaluating \|
13	C \| gradients, integrals and spatial avarages. This routine \|
14	C \| is called separately by each thread and initialise only \|
15	C \| the region of the domain it is "responsible" for. \|
16	C \| Notes: \|
17	C \| Two examples are shown in this code. One illustrates the \|
18	C \| initialisation of a cartesian grid. The other shows the \|
19	C \| inialisation of a spherical polar grid. Other orthonormal\|
20	C \| grids can be fitted into this design. In this case \|
21	C \| custom metric terms also need adding to account for the \|
22	C \| projections of velocity vectors onto these grids. \|
23	C \| The structure used here also makes it possible to \|
24	C \| implement less regular grid mappings. In particular \|
25	C \| o Schemes which leave out blocks of the domain that are \|
26	C \| all land could be supported. \|
27	C \| o Multi-level schemes such as icosohedral or cubic \|
28	C \| grid projectedions onto a sphere can also be fitted \|
29	C \| within the strategy we use. \|
30	C \| Both of the above also require modifying the support \|
31	C \| routines that map computational blocks to simulation \|
32	C \| domain blocks. \|
33	C \==========================================================/
34	IMPLICIT NONE
35
36	C === Global variables ===
37	#include "SIZE.h"
38	#include "EEPARAMS.h"
39	#include "PARAMS.h"
40	#include "GRID.h"
41
42	C == Routine arguments ==
43	C myThid - Number of this instance of INI_GRID
44	INTEGER myThid
45	CEndOfInterface
46
47	C == Local variables ==
48	C msgBuf - Used for informational I/O.
49	CHARACTER*(MAX_LEN_MBUF) msgBuf
50
51	C-- Set up vertical grid and coordinate system
52	CALL INI_VERTICAL_GRID( myThid )
53
54	C-- Set up horizontal grid and coordinate system
55	IF ( usingCartesianGrid ) THEN
56	CALL INI_CARTESIAN_GRID( myThid )
57	ELSEIF ( usingSphericalPolarGrid ) THEN
58	CALL INI_SPHERICAL_POLAR_GRID( myThid )
59	ELSE
60	_BEGIN_MASTER(myThid)
61	WRITE(msgBuf,'(A)')
62	& 'S/R INI_GRID: No grid coordinate system has been selected'
63	CALL PRINT_ERROR( msgBuf , myThid)
64	STOP 'ABNORMAL END: S/R INI_GRID'
65	_END_MASTER(myThid)
66	ENDIF
67	C
68	RETURN
69	END