source: palm/trunk/SOURCE/parin.f90 @ 1053

Last change on this file since 1053 was 1053, checked in by hoffmann, 9 years ago

two-moment cloud physics implemented

  • Property svn:keywords set to Id
File size: 17.6 KB
Line 
1 SUBROUTINE parin
2
3!--------------------------------------------------------------------------------!
4! This file is part of PALM.
5!
6! PALM is free software: you can redistribute it and/or modify it under the terms
7! of the GNU General Public License as published by the Free Software Foundation,
8! either version 3 of the License, or (at your option) any later 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-2012  Leibniz University Hannover
18!--------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22! necessary expansions according to the two new prognostic equations (nr, qr)
23! of the two-moment cloud physics scheme and steering parameters:
24! +*_init, *_surface, *_surface_initial_change, *_vertical_gradient,
25! +*_vertical_gradient_level, surface_waterflux_*,
26! +cloud_scheme, drizzle, mu_constant, mu_constant_value, ventilation_effect
27!
28! Former revisions:
29! -----------------
30! $Id: parin.f90 1053 2012-11-13 17:11:03Z hoffmann $
31!
32! 1036 2012-10-22 13:43:42Z raasch
33! code put under GPL (PALM 3.9)
34!
35! 1015 2012-09-27 09:23:24Z raasch
36! -adjust_mixing_length
37!
38! 1003 2012-09-14 14:35:53Z raasch
39! -grid_matching
40!
41! 1001 2012-09-13 14:08:46Z raasch
42! -cut_spline_overshoot, long_filter_factor, overshoot_limit_*, ups_limit_*
43!
44! 996 2012-09-07 10:41:47Z raasch
45! -use_prior_plot1d_parameters
46!
47! 978 2012-08-09 08:28:32Z fricke
48! -km_damp_max, outflow_damping_width
49! +pt_damping_factor, pt_damping_width
50! +z0h_factor
51!
52! 964 2012-07-26 09:14:24Z raasch
53! -cross_normalized_x, cross_normalized_y, cross_xtext, z_max_do1d,
54! z_max_do1d_normalized
55!
56! 940 2012-07-09 14:31:00Z raasch
57! +neutral in inipar
58!
59! 927 2012-06-06 19:15:04Z raasch
60! +masking_method in inipar
61!
62! 824 2012-02-17 09:09:57Z raasch
63! +curvature_solution_effects in inipar
64!
65! 809 2012-01-30 13:32:58Z maronga
66! Bugfix: replaced .AND. and .NOT. with && and ! in the preprocessor directives
67!
68! 807 2012-01-25 11:53:51Z maronga
69! New cpp directive "__check" implemented which is used by check_namelist_files
70!
71! 785 2011-11-28 09:47:19Z raasch
72! +scalar_rayleigh_damping in inipar
73!
74! 767 2011-10-14 06:39:12Z raasch
75! +u_profile, v_profile, uv_heights in inipar
76!
77! 759 2011-09-15 13:58:31Z raasch
78! +maximum_parallel_io_streams in envpar,
79! splitting of parallel I/O in blocks of PEs
80!
81! 683 2011-02-09 14:25:15Z raasch
82! +synchronous_exchange in d3par
83!
84! 667 2010-12-23 12:06:00Z suehring/gryschka
85! Steering parameter dissipation_control added in inipar. (commented out)
86!
87! 622 2010-12-10 08:08:13Z raasch
88! +collective_wait in inipar
89!
90! 600 2010-11-24 16:10:51Z raasch
91! parameters moved from d3par to inipar: call_psolver_at_all_substeps,
92! cfl_factor, cycle_mg, mg_cycles, mg_switch_to_pe0_level, ngsrb, nsor,
93! omega_sor, prandtl_number, psolver, rayleigh_damping_factor,
94! rayleigh_damping_height, residual_limit
95!
96! 580 2010-10-05 13:59:11Z heinze
97! Renaming of ws_vertical_gradient to subs_vertical_gradient and
98! ws_vertical_gradient_level to subs_vertical_gradient_level
99!
100! 553 2010-09-01 14:09:06Z weinreis
101! parameters for masked output are replaced by arrays
102!
103! 493 2010-03-01 08:30:24Z raasch
104! +netcdf_data_format in d3par, -netcdf_64bit, -netcdf_64bit_3d
105!
106! 449 2010-02-02 11:23:59Z raasch
107! +wall_humidityflux, wall_scalarflux
108! +ws_vertical_gradient, ws_vertical_gradient_level
109!
110! 410 2009-12-04 17:05:40Z letzel
111! masked data output: + dt_domask, mask_01~20_x|y|z, mask_01~20_x|y|z_loop,
112! mask_scale_x|y|z, masks, skip_time_domask
113!
114! 291 2009-04-16 12:07:26Z raasch
115! +local_dvrserver_running in envpar
116! Output of messages replaced by message handling routine.
117! +canyon_height, canyon_width_x, canyon_width_y, canyon_wall_left,
118! canyon_wall_south, conserve_volume_flow_mode, coupling_start_time,
119! dp_external, dp_level_b, dp_smooth, dpdxy, u_bulk, v_bulk in inipar
120! topography_grid_convention moved from userpar
121!
122! 197 2008-09-16 15:29:03Z raasch
123! +cthf,leaf_surface_concentration, scalar_exchange_coefficient
124! +inflow_damping_height, inflow_damping_width, recycling_width,
125! turbulent_inflow in inipar, -skip_time_dosp in d3par,
126! allocation of hom_sum moved from init_3d_model to here,
127! npex, npey moved from inipar to d3par, setting of myid_char_14 removed,
128! lad is allways allocated
129!
130! 138 2007-11-28 10:03:58Z letzel
131! +canopy_mode, drag_coefficient, lad_surface, lad_vertical_gradient,
132! lad_vertical_gradient_level, pch_index, plant_canopy,
133! +allocation of leaf area density field
134!
135! 108 2007-08-24 15:10:38Z letzel
136! +e_init, top_momentumflux_u|v in inipar, +dt_coupling in d3par
137!
138! 95 2007-06-02 16:48:38Z raasch
139! +bc_sa_t, bottom_salinityflux, ocean, sa_surface, sa_vertical_gradient,
140! sa_vertical_gradient_level, top_salinityflux in inipar,
141! sa_init is allocated
142!
143! 87 2007-05-22 15:46:47Z raasch
144! Size of hom increased by the maximum number of user-defined profiles,
145! var_hom renamed pr_palm
146!
147! 82 2007-04-16 15:40:52Z raasch
148! +return_addres, return_username in envpar
149!
150! 75 2007-03-22 09:54:05Z raasch
151! +dt_max, netcdf_64bit_3d, precipitation_amount_interval in d3par,
152! +loop_optimization, pt_reference in inipar, -data_output_ts,
153! moisture renamed humidity
154!
155! 20 2007-02-26 00:12:32Z raasch
156! +top_heatflux, use_top_fluxes in inipar
157!
158! 3 2007-02-13 11:30:58Z raasch
159! +netcdf_64bit_3d in d3par,
160! RCS Log replace by Id keyword, revision history cleaned up
161!
162! Revision 1.57  2007/02/11 13:11:22  raasch
163! Values of environment variables are now read from file ENVPAR instead of
164! reading them with a system call, + NAMELIST envpar
165!
166! Revision 1.1  1997/07/24 11:22:50  raasch
167! Initial revision
168!
169!
170! Description:
171! ------------
172! This subroutine reads variables controling the run from the NAMELIST files
173!------------------------------------------------------------------------------!
174
175    USE arrays_3d
176    USE averaging
177    USE cloud_parameters
178    USE control_parameters
179    USE dvrp_variables
180    USE grid_variables
181    USE indices
182    USE model_1d
183    USE pegrid
184    USE profil_parameter
185    USE statistics
186
187    IMPLICIT NONE
188
189    INTEGER ::  i, idum
190
191
192    NAMELIST /inipar/  alpha_surface, bc_e_b, bc_lr, &
193                       bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b, &
194             bc_q_t,bc_s_b, bc_s_t, bc_sa_t, bc_uv_b, bc_uv_t, &
195             bottom_salinityflux, building_height, building_length_x, &
196             building_length_y, building_wall_left, building_wall_south, &
197             call_psolver_at_all_substeps, canopy_mode, canyon_height, &
198             canyon_width_x, canyon_width_y, canyon_wall_left, &
199             canyon_wall_south, cfl_factor, cloud_droplets, cloud_physics, &
200             cloud_scheme, collective_wait, conserve_volume_flow, &
201             conserve_volume_flow_mode, coupling_start_time, cthf, &
202             curvature_solution_effects, cycle_mg, damp_level_1d, &
203             dissipation_1d, & !dissipation_control, &
204             dp_external, dp_level_b, dp_smooth, dpdxy, drag_coefficient, &
205             drizzle, dt, dt_pr_1d, dt_run_control_1d, dx, dy, dz, dz_max, & 
206             dz_stretch_factor, dz_stretch_level, e_init, e_min, end_time_1d, &
207             fft_method, galilei_transformation, humidity, &
208             inflow_damping_height, inflow_damping_width, &
209             inflow_disturbance_begin, inflow_disturbance_end, &
210             initializing_actions, km_constant, lad_surface, &
211             lad_vertical_gradient, lad_vertical_gradient_level, &
212             leaf_surface_concentration, &
213             loop_optimization, masking_method, mg_cycles, &
214             mg_switch_to_pe0_level, mixing_length_1d, momentum_advec, &
215             mu_constant, mu_constant_value, &
216             netcdf_precision, neutral, ngsrb, nr_surface, &
217             nr_surface_initial_change, nr_vertical_gradient, &
218             nr_vertical_gradient_level, nsor, &
219             nsor_ini, nx, ny, nz, ocean, omega, omega_sor, &
220             passive_scalar, pch_index, phi, plant_canopy, prandtl_layer, &
221             prandtl_number, precipitation, psolver, pt_damping_factor, &
222             pt_damping_width, pt_reference, pt_surface, &
223             pt_surface_initial_change, pt_vertical_gradient, &
224             pt_vertical_gradient_level, q_surface, q_surface_initial_change, &
225             q_vertical_gradient, q_vertical_gradient_level, &
226             qr_surface, qr_surface_initial_change, &
227             qr_vertical_gradient, qr_vertical_gradient_level, radiation, &
228             random_generator, random_heatflux, rayleigh_damping_factor, &
229             rayleigh_damping_height, recycling_width, residual_limit, &
230             rif_max, rif_min, roughness_length, sa_surface, &
231             sa_vertical_gradient, sa_vertical_gradient_level, scalar_advec, &
232             scalar_exchange_coefficient, scalar_rayleigh_damping, &
233             statistic_regions, subs_vertical_gradient, &
234             subs_vertical_gradient_level, surface_heatflux, surface_pressure, &
235             surface_scalarflux, surface_waterflux, surface_waterflux_nr, &
236             surface_waterflux_qr, s_surface, &
237             s_surface_initial_change, s_vertical_gradient, &
238             s_vertical_gradient_level, timestep_scheme, &
239             topography, topography_grid_convention, top_heatflux, &
240             top_momentumflux_u, top_momentumflux_v, top_salinityflux, &
241             turbulent_inflow, ug_surface, ug_vertical_gradient, &
242             ug_vertical_gradient_level, use_surface_fluxes, &
243             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke, &
244             uv_heights, u_bulk, u_profile, vg_surface, vg_vertical_gradient, &
245             vg_vertical_gradient_level, v_bulk, v_profile, ventilation_effect, &
246             wall_adjustment, wall_heatflux, wall_humidityflux, wall_scalarflux, &
247             z0h_factor
248     
249    NAMELIST /d3par/  averaging_interval, averaging_interval_pr, &
250             create_disturbances, &
251             cross_profiles, cross_ts_uymax, cross_ts_uymin, &
252             data_output, data_output_format, data_output_masks, &
253             data_output_pr, data_output_2d_on_each_pe, disturbance_amplitude, &
254             disturbance_energy_limit, disturbance_level_b, &
255             disturbance_level_t, do2d_at_begin, do3d_at_begin, do3d_compress, &
256             do3d_comp_prec, dt, dt_averaging_input, dt_averaging_input_pr, &
257             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb, &
258             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy, &
259             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart, &
260             dt_run_control,end_time, force_print_header, mask_scale_x, &
261             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop, &
262             mask_y_loop, mask_z_loop, netcdf_data_format, normalizing_region, &
263             npex, npey, nz_do3d, precipitation_amount_interval, &
264             profile_columns, profile_rows, restart_time, section_xy, &
265             section_xz, section_yz, skip_time_data_output, &
266             skip_time_data_output_av, skip_time_dopr, skip_time_do2d_xy, &
267             skip_time_do2d_xz, skip_time_do2d_yz, skip_time_do3d, &
268             skip_time_domask, synchronous_exchange, termination_time_needed, &
269             z_max_do2d
270
271
272    NAMELIST /envpar/  host, local_dvrserver_running, maximum_cpu_time_allowed,&
273                       maximum_parallel_io_streams, revision, return_addres, &
274                       return_username, run_identifier, tasks_per_node, &
275                       write_binary
276
277!
278!-- First read values of environment variables (this NAMELIST file is
279!-- generated by mrun)
280    OPEN ( 90, FILE='ENVPAR', STATUS='OLD', FORM='FORMATTED', ERR=30 )
281    READ ( 90, envpar, ERR=31, END=32 )
282    CLOSE ( 90 )
283
284!
285!-- Calculate the number of groups into which parallel I/O is split.
286!-- The default for files which are opened by all PEs (or where each
287!-- PE opens his own independent file) is, that all PEs are doing input/output
288!-- in parallel at the same time. This might cause performance or even more
289!-- severe problems depending on the configuration of the underlying file
290!-- system.
291!-- First, set the default:
292    IF ( maximum_parallel_io_streams == -1  .OR. &
293         maximum_parallel_io_streams > numprocs )  THEN
294       maximum_parallel_io_streams = numprocs
295    ENDIF
296!
297!-- Now calculate the number of io_blocks and the io_group to which the
298!-- respective PE belongs. I/O of the groups is done in serial, but in parallel
299!-- for all PEs belonging to the same group.
300!-- These settings are repeated in init_pegrid for the communicator comm2d,
301!-- which is not available here
302    io_blocks = numprocs / maximum_parallel_io_streams
303    io_group  = MOD( myid+1, io_blocks )
304
305!
306!-- Data is read in parallel by groups of PEs
307    DO  i = 0, io_blocks-1
308       IF ( i == io_group )  THEN
309
310!
311!--       Open the NAMELIST-file which is send with this job
312          CALL check_open( 11 )
313
314!
315!--       Read the control parameters for initialization.
316!--       The namelist "inipar" must be provided in the NAMELIST-file.
317          READ ( 11, inipar, ERR=10, END=11 )
318
319#if defined ( __check )
320!
321!--       In case of a namelist file check, &inipar from the p3d file is
322!--       used. The p3d file here must be closed and the p3df file for reading
323!--       3dpar is opened.
324          IF ( check_restart == 1 )  THEN
325             CALL close_file( 11 )
326             check_restart = 2
327             CALL check_open( 11 )             
328             initializing_actions = 'read_restart_data'
329          ENDIF
330#endif
331          GOTO 12
332
333 10       message_string = 'errors in \$inipar &or no \$inipar-namelist ' // &
334                           'found (CRAY-machines only)'
335          CALL message( 'parin', 'PA0271', 1, 2, 0, 6, 0 )
336
337 11       message_string = 'no \$inipar-namelist found'
338          CALL message( 'parin', 'PA0272', 1, 2, 0, 6, 0 )
339
340!
341!--       If required, read control parameters from restart file (produced by
342!--       a prior run). All PEs are reading from file created by PE0 (see
343!--       check_open)
344 12       IF ( TRIM( initializing_actions ) == 'read_restart_data' )  THEN
345#if ! defined ( __check )
346             CALL read_var_list
347!
348!--          The restart file will be reopened when reading the subdomain data
349             CALL close_file( 13 )
350
351!
352!--          Increment the run count
353             runnr = runnr + 1
354#endif
355          ENDIF
356
357!
358!--       Definition of names of areas used for computing statistics. They must
359!--       be defined at this place, because they are allowed to be redefined by
360!--       the user in user_parin.
361          region = 'total domain'
362
363!
364!--       Read runtime parameters given by the user for this run (namelist
365!--       "d3par"). The namelist "d3par" can be omitted. In that case, default
366!--       values are used for the parameters.
367          READ ( 11, d3par, END=20 )
368
369!
370!--       Read control parameters for optionally used model software packages
371 20       CALL package_parin
372
373!
374!--       Read user-defined variables
375          CALL user_parin
376
377!
378!--       Check in case of initial run, if the grid point numbers are well
379!--       defined and allocate some arrays which are already needed in
380!--       init_pegrid or check_parameters. During restart jobs, these arrays
381!--       will be allocated in read_var_list. All other arrays are allocated
382!--       in init_3d_model.
383          IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
384
385             IF ( nx <= 0 )  THEN
386                WRITE( message_string, * ) 'no value or wrong value given', &
387                                           ' for nx: nx=', nx
388                CALL message( 'parin', 'PA0273', 1, 2, 0, 6, 0 )
389             ENDIF
390             IF ( ny <= 0 )  THEN
391                WRITE( message_string, * ) 'no value or wrong value given', &
392                                           ' for ny: ny=', ny
393                CALL message( 'parin', 'PA0274', 1, 2, 0, 6, 0 )
394             ENDIF
395             IF ( nz <= 0 )  THEN
396                WRITE( message_string, * ) 'no value or wrong value given', &
397                                           ' for nz: nz=', nz
398                CALL message( 'parin', 'PA0275', 1, 2, 0, 6, 0 )
399             ENDIF
400!
401!--          ATTENTION: in case of changes to the following statement please
402!--                  also check the allocate statement in routine read_var_list
403             ALLOCATE( lad(0:nz+1),pt_init(0:nz+1), q_init(0:nz+1),           &
404                       qr_init(0:nz+1), nr_init(0:nz+1),                      &
405                       sa_init(0:nz+1), ug(0:nz+1), u_init(0:nz+1),           &
406                       v_init(0:nz+1), vg(0:nz+1),                            &
407                       hom(0:nz+1,2,pr_palm+max_pr_user,0:statistic_regions), &
408                       hom_sum(0:nz+1,pr_palm+max_pr_user,0:statistic_regions) )
409
410             hom = 0.0
411
412          ENDIF
413
414!
415!--       NAMELIST-file is not needed anymore
416          CALL close_file( 11 )
417
418       ENDIF
419#if defined( __parallel ) && ! ( __check )
420       CALL MPI_BARRIER( MPI_COMM_WORLD, ierr )
421#endif
422    ENDDO
423
424    RETURN
425
426 30 message_string = 'local file ENVPAR not found' // &
427                     '&some variables for steering may not be properly set'
428    CALL message( 'parin', 'PA0276', 0, 1, 0, 6, 0 )
429    RETURN
430
431 31 message_string = 'errors in local file ENVPAR' // &
432                     '&some variables for steering may not be properly set'
433    CALL message( 'parin', 'PA0277', 0, 1, 0, 6, 0 )
434    RETURN
435
436 32 message_string = 'no envpar-NAMELIST found in local file ENVPAR'  // &
437                     '&some variables for steering may not be properly set'
438    CALL message( 'parin', 'PA0278', 0, 1, 0, 6, 0 )
439
440 END SUBROUTINE parin
Note: See TracBrowser for help on using the repository browser.