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

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

last commit documented

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