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

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