source: palm/trunk/SOURCE/write_3d_binary.f90 @ 1973

Last change on this file since 1973 was 1973, checked in by maronga, 8 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 17.5 KB
Line 
1!> @file write_3d_binary.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2016 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21!
22!
23! Former revisions:
24! -----------------
25! $Id: write_3d_binary.f90 1973 2016-07-26 07:52:45Z maronga $
26!
27! 1972 2016-07-26 07:52:02Z maronga
28! Land surface actions are now done directly in the respective module
29!
30! 1849 2016-04-08 11:33:18Z hoffmann
31! prr, precipitation_amount moved to arrays_3d
32!
33! 1833 2016-04-07 14:23:03Z raasch
34! statistics module replaced by spectra module
35!
36! 1822 2016-04-07 07:49:42Z hoffmann
37! icloud_scheme replaced by microphysics_*
38!
39! 1788 2016-03-10 11:01:04Z maronga
40! Added z0q and z0q_av
41!
42! 1709 2015-11-04 14:47:01Z maronga
43! Added rad_lw_out_change_0, increased binary_version
44!
45! 1691 2015-10-26 16:17:44Z maronga
46! Added output of radiative heating rates for RRTMG. Added output of ol. Removed
47! output of rif.
48!
49! 1682 2015-10-07 23:56:08Z knoop
50! Code annotations made doxygen readable
51!
52! 1585 2015-04-30 07:05:52Z maronga
53! Adapted for RRTMG
54!
55! 1551 2015-03-03 14:18:16Z maronga
56! Added support for binary ouput of land surface and radiation model data.
57!
58! 1400 2014-05-09 14:03:54Z knoop
59! writing of arrays for random_generator_parallel added
60!
61! 1359 2014-04-11 17:15:14Z hoffmann
62! Bugfix using cloud_droplets solved. qc, qr*, nr* are no longer written in case
63! of cloud_droplets = .TRUE.
64!
65! 1320 2014-03-20 08:40:49Z raasch
66! ONLY-attribute added to USE-statements,
67! revision history before 2012 removed,
68! comment fields (!:) to be used for variable explanations added to
69! all variable declaration statements
70!
71! 1318 2014-03-17 13:35:16Z raasch
72! module interfaces removed
73!
74! 1115 2013-03-26 18:16:16Z hoffmann
75! qr and nr are restricted to precipitation
76!
77! 1053 2012-11-13 17:11:03Z hoffmann
78! necessary expansions according to the two new prognostic equations (nr, qr)
79! of the two-moment cloud physics scheme:
80! +prr, prr_av, *, *_av, *s, *sws, *swst
81!
82! 1036 2012-10-22 13:43:42Z raasch
83! code put under GPL (PALM 3.9)
84!
85! 1001 2012-09-13 14:08:46Z raasch
86! all actions concerning leapfrog- and ups-scheme removed
87!
88! 978 2012-08-09 08:28:32Z fricke
89! +z0h, z0h_av
90!
91! Revision 1.1  1998/03/18 20:20:21  raasch
92! Initial revision
93!
94!
95! Description:
96! ------------
97!> Binary output of variables and arrays for restarts.
98!------------------------------------------------------------------------------!
99 SUBROUTINE write_3d_binary
100 
101
102    USE arrays_3d,                                                             &
103        ONLY:  e, kh, km, ol, p, pt, q, ql, qc, nr, nrs, nrsws, nrswst,        &
104               prr, precipitation_amount, qr,                                  &
105               qrs, qrsws, qrswst, qs, qsws, qswst, s, sa, ssws, sswst,        &
106               saswsb, saswst, rif_wall, shf, ss, ts, tswst, u, u_m_l, u_m_n,  &
107               u_m_r, u_m_s, us, usws, uswst, v, v_m_l, v_m_n, v_m_r, v_m_s,   &
108               vpt, vsws, vswst, w, w_m_l, w_m_n, w_m_r, w_m_s, z0, z0h, z0q
109       
110    USE averaging
111
112    USE control_parameters,                                                    &
113        ONLY:  iran, humidity, passive_scalar, cloud_physics, cloud_droplets,  &
114               microphysics_seifert, ocean, topography
115               
116    USE indices,                                                               &
117        ONLY:  nxl, nxr, nys, nyn, nzb, nzt
118       
119    USE particle_attributes,                                                   &
120        ONLY:  iran_part
121       
122    USE pegrid
123   
124    USE radiation_model_mod,                                                   &
125        ONLY: radiation, rad_net, rad_net_av, rad_lw_in, rad_lw_in_av,         &
126              rad_lw_out, rad_lw_out_av, rad_lw_out_change_0, rad_lw_cs_hr,   &
127              rad_lw_cs_hr_av, rad_lw_hr, rad_lw_hr_av, rad_sw_in,             &
128              rad_sw_in_av, rad_sw_out, rad_sw_out_av, rad_sw_cs_hr,           &
129              rad_sw_cs_hr_av, rad_sw_hr, rad_sw_hr_av
130
131    USE random_function_mod,                                                   &
132        ONLY:  random_iv, random_iy
133
134    USE random_generator_parallel,                                             &
135        ONLY:  id_random_array, seq_random_array
136       
137    USE spectra_mod,                                                           &
138        ONLY:  spectrum_x, spectrum_y
139
140    IMPLICIT NONE
141
142    CHARACTER (LEN=10) ::  binary_version   !<
143
144
145!
146!-- Write control parameters and other variables for restart.
147    IF ( myid == 0 )  CALL write_var_list
148
149!
150!-- Write arrays.
151    binary_version = '4.4'
152
153    WRITE ( 14 )  binary_version
154
155    WRITE ( 14 )  numprocs, myid, nxl, nxr, nys, nyn, nzb, nzt
156
157!
158!-- Attention: After changes to the following output commands the version number
159!-- ---------  of the variable binary_version must be changed!
160!--            Also, the list of arrays to be read in read_3d_binary must be
161!--            adjusted accordingly.
162
163    WRITE ( 14 )  'e                   ';  WRITE ( 14 )  e
164    IF ( ALLOCATED( e_av ) )  THEN
165       WRITE ( 14 )  'e_av                ';  WRITE ( 14 )  e_av
166    ENDIF
167    WRITE ( 14 )  'iran                ';  WRITE ( 14 )  iran, iran_part
168    WRITE ( 14 )  'kh                  ';  WRITE ( 14 )  kh
169    WRITE ( 14 )  'km                  ';  WRITE ( 14 )  km
170    IF ( ALLOCATED( lpt_av ) )  THEN
171       WRITE ( 14 )  'lpt_av              ';  WRITE ( 14 )  lpt_av
172    ENDIF
173    IF ( ALLOCATED( lwp_av ) )  THEN
174       WRITE ( 14 )  'lwp_av              ';  WRITE ( 14 )  lwp_av
175    ENDIF
176    WRITE ( 14 )  'ol                  ';  WRITE ( 14 )  ol
177    WRITE ( 14 )  'p                   ';  WRITE ( 14 )  p
178    IF ( ALLOCATED( p_av ) )  THEN
179       WRITE ( 14 )  'p_av                ';  WRITE ( 14 )  p_av
180    ENDIF
181    IF ( ALLOCATED( pc_av ) )  THEN
182       WRITE ( 14 )  'pc_av               ';  WRITE ( 14 )  pc_av
183    ENDIF
184    IF ( ALLOCATED( pr_av ) )  THEN
185       WRITE ( 14 )  'pr_av               ';  WRITE ( 14 )  pr_av
186    ENDIF
187    IF ( ALLOCATED( prr ) )  THEN
188       WRITE ( 14 )  'prr                 ';  WRITE ( 14 )  prr
189    ENDIF
190    IF ( ALLOCATED( prr_av ) )  THEN
191       WRITE ( 14 )  'prr_av              ';  WRITE ( 14 )  prr_av
192    ENDIF
193    IF ( ALLOCATED( precipitation_amount ) )  THEN
194       WRITE ( 14 )  'precipitation_amount';  WRITE ( 14 )  precipitation_amount
195    ENDIF
196    IF ( ALLOCATED( precipitation_rate_av ) )  THEN
197       WRITE ( 14 )  'precipitation_rate_a';  WRITE ( 14 )                     &
198                                                           precipitation_rate_av
199    ENDIF
200    WRITE ( 14 )  'pt                  ';  WRITE ( 14 )  pt
201    IF ( ALLOCATED( pt_av ) )  THEN
202       WRITE ( 14 )  'pt_av               ';  WRITE ( 14 )  pt_av
203    ENDIF
204    IF ( humidity )  THEN
205       WRITE ( 14 )  'q                   ';  WRITE ( 14 )  q 
206       IF ( ALLOCATED( q_av ) )  THEN
207          WRITE ( 14 )  'q_av                ';  WRITE ( 14 )  q_av
208       ENDIF
209       IF ( cloud_physics  .OR.  cloud_droplets )  THEN
210          WRITE ( 14 )  'ql                  ';  WRITE ( 14 )  ql
211          IF ( ALLOCATED( ql_av ) )  THEN
212             WRITE ( 14 )  'ql_av               ';  WRITE ( 14 )  ql_av
213          ENDIF
214          IF ( .NOT. cloud_droplets )  THEN
215             WRITE ( 14 )  'qc                  ';  WRITE ( 14 )  qc
216             IF ( ALLOCATED( qc_av ) )  THEN
217                WRITE ( 14 )  'qc_av               ';  WRITE ( 14 )  qc_av
218             ENDIF
219             IF ( microphysics_seifert )  THEN
220                WRITE ( 14 )  'nr                  ';  WRITE ( 14 )  nr
221                IF ( ALLOCATED( nr_av ) )  THEN
222                   WRITE ( 14 )  'nr_av               ';  WRITE ( 14 )  nr_av
223                ENDIF
224                WRITE ( 14 )  'nrs                 ';  WRITE ( 14 )  nrs
225                WRITE ( 14 )  'nrsws               ';  WRITE ( 14 )  nrsws
226                WRITE ( 14 )  'nrswst              ';  WRITE ( 14 )  nrswst
227                WRITE ( 14 )  'qr                  ';  WRITE ( 14 )  qr
228                IF ( ALLOCATED( qr_av ) )  THEN
229                   WRITE ( 14 )  'qr_av               ';  WRITE ( 14 )  qr_av
230                ENDIF
231                WRITE ( 14 )  'qrs                 ';  WRITE ( 14 )  qrs
232                WRITE ( 14 )  'qrsws               ';  WRITE ( 14 )  qrsws
233                WRITE ( 14 )  'qrswst              ';  WRITE ( 14 )  qrswst
234             ENDIF
235          ENDIF
236       ENDIF
237       WRITE ( 14 )  'qs                  ';  WRITE ( 14 )  qs
238       WRITE ( 14 )  'qsws                ';  WRITE ( 14 )  qsws
239       IF ( ALLOCATED( qsws_av ) )  THEN
240          WRITE ( 14 )  'qsws_av             ';  WRITE ( 14 )  qsws_av
241       ENDIF
242       WRITE ( 14 )  'qswst               ';  WRITE ( 14 ) qswst
243    ENDIF
244    IF ( passive_scalar )  THEN
245       WRITE ( 14 )  's                   ';  WRITE ( 14 )  s 
246       IF ( ALLOCATED( s_av ) )  THEN
247          WRITE ( 14 )  's_av                ';  WRITE ( 14 )  s_av
248       ENDIF
249       WRITE ( 14 )  'ss                  ';  WRITE ( 14 )  ss
250       WRITE ( 14 )  'ssws                ';  WRITE ( 14 )  ssws
251       IF ( ALLOCATED( ssws_av ) )  THEN
252          WRITE ( 14 )  'ssws_av             ';  WRITE ( 14 )  ssws_av
253       ENDIF
254       WRITE ( 14 )  'sswst               ';  WRITE ( 14 ) sswst
255    ENDIF   
256    IF ( ALLOCATED( rad_net ) )  THEN
257       WRITE ( 14 )  'rad_net             ';  WRITE ( 14 )  rad_net 
258    ENDIF
259    IF ( radiation )  THEN
260       IF ( ALLOCATED( rad_net_av ) )  THEN
261          WRITE ( 14 )  'rad_net_av          ';  WRITE ( 14 )  rad_net_av 
262       ENDIF 
263       IF ( ALLOCATED( rad_lw_in ) )  THEN
264          WRITE ( 14 )  'rad_lw_in           ';  WRITE ( 14 )  rad_lw_in 
265       ENDIF
266       IF ( ALLOCATED( rad_lw_in_av ) )  THEN
267          WRITE ( 14 )  'rad_lw_in_av        ';  WRITE ( 14 )  rad_lw_in_av 
268       ENDIF
269       IF ( ALLOCATED( rad_lw_out ) )  THEN
270          WRITE ( 14 )  'rad_lw_out          ';  WRITE ( 14 )  rad_lw_out 
271       ENDIF
272       IF ( ALLOCATED( rad_lw_out_av ) )  THEN
273          WRITE ( 14 )  'rad_lw_out_av       ';  WRITE ( 14 )  rad_lw_out_av 
274       ENDIF
275       IF ( ALLOCATED( rad_lw_out_change_0 ) )  THEN
276          WRITE ( 14 )  'rad_lw_out_change_0 '
277          WRITE ( 14 )  rad_lw_out_change_0
278       ENDIF
279       IF ( ALLOCATED( rad_lw_cs_hr ) )  THEN
280          WRITE ( 14 )  'rad_lw_cs_hr        ';  WRITE ( 14 )  rad_lw_cs_hr
281       ENDIF
282       IF ( ALLOCATED( rad_lw_cs_hr_av ) )  THEN
283          WRITE ( 14 )  'rad_lw_cs_hr_av     ';  WRITE ( 14 )  rad_lw_cs_hr_av
284       ENDIF
285       IF ( ALLOCATED( rad_lw_hr ) )  THEN
286          WRITE ( 14 )  'rad_lw_hr           ';  WRITE ( 14 )  rad_lw_hr
287       ENDIF
288       IF ( ALLOCATED( rad_lw_hr_av ) )  THEN
289          WRITE ( 14 )  'rad_lw_hr_av        ';  WRITE ( 14 )  rad_lw_hr_av
290       ENDIF
291       IF ( ALLOCATED( rad_sw_in ) )  THEN
292          WRITE ( 14 )  'rad_sw_in           ';  WRITE ( 14 )  rad_sw_in 
293       ENDIF
294       IF ( ALLOCATED( rad_sw_in_av ) )  THEN
295          WRITE ( 14 )  'rad_sw_in_av        ';  WRITE ( 14 )  rad_sw_in_av 
296       ENDIF
297       IF ( ALLOCATED( rad_sw_out ) )  THEN
298          WRITE ( 14 )  'rad_sw_out          ';  WRITE ( 14 )  rad_sw_out 
299       ENDIF
300       IF ( ALLOCATED( rad_sw_out_av ) )  THEN
301          WRITE ( 14 )  'rad_sw_out_av       ';  WRITE ( 14 )  rad_sw_out_av 
302       ENDIF
303       IF ( ALLOCATED( rad_sw_cs_hr ) )  THEN
304          WRITE ( 14 )  'rad_sw_cs_hr        ';  WRITE ( 14 )  rad_sw_cs_hr
305       ENDIF
306       IF ( ALLOCATED( rad_sw_cs_hr_av ) )  THEN
307          WRITE ( 14 )  'rad_sw_cs_hr_av     ';  WRITE ( 14 )  rad_sw_cs_hr_av
308       ENDIF
309       IF ( ALLOCATED( rad_sw_hr ) )  THEN
310          WRITE ( 14 )  'rad_sw_hr           ';  WRITE ( 14 )  rad_sw_hr
311       ENDIF
312       IF ( ALLOCATED( rad_sw_hr_av ) )  THEN
313          WRITE ( 14 )  'rad_sw_hr_av        ';  WRITE ( 14 )  rad_sw_hr_av
314       ENDIF
315    ENDIF
316    IF ( ocean )  THEN
317       IF ( ALLOCATED( rho_av ) )  THEN
318          WRITE ( 14 )  'rho_av              ';  WRITE ( 14 )  rho_av
319       ENDIF
320       WRITE ( 14 )  'sa                  ';  WRITE ( 14 )  sa
321       IF ( ALLOCATED( sa_av ) )  THEN
322          WRITE ( 14 )  'sa_av               ';  WRITE ( 14 )  sa_av
323       ENDIF
324       WRITE ( 14 )  'saswsb              ';  WRITE ( 14 )  saswsb
325       WRITE ( 14 )  'saswst              ';  WRITE ( 14 )  saswst
326    ENDIF
327    IF ( ALLOCATED( ql_c_av ) )  THEN
328       WRITE ( 14 )  'ql_c_av             ';  WRITE ( 14 )  ql_c_av
329    ENDIF
330    IF ( ALLOCATED( ql_v_av ) )  THEN
331       WRITE ( 14 )  'ql_v_av             ';  WRITE ( 14 )  ql_v_av
332    ENDIF
333    IF ( ALLOCATED( ql_vp_av ) )  THEN
334       WRITE ( 14 )  'ql_vp_av            ';  WRITE ( 14 )  ql_vp_av
335    ENDIF
336    IF ( ALLOCATED( qv_av ) )  THEN
337       WRITE ( 14 )  'qv_av               ';  WRITE ( 14 )  qv_av
338    ENDIF
339    WRITE ( 14 )  'random_iv           ';  WRITE ( 14 )  random_iv
340                                           WRITE ( 14 )  random_iy
341    IF ( ALLOCATED( seq_random_array ) )  THEN
342    WRITE ( 14 )  'seq_random_array    ';  WRITE ( 14 )  id_random_array
343                                           WRITE ( 14 )  seq_random_array
344    ENDIF
345    IF ( topography /= 'flat' )  THEN
346       WRITE ( 14 )  'rif_wall            ';  WRITE ( 14 )  rif_wall
347    ENDIF
348    IF ( ALLOCATED( s_av ) )  THEN
349       WRITE ( 14 )  's_av                ';  WRITE ( 14 )  s_av
350    ENDIF
351    WRITE ( 14 )  'shf                 ';  WRITE ( 14 )  shf
352    IF ( ALLOCATED( shf_av ) )  THEN
353       WRITE ( 14 )  'shf_av              ';  WRITE ( 14 )  shf_av
354    ENDIF
355    IF ( ALLOCATED( spectrum_x ) )  THEN
356       WRITE ( 14 )  'spectrum_x          ';  WRITE ( 14 )  spectrum_x
357       WRITE ( 14 )  'spectrum_y          ';  WRITE ( 14 )  spectrum_y
358    ENDIF
359    WRITE ( 14 )  'ts                  ';  WRITE ( 14 )  ts
360    IF ( ALLOCATED( ts_av ) )  THEN
361       WRITE ( 14 )  'ts_av               ';  WRITE ( 14 )  ts_av
362    ENDIF
363    WRITE ( 14 )  'tswst               ';  WRITE ( 14 )  tswst
364    WRITE ( 14 )  'u                   ';  WRITE ( 14 )  u
365    IF ( ALLOCATED( u_av ) )  THEN
366       WRITE ( 14 )  'u_av                ';  WRITE ( 14 )  u_av
367    ENDIF
368    IF ( ALLOCATED( u_m_l ) )  THEN
369       WRITE ( 14 )  'u_m_l               ';  WRITE ( 14 )  u_m_l
370    ENDIF
371    IF ( ALLOCATED( u_m_n ) )  THEN
372       WRITE ( 14 )  'u_m_n               ';  WRITE ( 14 )  u_m_n
373    ENDIF
374    IF ( ALLOCATED( u_m_r ) )  THEN
375       WRITE ( 14 )  'u_m_r               ';  WRITE ( 14 )  u_m_r
376    ENDIF
377    IF ( ALLOCATED( u_m_s ) )  THEN
378       WRITE ( 14 )  'u_m_s               ';  WRITE ( 14 )  u_m_s
379    ENDIF
380    WRITE ( 14 )  'us                  ';  WRITE ( 14 )  us
381    WRITE ( 14 )  'usws                ';  WRITE ( 14 )  usws
382    WRITE ( 14 )  'uswst               ';  WRITE ( 14 )  uswst
383    IF ( ALLOCATED( us_av ) )  THEN
384       WRITE ( 14 )  'us_av               ';  WRITE ( 14 )  us_av
385    ENDIF
386    WRITE ( 14 )  'v                   ';  WRITE ( 14 )  v
387    IF ( ALLOCATED( v_av ) )  THEN
388       WRITE ( 14 )  'v_av                ';  WRITE ( 14 )  v_av
389    ENDIF
390    IF ( ALLOCATED( v_m_l ) )  THEN
391       WRITE ( 14 )  'v_m_l               ';  WRITE ( 14 )  v_m_l
392    ENDIF
393    IF ( ALLOCATED( v_m_n ) )  THEN
394       WRITE ( 14 )  'v_m_n               ';  WRITE ( 14 )  v_m_n
395    ENDIF
396    IF ( ALLOCATED( v_m_r ) )  THEN
397       WRITE ( 14 )  'v_m_r               ';  WRITE ( 14 )  v_m_r
398    ENDIF
399    IF ( ALLOCATED( v_m_s ) )  THEN
400       WRITE ( 14 )  'v_m_s               ';  WRITE ( 14 )  v_m_s
401    ENDIF
402    IF ( humidity )  THEN
403       WRITE ( 14 )  'vpt                 ';  WRITE ( 14 )  vpt
404       IF ( ALLOCATED( vpt_av ) )  THEN
405          WRITE ( 14 )  'vpt_av              ';  WRITE ( 14 )  vpt_av
406       ENDIF
407    ENDIF
408    WRITE ( 14 )  'vsws                ';  WRITE ( 14 )  vsws
409    WRITE ( 14 )  'vswst               ';  WRITE ( 14 )  vswst
410    WRITE ( 14 )  'w                   ';  WRITE ( 14 )  w
411    IF ( ALLOCATED( w_av ) )  THEN
412       WRITE ( 14 )  'w_av                ';  WRITE ( 14 )  w_av
413    ENDIF
414    IF ( ALLOCATED( w_m_l ) )  THEN
415       WRITE ( 14 )  'w_m_l               ';  WRITE ( 14 )  w_m_l
416    ENDIF
417    IF ( ALLOCATED( w_m_n ) )  THEN
418       WRITE ( 14 )  'w_m_n               ';  WRITE ( 14 )  w_m_n
419    ENDIF
420    IF ( ALLOCATED( w_m_r ) )  THEN
421       WRITE ( 14 )  'w_m_r               ';  WRITE ( 14 )  w_m_r
422    ENDIF
423    IF ( ALLOCATED( w_m_s ) )  THEN
424       WRITE ( 14 )  'w_m_s               ';  WRITE ( 14 )  w_m_s
425    ENDIF
426    WRITE ( 14 )  'z0                  ';  WRITE ( 14 )  z0
427    IF ( ALLOCATED( z0_av ) )  THEN
428       WRITE ( 14 )  'z0_av               ';  WRITE ( 14 )  z0_av
429    ENDIF
430    WRITE ( 14 )  'z0h                 ';  WRITE ( 14 )  z0h
431    IF ( ALLOCATED( z0h_av ) )  THEN
432       WRITE ( 14 )  'z0h_av              ';  WRITE ( 14 )  z0h_av
433    ENDIF
434    WRITE ( 14 )  'z0q                 ';  WRITE ( 14 )  z0q
435    IF ( ALLOCATED( z0q_av ) )  THEN
436       WRITE ( 14 )  'z0q_av              ';  WRITE ( 14 )  z0q_av
437    ENDIF
438
439!
440!-- Write end label. Unit 14 is closed in the main program.
441    WRITE ( 14 )  '*** end ***         '
442
443 END SUBROUTINE write_3d_binary
444 
Note: See TracBrowser for help on using the repository browser.