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

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

Nudging and large scale forcing from external file implemented

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