/[MITgcm]/MITgcm/model/src/ini_grid.F
ViewVC logotype

Diff of /MITgcm/model/src/ini_grid.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.6 by adcroft, Wed Dec 9 16:11:52 1998 UTC revision 1.31 by jmc, Tue Nov 28 22:47:13 2006 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7  CStartOfInterface  CBOP
8    C     !ROUTINE: INI_GRID
9    
10    C     !INTERFACE:
11        SUBROUTINE INI_GRID( myThid )        SUBROUTINE INI_GRID( myThid )
12  C     /==========================================================\  C     !DESCRIPTION:
13  C     | SUBROUTINE INI_GRID                                      |  C     These arrays are used throughout the code in evaluating gradients,
14  C     | o Initialise model grid                                  |  C     integrals and spatial avarages. This routine is called separately
15  C     |==========================================================|  C     by each thread and initializes only the region of the domain it is
16  C     | These arrays are used throughout the code in evaluating  |  C     "responsible" for.
 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  
17    
18  C     === Global variables ===  C     !USES:
19          IMPLICIT NONE
20  #include "SIZE.h"  #include "SIZE.h"
21  #include "EEPARAMS.h"  #include "EEPARAMS.h"
22  #include "PARAMS.h"  #include "PARAMS.h"
23  #include "GRID.h"  #include "GRID.h"
24    #ifdef ALLOW_MNC
25    #include "MNC_PARAMS.h"
26    #endif
27    #ifdef ALLOW_MONITOR
28    #include "MONITOR.h"
29    #endif
30    
31  C     == Routine arguments ==  C     !INPUT/OUTPUT PARAMETERS:
32  C     myThid -  Number of this instance of INI_GRID  C     myThid  :: my Thread Id number
33        INTEGER myThid        INTEGER myThid
34  CEndOfInterface  CEOP
35    
36  C     == Local variables ==  C     === Functions ====
37  C     msgBuf - Used for informational I/O.        LOGICAL  MASTER_CPU_IO
38          EXTERNAL MASTER_CPU_IO
39    
40    C     !LOCAL VARIABLES:
41    C     msgBuf  :: Informational/error message buffer
42        CHARACTER*(MAX_LEN_MBUF) msgBuf        CHARACTER*(MAX_LEN_MBUF) msgBuf
43    #ifdef ALLOW_MNC
44          INTEGER i
45    #endif
46    
47    C     load grid spacing (vector) from files
48          CALL LOAD_GRID_SPACING( myThid )
49    
50    C     Set up reference vertical profile (vector) for state variables
51    C jmc: this call will not stay here but will move to S/R INITIALISE_FIXED
52    C      (a better place) once anelatic initialisation is cleaned-up.
53          CALL INI_REFERENCE_STATE( myThid )
54    
55  C--   Set up vertical grid and coordinate system  C     Set up vertical grid and coordinate system
56        CALL INI_VERTICAL_GRID( myThid )        CALL INI_VERTICAL_GRID( myThid )
57    
58  C--   Set up horizontal grid and coordinate system  C     Two examples are shown in this code. One illustrates the
59    C     initialization of a cartesian grid. The other shows the
60    C     inialization of a spherical polar grid. Other orthonormal grids
61    C     can be fitted into this design. In this case custom metric terms
62    C     also need adding to account for the projections of velocity
63    C     vectors onto these grids.  The structure used here also makes it
64    C     possible to implement less regular grid mappings. In particular:
65    C      o Schemes which leave out blocks of the domain that are
66    C        all land could be supported.
67    C      o Multi-level schemes such as icosohedral or cubic
68    C        grid projectedions onto a sphere can also be fitted
69    C       within the strategy we use.
70    C        Both of the above also require modifying the support
71    C        routines that map computational blocks to simulation
72    C        domain blocks.
73    
74    C     Set up horizontal grid and coordinate system
75        IF ( usingCartesianGrid ) THEN        IF ( usingCartesianGrid ) THEN
76         CALL INI_CARTESIAN_GRID( myThid )          CALL INI_CARTESIAN_GRID( myThid )
77        ELSEIF ( usingSphericalPolarGrid ) THEN        ELSEIF ( usingSphericalPolarGrid ) THEN
78         CALL INI_SPHERICAL_POLAR_GRID( myThid )          CALL INI_SPHERICAL_POLAR_GRID( myThid )
79          ELSEIF ( usingCurvilinearGrid ) THEN
80            CALL INI_CURVILINEAR_GRID( myThid )
81          ELSEIF ( usingCylindricalGrid ) THEN
82            CALL INI_CYLINDER_GRID( myThid )
83        ELSE        ELSE
84         _BEGIN_MASTER(myThid)          _BEGIN_MASTER(myThid)
85          WRITE(msgBuf,'(A)')          WRITE(msgBuf,'(2A)') 'S/R INI_GRID: ',
86       &   'S/R INI_GRID: No grid coordinate system has been selected'       &       'No grid coordinate system has been selected'
87           CALL PRINT_ERROR( msgBuf , myThid)          CALL PRINT_ERROR( msgBuf , myThid)
88           STOP 'ABNORMAL END: S/R INI_GRID'          STOP 'ABNORMAL END: S/R INI_GRID'
89         _END_MASTER(myThid)          _END_MASTER(myThid)
90          ENDIF
91    
92    #ifdef ALLOW_MONITOR
93          IF ( MASTER_CPU_IO(myThid) ) THEN
94    C--   only the master thread is allowed to switch On/Off mon_write_stdout
95    C     & mon_write_mnc (since it's the only thread that uses those flags):
96    
97            IF (monitor_stdio) THEN
98              mon_write_stdout = .TRUE.
99            ELSE
100              mon_write_stdout = .FALSE.
101            ENDIF
102            mon_write_mnc = .FALSE.
103    #ifdef ALLOW_MNC
104            IF (useMNC .AND. monitor_mnc) THEN
105              DO i = 1,MAX_LEN_MBUF
106                mon_fname(i:i) = ' '
107              ENDDO
108              mon_fname(1:12) = 'monitor_grid'
109              CALL MNC_CW_SET_UDIM(mon_fname, 1, myThid)
110              mon_write_mnc = .TRUE.
111            ENDIF
112    #endif /*  ALLOW_MNC  */
113    
114          ENDIF
115    
116    C     Print out statistics of each horizontal grid array (helps when
117    C     debugging)
118          CALL MON_PRINTSTATS_RS(1,xC,'XC',myThid)
119          CALL MON_PRINTSTATS_RS(1,xG,'XG',myThid)
120          CALL MON_PRINTSTATS_RS(1,dxC,'DXC',myThid)
121          CALL MON_PRINTSTATS_RS(1,dxF,'DXF',myThid)
122          CALL MON_PRINTSTATS_RS(1,dxG,'DXG',myThid)
123          CALL MON_PRINTSTATS_RS(1,dxV,'DXV',myThid)
124          CALL MON_PRINTSTATS_RS(1,yC,'YC',myThid)
125          CALL MON_PRINTSTATS_RS(1,yG,'YG',myThid)
126          CALL MON_PRINTSTATS_RS(1,dyC,'DYC',myThid)
127          CALL MON_PRINTSTATS_RS(1,dyF,'DYF',myThid)
128          CALL MON_PRINTSTATS_RS(1,dyG,'DYG',myThid)
129          CALL MON_PRINTSTATS_RS(1,dyU,'DYU',myThid)
130          CALL MON_PRINTSTATS_RS(1,rA,'RA',myThid)
131          CALL MON_PRINTSTATS_RS(1,rAw,'RAW',myThid)
132          CALL MON_PRINTSTATS_RS(1,rAs,'RAS',myThid)
133          CALL MON_PRINTSTATS_RS(1,rAz,'RAZ',myThid)
134          CALL MON_PRINTSTATS_RS(1,angleCosC,'AngleCS',myThid)
135          CALL MON_PRINTSTATS_RS(1,angleSinC,'AngleSN',myThid)
136    
137          IF ( MASTER_CPU_IO(myThid) ) THEN
138            mon_write_stdout = .FALSE.
139            mon_write_mnc    = .FALSE.
140        ENDIF        ENDIF
141  C  #endif /* ALLOW_MONITOR */
142    
143    C--   Everyone else must wait for the grid to be set
144          _BARRIER
145    
146        RETURN        RETURN
147        END        END
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.31
  ViewVC Help
Powered by ViewVC 1.1.22