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

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

last commit documented

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