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

Last change on this file since 768 was 768, checked in by raasch, 11 years ago

last commit documented

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