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

Last change on this file since 1017 was 1017, checked in by raasch, 9 years ago

last commit documented

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