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

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

cloud physics: rain sedimentation and turbulence effects

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