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

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

adding large_scale_subsidence

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