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

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