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

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

last commit documented

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