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

Last change on this file since 2837 was 2817, checked in by knoop, 7 years ago

Preliminary gust module interface implemented

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