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