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

Last change on this file since 2022 was 2001, checked in by knoop, 8 years ago

last commit documented

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