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

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

r1028 documented

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