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

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

Code annotations made doxygen readable

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