ncdf_dump.f90 25.9 KB
Newer Older
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
! ncdf_dump.f90 --- write a single array to a NetCDF file, for debugging mostly
!
! Copyright  (C)  2010  Thomas Jahns <jahns@dkrz.de>
!
! Version: 1.0
! Keywords: NetCDF
! Author: Thomas Jahns <jahns@dkrz.de>
! Maintainer: Thomas Jahns <jahns@dkrz.de>
! URL: https://www.dkrz.de/redmine/projects/show/scales-ppm
!
! Redistribution and use in source and binary forms, with or without
! modification, are  permitted provided that the following conditions are
! met:
!
! Redistributions of source code must retain the above copyright notice,
! this list of conditions and the following disclaimer.
!
! Redistributions in binary form must reproduce the above copyright
! notice, this list of conditions and the following disclaimer in the
! documentation and/or other materials provided with the distribution.
!
! Neither the name of the DKRZ GmbH nor the names of its contributors
! may be used to endorse or promote products derived from this software
! without specific prior written permission.
!
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
! IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
! TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
! PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
! OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
! EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
! PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
! PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
! LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
! NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
! SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
!
38
!> module ncdf_dump
39
40
!!
!! contains methods to write simple netCDF files for a single array
41
MODULE ncdf_dump
42
  USE mo_kind, ONLY: dp, i4, sp
43
  USE ppm_base, ONLY: assertion, abort_ppm
44
45
46
47
48
49
  IMPLICIT NONE
  INCLUDE 'netcdf.inc'
  PRIVATE
  PUBLIC :: dump_ncdf_single_array

  INTERFACE dump_ncdf_single_array
50
51
52
53
    MODULE PROCEDURE dump_ncdf_single_array_sp_asize
    MODULE PROCEDURE dump_ncdf_single_array_sp_1d
    MODULE PROCEDURE dump_ncdf_single_array_sp_2d
    MODULE PROCEDURE dump_ncdf_single_array_sp_3d
54
55
56
57
58
59
60
61
62
63
64
    MODULE PROCEDURE dump_ncdf_single_array_dp_asize
    MODULE PROCEDURE dump_ncdf_single_array_dp_1d
    MODULE PROCEDURE dump_ncdf_single_array_dp_2d
    MODULE PROCEDURE dump_ncdf_single_array_dp_3d
    MODULE PROCEDURE dump_ncdf_single_array_i4_asize
    MODULE PROCEDURE dump_ncdf_single_array_i4_1d
    MODULE PROCEDURE dump_ncdf_single_array_i4_2d
    MODULE PROCEDURE dump_ncdf_single_array_i4_3d
  END INTERFACE

  CHARACTER(*), PARAMETER :: longitude = 'longitude', latitude = 'latitude', &
65
       degrees_east = 'degrees_east', degrees_north = 'degrees_north'
66
67

CONTAINS
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
  SUBROUTINE dump_ncdf_single_array_sp_asize(dump_fname, a, a_shape, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(sp), INTENT(in) :: a(*)
    INTEGER, INTENT(in) :: a_shape(:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(sp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ndims
    INTEGER :: ncid, varid_a, varid_lat, varid_lon
    INTEGER, ALLOCATABLE :: a_dimids(:)

    ndims = SIZE(a_shape)
    ALLOCATE(a_dimids(ndims))

89
    CALL cf_common_setup(dump_fname, ncid, a_shape, a_dimids, &
90
91
92
93
94
95
96
97
98
99
100
101
102
103
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_REAL, ndims, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, a_shape, &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_sp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_real(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
104
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_sp_asize

  SUBROUTINE dump_ncdf_single_array_sp_1d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(sp), INTENT(in) :: a(:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(sp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(1)

124
    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids, &
125
126
127
128
129
130
131
132
133
134
135
136
137
138
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_REAL, 1, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_sp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_real(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
139
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_sp_1d

  SUBROUTINE dump_ncdf_single_array_sp_2d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(sp), INTENT(in) :: a(:,:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(sp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(2)

159
    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids, &
160
161
162
163
164
165
166
167
168
169
170
171
172
173
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_REAL, 2, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_sp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_real(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
174
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_sp_2d

  SUBROUTINE dump_ncdf_single_array_sp_3d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(sp), INTENT(in) :: a(:,:,:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(sp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(3)

194
    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids, &
195
196
197
198
199
200
201
202
203
204
205
206
207
208
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_REAL, 3, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_sp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_real(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
209
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
210
211
212
213

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_sp_3d

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
  SUBROUTINE dump_ncdf_single_array_dp_asize(dump_fname, a, a_shape, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(dp), INTENT(in) :: a(*)
    INTEGER, INTENT(in) :: a_shape(:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(dp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ndims
    INTEGER :: ncid, varid_a, varid_lat, varid_lon
    INTEGER, ALLOCATABLE :: a_dimids(:)

    ndims = SIZE(a_shape)
    ALLOCATE(a_dimids(ndims))

235
    CALL cf_common_setup(dump_fname, ncid, a_shape, a_dimids, &
236
237
238
239
240
241
242
243
244
245
246
247
248
249
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_DOUBLE, ndims, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, a_shape, &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_dp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_double(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
250
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_dp_asize

  SUBROUTINE dump_ncdf_single_array_dp_1d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(dp), INTENT(in) :: a(:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(dp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(1)

270
    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids, &
271
272
273
274
275
276
277
278
279
280
281
282
283
284
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_DOUBLE, 1, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_dp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_double(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
285
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_dp_1d

  SUBROUTINE dump_ncdf_single_array_dp_2d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(dp), INTENT(in) :: a(:,:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(dp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(2)

305
    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids, &
306
307
308
309
310
311
312
313
314
315
316
317
318
319
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_DOUBLE, 2, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_dp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_double(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
320
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_dp_2d

  SUBROUTINE dump_ncdf_single_array_dp_3d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    REAL(dp), INTENT(in) :: a(:,:,:)
    CHARACTER(len=*), INTENT(in) :: a_name
    REAL(dp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(3)

340
    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids, &
341
342
343
344
345
346
347
348
349
350
351
352
353
354
         title, source, institution)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_DOUBLE, 3, &
         a_dimids, varid_a), __LINE__)

    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_dp(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_double(ncid, varid_a, a), __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
355
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_dp_3d

  SUBROUTINE dump_ncdf_single_array_i4_asize(dump_fname, a, a_shape, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    INTEGER(i4), INTENT(in) :: a(*)
    INTEGER, INTENT(in) :: a_shape(:)
    CHARACTER(len=*), INTENT(in) :: a_name
    INTEGER(i4), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ndims
    INTEGER :: ncid, varid_a, varid_lat, varid_lon
    INTEGER, ALLOCATABLE :: a_dimids(:)

    ndims = SIZE(a_shape)
    ALLOCATE(a_dimids(ndims))

    CALL cf_common_setup(dump_fname, ncid, a_shape, a_dimids)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_INT, ndims, &
         a_dimids, varid_a), __LINE__)

386
    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, a_shape, &
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_i4(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_int(ncid, varid_a, a), &
         __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_i4_asize

  SUBROUTINE dump_ncdf_single_array_i4_1d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    INTEGER(i4), INTENT(in) :: a(:)
    CHARACTER(len=*), INTENT(in) :: a_name
    INTEGER(i4), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(1)

    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_INT, 1, &
         a_dimids, varid_a), __LINE__)

421
    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_i4(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_int(ncid, varid_a, a), &
         __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_i4_1d

  SUBROUTINE dump_ncdf_single_array_i4_2d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    INTEGER(i4), INTENT(in) :: a(:,:)
    CHARACTER(len=*), INTENT(in) :: a_name
    INTEGER(i4), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(2)

    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_INT, 2, &
         a_dimids, varid_a), __LINE__)

456
    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_i4(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_int(ncid, varid_a, a), &
         __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_i4_2d

  SUBROUTINE dump_ncdf_single_array_i4_3d(dump_fname, a, a_name, &
       a_valid_range, a_fill_value, &
       title, source, institution, a_long_name, alon, alat)
    CHARACTER(len=*), intent(in) :: dump_fname
    INTEGER(i4), INTENT(in) :: a(:,:,:)
    CHARACTER(len=*), INTENT(in) :: a_name
    INTEGER(i4), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alon(:,:), alat(:,:)

    INTEGER :: ncid, varid_a, varid_lat, varid_lon, a_dimids(3)

    CALL cf_common_setup(dump_fname, ncid, SHAPE(a), a_dimids)

    CALL handle_ncdf_err(nf_def_var(ncid, a_name, NF_INT, 3, &
         a_dimids, varid_a), __LINE__)

491
    CALL put_cf_array_attributes_common(ncid, varid_a, a_dimids, SHAPE(a), &
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
         varid_lat, varid_lon, alon, alat, a_long_name)
    CALL put_cf_array_attributes_i4(ncid, varid_a, a_valid_range, a_fill_value)

    CALL handle_ncdf_err(nf_enddef(ncid), __LINE__)

    CALL handle_ncdf_err(nf_put_var_int(ncid, varid_a, a), &
         __LINE__)

    IF (PRESENT(alon) .AND. PRESENT(alat)) &
         CALL put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, alon, alat)

    CALL handle_ncdf_err(nf_close(ncid), __LINE__)
  END SUBROUTINE dump_ncdf_single_array_i4_3d

  SUBROUTINE cf_common_setup(dump_fname, ncid, a_shape, a_dimids, &
       title, institution, source)
    CHARACTER(len=*), INTENT(in) :: dump_fname
    INTEGER, INTENT(inout) :: ncid
    INTEGER, INTENT(in) :: a_shape(:)
    INTEGER, INTENT(inout) :: a_dimids(:)
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: title
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: source
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: institution

    CHARACTER(len=3), PARAMETER :: dim_name(7) = (/ 'x  ', 'y  ', 'z  ', &
         'xx ', 'yy ', 'zz ', 'xxx' /)
    INTEGER :: ndims, i

    ndims = SIZE(a_shape)
    CALL handle_ncdf_err(nf_create(dump_fname, NF_CLOBBER, ncid), &
         __LINE__)
    DO i = 1, ndims
      CALL handle_ncdf_err(nf_def_dim(ncid, TRIM(dim_name(i)), a_shape(i), &
           a_dimids(i)), __LINE__)
    END DO
    ! write global cf information
    IF (PRESENT(title)) &
         CALL handle_ncdf_err(nf_put_att_text(ncid, NF_GLOBAL, &
         'title', LEN(title), title), __LINE__)
    IF (PRESENT(institution)) &
         CALL handle_ncdf_err(nf_put_att_text(ncid, NF_GLOBAL, &
         'institution', LEN(institution), institution), __LINE__)
    IF (PRESENT(source)) &
         CALL handle_ncdf_err(nf_put_att_text(ncid, NF_GLOBAL, &
         'source', LEN(source), source), __LINE__)
  END SUBROUTINE cf_common_setup

  SUBROUTINE put_cf_array_attributes_common(ncid, varid_a, a_dimids, a_shape, &
       varid_lat, varid_lon, alat, alon, a_long_name)
    INTEGER, INTENT(in) :: ncid, varid_a, a_shape(:)
    INTEGER, INTENT(inout) :: a_dimids(:)
    CHARACTER(len=*), OPTIONAL, INTENT(in) :: a_long_name
    REAL(dp), OPTIONAL, INTENT(in) :: alat(:,:), alon(:,:)
    INTEGER, INTENT(inout) :: varid_lat, varid_lon

    IF (PRESENT(a_long_name)) &
         CALL handle_ncdf_err(nf_put_att_text(ncid, varid_a, &
         'long_name', LEN(a_long_name), a_long_name), __LINE__)
    IF (PRESENT(alat) .AND. PRESENT(alon)) THEN
      CALL assertion(SIZE(a_dimids) >= 2, __FILE__, __LINE__)
      CALL assertion(SIZE(alon, 1) == SIZE(alat, 1) &
           .AND. SIZE(alon, 2) == SIZE(alat, 2) &
           .AND. SIZE(alon, 1) == a_shape(1) &
           .AND. SIZE(alon, 2) == a_shape(2), __FILE__, __LINE__)
      CALL cf_latlon_geometry_setup(ncid, varid_a, a_shape(1:2), &
           a_dimids(1:2), varid_lat, varid_lon)
    END IF
  END SUBROUTINE put_cf_array_attributes_common

561
562
563
564
565
566
567
568
569
570
571
572
573
  SUBROUTINE put_cf_array_attributes_sp(ncid, varid_a, &
       a_valid_range, a_fill_value)
    INTEGER, INTENT(in) :: ncid, varid_a
    REAL(sp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value

    IF (PRESENT(a_valid_range)) &
         CALL handle_ncdf_err(nf_put_att_real(ncid, varid_a, &
         'valid_range', NF_REAL, 2, a_valid_range(1)), __LINE__)
    IF (PRESENT(a_fill_value)) &
         CALL handle_ncdf_err(nf_put_att_real(ncid, varid_a, &
         '_FillValue', NF_REAL, 1, a_fill_value), __LINE__)
  END SUBROUTINE put_cf_array_attributes_sp

574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
  SUBROUTINE put_cf_array_attributes_dp(ncid, varid_a, &
       a_valid_range, a_fill_value)
    INTEGER, INTENT(in) :: ncid, varid_a
    REAL(dp), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value

    IF (PRESENT(a_valid_range)) &
         CALL handle_ncdf_err(nf_put_att_double(ncid, varid_a, &
         'valid_range', NF_DOUBLE, 2, a_valid_range(1)), __LINE__)
    IF (PRESENT(a_fill_value)) &
         CALL handle_ncdf_err(nf_put_att_double(ncid, varid_a, &
         '_FillValue', NF_DOUBLE, 1, a_fill_value), __LINE__)
  END SUBROUTINE put_cf_array_attributes_dp

  SUBROUTINE put_cf_array_attributes_i4(ncid, varid_a, &
       a_valid_range, a_fill_value)
    INTEGER, INTENT(in) :: ncid, varid_a
    INTEGER(i4), OPTIONAL, INTENT(in) :: a_valid_range(2), a_fill_value

    IF (PRESENT(a_valid_range)) &
         CALL handle_ncdf_err(nf_put_att_int(ncid, varid_a, &
         'valid_range', NF_INT, 2, a_valid_range(1)), __LINE__)
    IF (PRESENT(a_fill_value)) &
         CALL handle_ncdf_err(nf_put_att_int(ncid, varid_a, &
         '_FillValue', NF_INT, 1, a_fill_value), __LINE__)
  END SUBROUTINE put_cf_array_attributes_i4

  SUBROUTINE cf_latlon_geometry_setup(ncid, varid_a, a_shape, a_dimids, &
       varid_lat, varid_lon)
    INTEGER, INTENT(in) :: ncid, varid_a, a_shape(:)
    INTEGER, INTENT(inout) :: varid_lat, varid_lon
    INTEGER, INTENT(inout) :: a_dimids(:)

606
    CHARACTER(*), PARAMETER :: lat_lon_coord = 'lat lon'
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
    INTEGER :: ndims

    ndims = SIZE(a_shape)
    CALL handle_ncdf_err(nf_put_att_text(ncid, varid_a, &
         'coordinates', LEN(lat_lon_coord), lat_lon_coord), __LINE__)
    CALL handle_ncdf_err(nf_def_var(ncid, 'lat', NF_DOUBLE, ndims, &
         a_dimids, varid_lat), __LINE__)
    CALL handle_ncdf_err(nf_def_var(ncid, 'lon', NF_DOUBLE, ndims, &
         a_dimids, varid_lon), __LINE__)
  END SUBROUTINE

  SUBROUTINE put_cf_geometry(ncid, varid_a, varid_lat, varid_lon, &
         alon, alat)
    INTEGER, INTENT(inout) :: ncid, varid_a, varid_lat, varid_lon
    REAL(dp), INTENT(in) :: alon(:,:), alat(:,:)

    CALL handle_ncdf_err(nf_put_var_double(ncid, varid_lat, alat), &
         __LINE__)
    CALL handle_ncdf_err(nf_put_var_double(ncid, varid_lon, alon), &
         __LINE__)
  END SUBROUTINE put_cf_geometry

  SUBROUTINE handle_ncdf_err(errcode, line)
    INTEGER, INTENT(in) :: errcode, line
    IF (errcode .NE. nf_noerr) THEN
      CALL abort_ppm(nf_strerror(errcode), __FILE__, line)
    END IF
  END SUBROUTINE handle_ncdf_err

END MODULE ncdf_dump
637
638
639
640
641
!
! Local Variables:
! license-project-url: "https://www.dkrz.de/redmine/projects/show/scales-ppm"
! license-default: "bsd"
! End: