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

Last change on this file since 1128 was 1128, checked in by raasch, 9 years ago

asynchronous transfer of ghost point data for acc-optimized version

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