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

Last change on this file since 1686 was 1683, checked in by knoop, 9 years ago

last commit documented

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