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

Last change on this file since 2797 was 2797, checked in by suehring, 6 years ago

Output of ground-heat flux at natural- and urban-type surfaces in one output variable; enable restart data of _av variables that belong to both land- and urban-surface model

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