-
Notifications
You must be signed in to change notification settings - Fork 23
/
mod_dimensions.F90
302 lines (296 loc) · 10.5 KB
/
mod_dimensions.F90
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
module mod_dimensions
implicit none
public ! everything is public
#if defined(RELO)
!-----------------------------------------------------------------------------
! --- START OF USER SETABLE, BUT REGION INDEPEDENT, PARAMETERS
!
! --- iqr = maximum number of tiles in i direction
! --- jqr = maximum number of tiles in j direction
integer iqr,jqr
#if defined(MPI) || defined(SHMEM)
parameter (iqr=299,jqr=299) ! multiple tiles (TYPE=ompi or mpi or shmem)
#else
parameter (iqr=1, jqr=1) ! single tile (TYPE=one or omp)
#endif
!
! --- mxthrd= maximum number of OpenMP threads
integer mxthrd
#if defined(_OPENMP)
parameter (mxthrd=8) ! NOMP=0,1,2,4,8
#else
parameter (mxthrd=1) ! NOMP=0,1
#endif
!
! --- mxtrcr= maximum number of tracers
integer mxtrcr
parameter (mxtrcr=99) !not used to allocate large arrays
!
! --- END OF USER SETABLE, BUT REGION INDEPEDENT, PARAMETERS
!-----------------------------------------------------------------------------
!
! --- halo size
integer, parameter :: nbdy=6
!
! --- ms-1 = max. number of interruptions of any tile row or column by land
integer, parameter :: ms=99 ! should be enough for any region
!
! --- ijqr = maximum total number of active tiles (= ipr*jpr)
integer, parameter :: ijqr=iqr*jqr
!
! --- itdm = total grid dimension in i direction
! --- jtdm = total grid dimension in j direction
! --- kdm = grid dimension in k direction
! --- kk = grid dimension in k direction
integer, save :: itdm,jtdm,kdm,kk
!
! --- idm = maximum single tile grid dimension in i direction
! --- jdm = maximum single tile grid dimension in j direction
integer, save :: idm,jdm
!
! --- kkwall= grid dimension in k direction for wall relax arrays
! --- kknest= grid dimension in k direction for nest relax arrays
integer, save :: kkwall,kknest
!
! --- kkmy25= grid dimension in k direction for M-Y 2.5 arrays
integer, save :: kkmy25
!
! --- natm = number of saved atmospheric fields
integer, save :: natm
!
! --- OpenMP will allocate jblk rows to each thread in turn
integer, save :: jblk
!
! --- for CCSM array dimensions
integer, save :: imt1,imt2,jmt1,jmt2
!
! --- actual extent of this tile is (i0+1:i0+ii,j0+1:j0+jj,1:kk)
integer, save :: i0,j0,ii,jj
!
! --- information (gindex) that keeps do loops from running into land
integer, save, allocatable, dimension (:,:) :: &
ip,iu,iv,iq, iuopn,ivopn, ipa, ishlf, &
ipim1, ipip1, ipjm1, ipjp1, &
ipim1x,ipip1x,ipjm1x,ipjp1x
integer, save, allocatable, dimension (:,:) :: &
ifp,ilp,ifq,ilq,ifu,ilu,ifv,ilv
integer, save, allocatable, dimension (:,:) :: &
jfp,jlp,jfq,jlq,jfu,jlu,jfv,jlv
integer, save, allocatable, dimension (:) :: &
isp,isq,isu,isv
integer, save, allocatable, dimension (:) :: &
jsp,jsq,jsu,jsv
logical, save, allocatable, dimension (:) :: &
allip,alliq,alliu,alliv
#else
include 'dimensions.h'
!
! --- halo size
integer, parameter :: nbdy=6
!
! --- OpenMP will allocate jblk rows to each thread in turn
integer, parameter :: jblk=(jdm+2*nbdy+mxthrd-1)/mxthrd
!
! --- ms-1 = max. number of interruptions of any tile row or column by land
integer, parameter :: ms=99 ! should be enough for any region
!
! --- ijqr = maximum total number of active tiles (= ipr*jpr)
integer, parameter :: ijqr=iqr*jqr
!
! --- for CCSM array dimensions
integer, parameter :: imt1=1-nbdy,imt2=idm+nbdy, &
jmt1=1-nbdy,jmt2=jdm+nbdy
!
! --- actual extent of this tile is (i0+1:i0+ii,j0+1:j0+jj,1:kk)
integer, parameter :: kk=kdm
integer, save :: i0,j0,ii,jj
!
! --- information to keep do loops from running into land
integer, save, dimension (1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy) :: &
ip,iu,iv,iq, iuopn,ivopn, ipa, ishlf, &
ipim1, ipip1, ipjm1, ipjp1, &
ipim1x,ipip1x,ipjm1x,ipjp1x
integer, save, dimension (1-nbdy:jdm+nbdy,ms) :: &
ifp,ilp,ifq,ilq,ifu,ilu,ifv,ilv
integer, save, dimension (1-nbdy:idm+nbdy,ms) :: &
jfp,jlp,jfq,jlq,jfu,jlu,jfv,jlv
integer, save, dimension (1-nbdy:jdm+nbdy) :: &
isp,isq,isu,isv
integer, save, dimension (1-nbdy:idm+nbdy) :: &
jsp,jsq,jsu,jsv
logical, save, dimension (1-nbdy:jdm+nbdy) :: &
allip,alliq,alliu,alliv
#endif
!
! --- line printer unit (stdout)
integer, save :: lp
!
real, save :: r_init !value that allocated arrays should be set to
!initialize with set_r_init (to NaN or huge)
!
integer*8, save, private :: &
mem_alloc_now = 0 & !memory in words explicitly allocated by HYCOM
, mem_alloc_high = 0 !high water mark of memory allocated by HYCOM
contains
#if defined(RELO)
subroutine gindex_allocate
implicit none
!
! --- allocate information (gindex) that keeps do loops from running into land
!
jblk = (jdm+2*nbdy+mxthrd-1)/mxthrd
!
imt1 = 1-nbdy
imt2 = idm+nbdy
jmt1 = 1-nbdy
jmt2 = jdm+nbdy
!
allocate( &
ip(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
iu(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
iv(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
iq(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
iuopn(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ivopn(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ishlf(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipa(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipim1x(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipip1x(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipjm1x(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipjp1x(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipim1(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipip1(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipjm1(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy), &
ipjp1(1-nbdy:idm+nbdy,1-nbdy:jdm+nbdy) )
call mem_stat_add( 8*(idm+2*nbdy)*(jdm+2*nbdy) ) !real=2*int
!
allocate( &
ifp(1-nbdy:jdm+nbdy,ms), &
ilp(1-nbdy:jdm+nbdy,ms), &
ifq(1-nbdy:jdm+nbdy,ms), &
ilq(1-nbdy:jdm+nbdy,ms), &
ifu(1-nbdy:jdm+nbdy,ms), &
ilu(1-nbdy:jdm+nbdy,ms), &
ifv(1-nbdy:jdm+nbdy,ms), &
ilv(1-nbdy:jdm+nbdy,ms) )
call mem_stat_add( 4*(jdm+2*nbdy)*ms ) !real=2*int
!
allocate( &
jfp(1-nbdy:idm+nbdy,ms), &
jlp(1-nbdy:idm+nbdy,ms), &
jfq(1-nbdy:idm+nbdy,ms), &
jlq(1-nbdy:idm+nbdy,ms), &
jfu(1-nbdy:idm+nbdy,ms), &
jlu(1-nbdy:idm+nbdy,ms), &
jfv(1-nbdy:idm+nbdy,ms), &
jlv(1-nbdy:idm+nbdy,ms) )
call mem_stat_add( 4*(idm+2*nbdy)*ms ) !real=2*int
!
allocate( &
isp(1-nbdy:jdm+nbdy), &
isq(1-nbdy:jdm+nbdy), &
isu(1-nbdy:jdm+nbdy), &
isv(1-nbdy:jdm+nbdy) )
call mem_stat_add( 2*(jdm+2*nbdy) ) !real=2*int
!
allocate( &
jsp(1-nbdy:idm+nbdy), &
jsq(1-nbdy:idm+nbdy), &
jsu(1-nbdy:idm+nbdy), &
jsv(1-nbdy:idm+nbdy) )
call mem_stat_add( 2*(idm+2*nbdy) ) !real=2*int
!
allocate( &
allip(1-nbdy:jdm+nbdy), &
alliq(1-nbdy:jdm+nbdy), &
alliu(1-nbdy:jdm+nbdy), &
alliv(1-nbdy:jdm+nbdy) )
call mem_stat_add( 2*(jdm+2*nbdy) ) !real=2*logical
!
end subroutine gindex_allocate
#endif /* RELO */
subroutine mem_stat_add(mem_words)
implicit none
!
integer mem_words
!
! --- add mem_words to mem_alloc_ statistics
! --- note that mem_words can be negative
! --- call after every allocate and deallocate statement
!
mem_alloc_now = mem_alloc_now + mem_words
mem_alloc_high = max( mem_alloc_high, mem_alloc_now )
!
end subroutine mem_stat_add
subroutine mem_stat_print(ctitle)
implicit none
!
character*(*) ctitle
!
! --- print memory statistics
! --- only call mem_stat_print on the processors that you want to print
!
real*8 a3_1,a3_now,a3_high,gb_now,gb_high
integer*8 mem_3d,mem_3df
!
gb_now = mem_alloc_now / (1024.d0**3/8.d0)
gb_high = mem_alloc_high / (1024.d0**3/8.d0)
!
a3_1 = (idm+2*nbdy)*(jdm+2*nbdy)*kdm
!
mem_3d = mem_alloc_now /((idm+2*nbdy)*(jdm+2*nbdy)*kdm)
mem_3df = mem_alloc_now - &
mem_3d*((idm+2*nbdy)*(jdm+2*nbdy)*kdm)
a3_now = mem_3d + mem_3df/a3_1
!
mem_3d = mem_alloc_high/((idm+2*nbdy)*(jdm+2*nbdy)*kdm)
mem_3df = mem_alloc_high - &
mem_3d*((idm+2*nbdy)*(jdm+2*nbdy)*kdm)
a3_high = mem_3d + mem_3df/a3_1
!
write(lp,'(/a,a,2i16/a,a,4x,2f16.3/a,a,4x,2f16.3/)') &
trim(ctitle),' memory (words) now,high =', &
mem_alloc_now,mem_alloc_high, &
trim(ctitle),' memory (GB) now,high =', &
gb_now,gb_high, &
trim(ctitle),' eq. 3-D arrays now,high =', &
a3_now,a3_high
!
end subroutine mem_stat_print
#if defined(NAN2003)
subroutine set_r_init
use ieee_arithmetic, only : ieee_value, &
ieee_quiet_nan
implicit none
!
! --- inititialize r_init
! --- the value that allocated arrays should be set to
! --- version with ieee_arithmetic intrinsic module
!
r_init = ieee_value(r_init, ieee_quiet_nan)
!
end subroutine set_r_init
#else
subroutine set_r_init
implicit none
!
! --- inititialize r_init
! --- the value that allocated arrays should be set to
! --- version without ieee_arithmetic intrinsic module
!
r_init = huge(r_init)
!
end subroutine set_r_init
#endif
end module mod_dimensions
!
!> Revision history:
!>
!> Jan. 2014 - inline some of dimensions.h
!> Jan. 2014 - add r_init and set_r_init; r_init is NaN via /* NAN2003 */ macro
!> Jan. 2014 - dimensions_relo.h for relocatable (region independent) case
!> Feb. 2014 - removed margin, no longer a global variable
!> Apr. 2014 - added ishlf
!> May 2014 - added ipim1,ipip1,ipjm1,ipjp1,ipim1x,ipip1x,ipjm1x,ipjp1x
!> May 2014 - added allip,alliq,alliu,alliv
!> Feb. 2015 - added gb_now,gb_high