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

Last change on this file since 1159 was 1159, checked in by fricke, 8 years ago

Bugfix: In case of non-cyclic lateral boundary conditions, Neumann boundary conditions for the velocity components at the outflow are in fact radiation boundary conditions using the maximum phase velocity that ensures numerical stability (CFL-condition).
Logical operator use_cmax is now used instead of bc_lr_dirneu/_neudir.

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