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

Last change on this file since 1196 was 1196, checked in by heinze, 8 years ago

last commit documented

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