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

Last change on this file since 623 was 623, checked in by raasch, 11 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 12.9 KB
Line 
1 SUBROUTINE parin
2
3!------------------------------------------------------------------------------!
4! Current revisions:
5! -----------------
6!
7!
8! Former revisions:
9! -----------------
10! $Id: parin.f90 623 2010-12-10 08:52:17Z raasch $
11!
12! 622 2010-12-10 08:08:13Z raasch
13! +collective_wait in inipar
14!
15! 600 2010-11-24 16:10:51Z raasch
16! parameters moved from d3par to inipar: call_psolver_at_all_substeps,
17! cfl_factor, cycle_mg, mg_cycles, mg_switch_to_pe0_level, ngsrb, nsor,
18! omega_sor, prandtl_number, psolver, rayleigh_damping_factor,
19! rayleigh_damping_height, residual_limit
20!
21! 580 2010-10-05 13:59:11Z heinze
22! Renaming of ws_vertical_gradient to subs_vertical_gradient and
23! ws_vertical_gradient_level to subs_vertical_gradient_level
24!
25! 553 2010-09-01 14:09:06Z weinreis
26! parameters for masked output are replaced by arrays
27!
28! 493 2010-03-01 08:30:24Z raasch
29! +netcdf_data_format in d3par, -netcdf_64bit, -netcdf_64bit_3d
30!
31! 449 2010-02-02 11:23:59Z raasch
32! +wall_humidityflux, wall_scalarflux
33! +ws_vertical_gradient, ws_vertical_gradient_level
34!
35! 410 2009-12-04 17:05:40Z letzel
36! masked data output: + dt_domask, mask_01~20_x|y|z, mask_01~20_x|y|z_loop,
37! mask_scale_x|y|z, masks, skip_time_domask
38!
39! 291 2009-04-16 12:07:26Z raasch
40! +local_dvrserver_running in envpar
41! Output of messages replaced by message handling routine.
42! +canyon_height, canyon_width_x, canyon_width_y, canyon_wall_left,
43! canyon_wall_south, conserve_volume_flow_mode, coupling_start_time,
44! dp_external, dp_level_b, dp_smooth, dpdxy, u_bulk, v_bulk in inipar
45! topography_grid_convention moved from userpar
46!
47! 197 2008-09-16 15:29:03Z raasch
48! +cthf,leaf_surface_concentration, scalar_exchange_coefficient
49! +inflow_damping_height, inflow_damping_width, recycling_width,
50! turbulent_inflow in inipar, -skip_time_dosp in d3par,
51! allocation of hom_sum moved from init_3d_model to here,
52! npex, npey moved from inipar to d3par, setting of myid_char_14 removed,
53! lad is allways allocated
54!
55! 138 2007-11-28 10:03:58Z letzel
56! +canopy_mode, drag_coefficient, lad_surface, lad_vertical_gradient,
57! lad_vertical_gradient_level, pch_index, plant_canopy,
58! +allocation of leaf area density field
59!
60! 108 2007-08-24 15:10:38Z letzel
61! +e_init, top_momentumflux_u|v in inipar, +dt_coupling in d3par
62!
63! 95 2007-06-02 16:48:38Z raasch
64! +bc_sa_t, bottom_salinityflux, ocean, sa_surface, sa_vertical_gradient,
65! sa_vertical_gradient_level, top_salinityflux in inipar,
66! sa_init is allocated
67!
68! 87 2007-05-22 15:46:47Z raasch
69! Size of hom increased by the maximum number of user-defined profiles,
70! var_hom renamed pr_palm
71!
72! 82 2007-04-16 15:40:52Z raasch
73! +return_addres, return_username in envpar
74!
75! 75 2007-03-22 09:54:05Z raasch
76! +dt_max, netcdf_64bit_3d, precipitation_amount_interval in d3par,
77! +loop_optimization, pt_reference in inipar, -data_output_ts,
78! moisture renamed humidity
79!
80! 20 2007-02-26 00:12:32Z raasch
81! +top_heatflux, use_top_fluxes in inipar
82!
83! 3 2007-02-13 11:30:58Z raasch
84! +netcdf_64bit_3d in d3par,
85! RCS Log replace by Id keyword, revision history cleaned up
86!
87! Revision 1.57  2007/02/11 13:11:22  raasch
88! Values of environment variables are now read from file ENVPAR instead of
89! reading them with a system call, + NAMELIST envpar
90!
91! Revision 1.1  1997/07/24 11:22:50  raasch
92! Initial revision
93!
94!
95! Description:
96! ------------
97! This subroutine reads variables controling the run from the NAMELIST files
98!------------------------------------------------------------------------------!
99
100    USE arrays_3d
101    USE averaging
102    USE control_parameters
103    USE dvrp_variables
104    USE grid_variables
105    USE indices
106    USE model_1d
107    USE pegrid
108    USE profil_parameter
109    USE statistics
110
111    IMPLICIT NONE
112
113    INTEGER ::  idum
114
115
116    NAMELIST /inipar/  adjust_mixing_length, alpha_surface, bc_e_b, bc_lr, &
117                       bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b, &
118             bc_q_t,bc_s_b, bc_s_t, bc_sa_t, bc_uv_b, bc_uv_t, &
119             bottom_salinityflux, building_height, building_length_x, &
120             building_length_y, building_wall_left, building_wall_south, &
121             call_psolver_at_all_substeps, canopy_mode, canyon_height, &
122             canyon_width_x, canyon_width_y, canyon_wall_left, &
123             canyon_wall_south, cfl_factor, cloud_droplets, cloud_physics, &
124             collective_wait, conserve_volume_flow, conserve_volume_flow_mode, &
125             coupling_start_time, cthf, cut_spline_overshoot, &
126             cycle_mg, damp_level_1d, dissipation_1d, dp_external, dp_level_b, &
127             dp_smooth, dpdxy, drag_coefficient, dt, dt_pr_1d, &
128             dt_run_control_1d, dx, dy, dz, dz_max, dz_stretch_factor, & 
129             dz_stretch_level, e_init, e_min, end_time_1d, fft_method, &
130             galilei_transformation, grid_matching, humidity, &
131             inflow_damping_height, inflow_damping_width, &
132             inflow_disturbance_begin, inflow_disturbance_end, &
133             initializing_actions, km_constant, km_damp_max, lad_surface, &
134             lad_vertical_gradient, lad_vertical_gradient_level, &
135             leaf_surface_concentration, long_filter_factor, &
136             loop_optimization, mg_cycles, mg_switch_to_pe0_level, &
137             mixing_length_1d, momentum_advec, netcdf_precision, ngsrb, nsor, &
138             nsor_ini, nx, ny, nz, ocean, omega, omega_sor, &
139             outflow_damping_width, overshoot_limit_e, overshoot_limit_pt, &
140             overshoot_limit_u, overshoot_limit_v, overshoot_limit_w, &
141             passive_scalar, pch_index, phi, plant_canopy, prandtl_layer, &
142             prandtl_number, precipitation, psolver, pt_reference, pt_surface, &
143             pt_surface_initial_change, pt_vertical_gradient, &
144             pt_vertical_gradient_level, q_surface, q_surface_initial_change, &
145             q_vertical_gradient, q_vertical_gradient_level, radiation, &
146             random_generator, random_heatflux, rayleigh_damping_factor, &
147             rayleigh_damping_height, recycling_width, residual_limit, &
148             rif_max, rif_min, roughness_length, sa_surface, &
149             sa_vertical_gradient, sa_vertical_gradient_level, scalar_advec, &
150             scalar_exchange_coefficient, statistic_regions, &
151             subs_vertical_gradient, subs_vertical_gradient_level, &
152             surface_heatflux, surface_pressure, surface_scalarflux, &
153             surface_waterflux, s_surface, s_surface_initial_change, &
154             s_vertical_gradient, s_vertical_gradient_level, timestep_scheme, &
155             topography, topography_grid_convention, top_heatflux, &
156             top_momentumflux_u, top_momentumflux_v, top_salinityflux, &
157             turbulent_inflow, ug_surface, ug_vertical_gradient, &
158             ug_vertical_gradient_level, u_bulk, ups_limit_e, ups_limit_pt, &
159             ups_limit_u, ups_limit_v, ups_limit_w, use_surface_fluxes, &
160             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke, &
161             vg_surface, vg_vertical_gradient, vg_vertical_gradient_level, &
162             v_bulk, wall_adjustment, wall_heatflux, wall_humidityflux, &
163             wall_scalarflux
164
165
166    NAMELIST /d3par/  averaging_interval, averaging_interval_pr, &
167             create_disturbances, cross_normalized_x, cross_normalized_y, &
168             cross_profiles, cross_ts_uymax, cross_ts_uymin, cross_xtext, &
169             data_output, data_output_format, data_output_masks, &
170             data_output_pr, data_output_2d_on_each_pe, disturbance_amplitude, &
171             disturbance_energy_limit, disturbance_level_b, &
172             disturbance_level_t, do2d_at_begin, do3d_at_begin, do3d_compress, &
173             do3d_comp_prec, dt, dt_averaging_input, dt_averaging_input_pr, &
174             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb, &
175             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy, &
176             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart, &
177             dt_run_control,end_time, force_print_header, mask_scale_x, &
178             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop, &
179             mask_y_loop, mask_z_loop, netcdf_data_format, &
180             normalizing_region, npex, npey, nz_do3d, &
181             precipitation_amount_interval, profile_columns, profile_rows, &
182             restart_time, section_xy, section_xz, section_yz, &
183             skip_time_data_output, skip_time_data_output_av, skip_time_dopr, &
184             skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz, &
185             skip_time_do3d, skip_time_domask, termination_time_needed, &
186             use_prior_plot1d_parameters, z_max_do1d, z_max_do1d_normalized, &
187             z_max_do2d
188
189
190    NAMELIST /envpar/  host, local_dvrserver_running, maximum_cpu_time_allowed,  &
191                       revision, return_addres, return_username, run_identifier, &
192                       tasks_per_node, write_binary
193
194!
195!-- Open the NAMELIST-file which is send with this job
196    CALL check_open( 11 )
197
198!
199!-- Read the control parameters for initialization.
200!-- The namelist "inipar" must be provided in the NAMELIST-file. If this is
201!-- not the case and the file contains - instead of "inipar" - any other
202!-- namelist, a read error is created on t3e and control is transferred
203!-- to the statement with label 10. Therefore, on t3e machines one can not
204!-- distinguish between errors produced by a wrong "inipar" namelist or
205!-- because this namelist is totally missing.
206    READ ( 11, inipar, ERR=10, END=11 )
207    GOTO 12
208 10 message_string = 'errors in \$inipar &or no \$inipar-namelist ' // &
209                     'found (CRAY-machines only)'
210    CALL message( 'parin', 'PA0271', 1, 2, 0, 6, 0 )
211
212 11 message_string = 'no \$inipar-namelist found'
213    CALL message( 'parin', 'PA0272', 1, 2, 0, 6, 0 )
214
215!
216!-- If required, read control parameters from restart file (produced by
217!-- a prior run). All PEs are reading from file created by PE0 (see check_open)
218 12 IF ( TRIM( initializing_actions ) == 'read_restart_data' )  THEN
219
220       CALL read_var_list
221!
222!--    The restart file will be reopened when reading the subdomain data
223       CALL close_file( 13 )
224
225!
226!--    Increment the run count
227       runnr = runnr + 1
228
229    ENDIF
230
231!
232!-- Definition of names of areas used for computing statistics. They must
233!-- be defined at this place, because they are allowed to be redefined by
234!-- the user in user_parin.
235    region = 'total domain'
236
237!
238!-- Read runtime parameters given by the user for this run (namelist "d3par").
239!-- The namelist "d3par" can be omitted. In that case, default values are
240!-- used for the parameters.
241    READ ( 11, d3par, END=20 )
242
243!
244!-- Read control parameters for optionally used model software packages
245 20 CALL package_parin
246
247!
248!-- Read user-defined variables
249    CALL user_parin
250
251!
252!-- Check in case of initial run, if the grid point numbers are well defined
253!-- and allocate some arrays which are already needed in init_pegrid or
254!-- check_parameters. During restart jobs, these arrays will be allocated
255!-- in read_var_list. All other arrays are allocated in init_3d_model.
256    IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
257
258       IF ( nx <= 0 )  THEN
259          WRITE( message_string, * ) 'no value or wrong value given for nx: ',&
260                                     'nx=', nx
261          CALL message( 'parin', 'PA0273', 1, 2, 0, 6, 0 )
262       ENDIF
263       IF ( ny <= 0 )  THEN
264          WRITE( message_string, * ) 'no value or wrong value given for ny: ',&
265                                     'ny=', ny
266          CALL message( 'parin', 'PA0274', 1, 2, 0, 6, 0 )
267       ENDIF
268       IF ( nz <= 0 )  THEN
269          WRITE( message_string, * ) 'no value or wrong value given for nz: ',&
270                                     'nz=', nz
271          CALL message( 'parin', 'PA0275', 1, 2, 0, 6, 0 )
272       ENDIF
273!
274!--    ATTENTION: in case of changes to the following statement please also
275!--    check the allocate statement in routine read_var_list
276       ALLOCATE( lad(0:nz+1),pt_init(0:nz+1), q_init(0:nz+1), sa_init(0:nz+1), &
277                 ug(0:nz+1), u_init(0:nz+1), v_init(0:nz+1), vg(0:nz+1),       &
278                 hom(0:nz+1,2,pr_palm+max_pr_user,0:statistic_regions),        &
279                 hom_sum(0:nz+1,pr_palm+max_pr_user,0:statistic_regions) )
280       hom = 0.0
281
282    ENDIF
283
284!
285!-- NAMELIST-file is not needed anymore
286    CALL close_file( 11 )
287
288!
289!-- Read values of environment variables (this NAMELIST file is generated by
290!-- mrun)
291    OPEN ( 90, FILE='ENVPAR', STATUS='OLD', FORM='FORMATTED', ERR=30 )
292    READ ( 90, envpar, ERR=31, END=32 )
293    CLOSE ( 90 )
294    RETURN
295
296 30 message_string = 'local file ENVPAR not found' // &
297                     '&some variables for steering may not be properly set'
298    CALL message( 'parin', 'PA0276', 0, 1, 0, 6, 0 )
299    RETURN
300
301 31 message_string = 'errors in local file ENVPAR' // &
302                     '&some variables for steering may not be properly set'
303    CALL message( 'parin', 'PA0277', 0, 1, 0, 6, 0 )
304    RETURN
305
306 32 message_string = 'no envpar-NAMELIST found in local file ENVPAR'  // &
307                     '&some variables for steering may not be properly set'
308    CALL message( 'parin', 'PA0278', 0, 1, 0, 6, 0 )
309
310 END SUBROUTINE parin
Note: See TracBrowser for help on using the repository browser.