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

Last change on this file since 808 was 808, checked in by maronga, 10 years ago

last commit documented

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