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

Last change on this file since 1054 was 1054, checked in by hoffmann, 9 years ago

last commit documented

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