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

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

code has been put under the GNU General Public License (v3)

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