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

Last change on this file since 2143 was 2101, checked in by suehring, 8 years ago

last commit documented

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