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

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

last commit documented

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