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

Last change on this file since 818 was 810, checked in by maronga, 13 years ago

last commit documented

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