source: palm/trunk/SOURCE/package_parin.f90 @ 3046

Last change on this file since 3046 was 3046, checked in by Giersch, 3 years ago

Remaining error messages revised, comments extended

  • Property svn:keywords set to Id
File size: 15.3 KB
Line 
1!> @file package_parin.f90
2!------------------------------------------------------------------------------!
3! This file is part of the PALM model system.
4!
5! PALM is free software: you can redistribute it and/or modify it under the
6! terms of the GNU General Public License as published by the Free Software
7! Foundation, either version 3 of the License, or (at your option) any later
8! 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-2018 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22! Error messages revised
23!
24! Former revisions:
25! -----------------
26! $Id: package_parin.f90 3046 2018-05-29 08:02:15Z Giersch $
27! renamed particles_par to particle_parameters
28!
29! 2718 2018-01-02 08:49:38Z maronga
30! Corrected "Former revisions" section
31!
32! 2696 2017-12-14 17:12:51Z kanani
33! Change in file header (GPL part)
34!
35! 2375 2017-08-29 14:10:28Z schwenkel
36! Added aerosol_species
37!
38! 2312 2017-07-14 20:26:51Z hoffmann
39! Aerosol initialization improved.
40!
41! 2263 2017-06-08 14:59:01Z schwenkel
42! Implemented splitting and merging algorithm
43!
44! 2183 2017-03-17 14:29:15Z schwenkel
45!
46! 2182 2017-03-17 14:27:40Z schwenkel
47! Added parameters for simplified particle initialization.
48!
49! 2000 2016-08-20 18:09:15Z knoop
50! Forced header and separation lines into 80 columns
51!
52! 1936 2016-06-13 13:37:44Z suehring
53! +deallocate_memory, step_dealloc
54!
55! 1871 2016-04-15 11:46:09Z hoffmann
56! Initialization of aerosols added.
57!
58! 1833 2016-04-07 14:23:03Z raasch
59! reading of spectra_par moved to spectra_mod
60!
61! 1831 2016-04-07 13:15:51Z hoffmann
62! curvature_solution_effects added
63!
64! 1826 2016-04-07 12:01:39Z maronga
65! Reading of &radiation_par moved to radiation_model_mod.
66! Reading of &canopy_par moved to plant_canopy_model_mod.
67!
68! 822 2016-04-07 07:49:42Z hoffmann
69! +collision_algorithm
70! Tails removed.
71!
72! 1817 2016-04-06 15:44:20Z maronga
73! Reading of &lsm_par moved to land_surface_model_mod.
74!
75! 1788 2016-03-10 11:01:04Z maronga
76! Parameter dewfall removed.
77!
78! 1786 2016-03-08 05:49:27Z raasch
79! cpp-direktives for spectra removed
80!
81! 1757 2016-02-22 15:49:32Z maronga
82! Added parameter unscheduled_radiation_calls
83!
84! 1691 2015-10-26 16:17:44Z maronga
85! Added skip_time_do_lsm, skip_time_do_radiation, and emissivity
86!
87! 1682 2015-10-07 23:56:08Z knoop
88! Code annotations made doxygen readable
89!
90! 1585 2015-04-30 07:05:52Z maronga
91! Added several radiation_par parameters
92!
93! 1575 2015-03-27 09:56:27Z raasch
94! +seed_follows_topography in particles_par
95!
96! 1553 2015-03-03 17:33:54Z maronga
97! Resorting of lsm_par
98!
99! 1551 2015-03-03 14:18:16Z maronga
100! Several changes in the liste for land surface model and radiation model
101!
102! 1496 2014-12-02 17:25:50Z maronga
103! Added support for the land surface model and radiation scheme
104!
105! 1484 2014-10-21 10:53:05Z kanani
106! Changes due to new module structure of the plant canopy model:
107!   module plant_canopy_model_mod added,
108!   new package/namelist canopy_par added, i.e. the canopy model is no longer
109!   steered over the inipar-namelist,
110!   drag_coefficient, leaf_surface_concentration and scalar_exchange_coefficient
111!   renamed to canopy_drag_coeff, leaf_surface_conc and leaf_scalar_exch_coeff.
112! Changed statement tags in CONTINUE-statement
113!
114! 1367 2014-04-23 15:18:30Z witha
115! Bugfix: module kinds must be used
116!
117! 1359 2014-04-11 17:15:14Z hoffmann
118! +alloc_factor, + min_nr_particle
119! -dt_sort_particles, -maximum_number_of_particles
120!
121! 1340 2014-03-25 19:45:13Z kanani
122! REAL constants defined as wp-kinds
123!
124! 1324 2014-03-21 09:13:16Z suehring
125! Bugfix: Missing variable dt_data_output output added to ONLY statement
126!
127! 1320 2014-03-20 08:40:49Z raasch
128! ONLY-attribute added to USE-statements,
129! kind-parameters added to all INTEGER and REAL declaration statements,
130! kinds are defined in new module kinds,
131! old module precision_kind is removed,
132! revision history before 2012 removed,
133! comment fields (!:) to be used for variable explanations added to
134! all variable declaration statements
135!
136! 1036 2012-10-22 13:43:42Z raasch
137! code put under GPL (PALM 3.9)
138!
139! 828 2012-02-21 12:00:36Z raasch
140! +dissipation_classes, radius_classes in parpar
141!
142! 825 2012-02-19 03:03:44Z raasch
143! wang_collision_kernel and turbulence_effects_on_collision in particles_par
144! replaced by collision_kernel
145!
146! Revision 1.1  2000/12/28 13:21:57  raasch
147! Initial revision
148!
149!
150! Description:
151! ------------
152!> This subroutine reads from the NAMELIST file variables controling model
153!> software packages which are used optionally in the run.
154!>
155!> @todo Perform all actions in the respective submodules and remove
156!>       package_parin
157!------------------------------------------------------------------------------!
158 SUBROUTINE package_parin
159
160
161    USE control_parameters,                                                    &
162        ONLY:  dt_data_output, dt_dopts, dt_dvrp, message_string,              &
163               particle_maximum_age, threshold
164
165    USE dvrp_variables,                                                        &
166        ONLY:  clip_dvrp_l, clip_dvrp_n, clip_dvrp_r, clip_dvrp_s,             &
167               cluster_size, color_interval, dvrpsize_interval,                &
168               dvrp_directory, dvrp_file, dvrp_host, dvrp_output,              &
169               dvrp_password, dvrp_username, groundplate_color,                &
170               isosurface_color, mode_dvrp, particle_color,                    &
171               particle_dvrpsize, pathlines_fadeintime,                        &
172               pathlines_fadeouttime, pathlines_linecount,                     &
173               pathlines_maxhistory, pathlines_wavecount,                      &
174               pathlines_wavetime, slicer_range_limits_dvrp, superelevation,   &
175               superelevation_x, superelevation_y, topography_color,           &
176               vc_alpha, vc_gradient_normals, vc_mode, vc_size_x, vc_size_y,   &
177               vc_size_z
178
179    USE kinds
180
181    USE particle_attributes,                                                   &
182        ONLY:  aero_species, aero_type, aero_weight, alloc_factor, bc_par_b,   &
183               bc_par_lr, bc_par_ns, bc_par_t, collision_kernel,               &
184               curvature_solution_effects, deallocate_memory, density_ratio,   &
185               dissipation_classes, dt_min_part, dt_prel,                      &
186               dt_write_particle_data, end_time_prel, initial_weighting_factor,&
187               log_sigma, max_number_particles_per_gridbox,                    &
188               merging, min_nr_particle, na,                                   &
189               number_concentration, number_of_particle_groups,                &
190               number_particles_per_gridbox, particles_per_point,              &
191               particle_advection, particle_advection_start, pdx, pdy, pdz,    &
192               psb, psl, psn, psr, pss, pst, radius, radius_classes,           &
193               radius_merge, radius_split, random_start_position,              &
194               read_particles_from_restartfile, rm,                            &
195               seed_follows_topography, splitting, splitting_factor,           &
196               splitting_factor_max, splitting_function, splitting_mode,       &
197               step_dealloc, use_sgs_for_particles,                            &
198               vertical_particle_advection, weight_factor_merge,               &
199               weight_factor_split, write_particle_statistics
200
201    IMPLICIT NONE
202
203    CHARACTER (LEN=80) ::  line  !<
204
205
206
207    NAMELIST /dvrp_graphics_par/  clip_dvrp_l, clip_dvrp_n, clip_dvrp_r,       &
208                                  clip_dvrp_s, cluster_size, color_interval,   &
209                                  dt_dvrp, dvrpsize_interval, dvrp_directory,  &
210                                  dvrp_file, dvrp_host, dvrp_output,           &
211                                  dvrp_password, dvrp_username,                &
212                                  groundplate_color, isosurface_color,         &
213                                  mode_dvrp, particle_color, particle_dvrpsize,&
214                                  pathlines_fadeintime, pathlines_fadeouttime, &
215                                  pathlines_linecount, pathlines_maxhistory,   &
216                                  pathlines_wavecount, pathlines_wavetime,     &
217                                  slicer_range_limits_dvrp, superelevation,    &
218                                  superelevation_x, superelevation_y,          &
219                                  threshold, topography_color, vc_alpha,       &
220                                  vc_gradient_normals, vc_mode, vc_size_x,     &
221                                  vc_size_y, vc_size_z
222
223    NAMELIST /particles_par/      aero_species, aero_type, aero_weight,        &
224                                  alloc_factor, bc_par_b, bc_par_lr,           &
225                                  bc_par_ns, bc_par_t,                         &
226                                  collision_kernel, curvature_solution_effects,&
227                                  deallocate_memory, density_ratio,            &
228                                  dissipation_classes, dt_dopts,               &
229                                  dt_min_part, dt_prel,                        &
230                                  dt_write_particle_data,                      &
231                                  end_time_prel, initial_weighting_factor,     &
232                                  log_sigma,                                   &
233                                  max_number_particles_per_gridbox, merging,   &
234                                  min_nr_particle,                             &
235                                  na, number_concentration,                    &
236                                  number_of_particle_groups,                   &
237                                  number_particles_per_gridbox,                &
238                                  particles_per_point,                         &
239                                  particle_advection_start,                    &
240                                  particle_maximum_age, pdx, pdy, pdz, psb,    &
241                                  psl, psn, psr, pss, pst, radius,             &
242                                  radius_classes, radius_merge, radius_split,  &
243                                  random_start_position,                       &
244                                  read_particles_from_restartfile, rm,         &
245                                  seed_follows_topography,                     &
246                                  splitting, splitting_factor,                 &
247                                  splitting_factor_max, splitting_function,    &
248                                  splitting_mode, step_dealloc,                &
249                                  use_sgs_for_particles,                       &
250                                  vertical_particle_advection,                 &
251                                  weight_factor_merge, weight_factor_split,    &
252                                  write_particle_statistics
253
254                                 
255    NAMELIST /particle_parameters/                                             &
256                                  aero_species, aero_type, aero_weight,        &
257                                  alloc_factor, bc_par_b, bc_par_lr,           &
258                                  bc_par_ns, bc_par_t,                         &
259                                  collision_kernel, curvature_solution_effects,&
260                                  deallocate_memory, density_ratio,            &
261                                  dissipation_classes, dt_dopts,               &
262                                  dt_min_part, dt_prel,                        &
263                                  dt_write_particle_data,                      &
264                                  end_time_prel, initial_weighting_factor,     &
265                                  log_sigma,                                   &
266                                  max_number_particles_per_gridbox, merging,   &
267                                  min_nr_particle,                             &
268                                  na, number_concentration,                    &
269                                  number_of_particle_groups,                   &
270                                  number_particles_per_gridbox,                &
271                                  particles_per_point,                         &
272                                  particle_advection_start,                    &
273                                  particle_maximum_age, pdx, pdy, pdz, psb,    &
274                                  psl, psn, psr, pss, pst, radius,             &
275                                  radius_classes, radius_merge, radius_split,  &
276                                  random_start_position,                       &
277                                  read_particles_from_restartfile, rm,         &
278                                  seed_follows_topography,                     &
279                                  splitting, splitting_factor,                 &
280                                  splitting_factor_max, splitting_function,    &
281                                  splitting_mode, step_dealloc,                &
282                                  use_sgs_for_particles,                       &
283                                  vertical_particle_advection,                 &
284                                  weight_factor_merge, weight_factor_split,    &
285                                  write_particle_statistics
286!
287!-- Position the namelist-file at the beginning (it was already opened in
288!-- parin), search for the namelist-group of the package and position the
289!-- file at this line. Do the same for each optionally used package.
290    line = ' '
291
292
293#if defined( __dvrp_graphics )
294    REWIND ( 11 )
295    line = ' '
296    DO   WHILE ( INDEX( line, '&dvrp_graphics_par' ) == 0 )
297       READ ( 11, '(A)', END=20 )  line
298    ENDDO
299    BACKSPACE ( 11 )
300
301!
302!-- Read user-defined namelist
303    READ ( 11, dvrp_graphics_par )
304
305 20 CONTINUE
306#endif
307
308!
309!-- Try to find particles package
310    REWIND ( 11 )
311    line = ' '
312    DO   WHILE ( INDEX( line, '&particle_parameters' ) == 0 )
313       READ ( 11, '(A)', END=30 )  line
314    ENDDO
315    BACKSPACE ( 11 )
316
317!
318!-- Read user-defined namelist
319    READ ( 11, particle_parameters )
320
321!
322!-- Set flag that indicates that particles are switched on
323    particle_advection = .TRUE.
324   
325    GOTO 31
326
327!
328!-- Try to find particles package (old namelist)
32930  REWIND ( 11 )
330    line = ' '
331    DO   WHILE ( INDEX( line, '&particles_par' ) == 0 )
332       READ ( 11, '(A)', END=31 )  line
333    ENDDO
334    BACKSPACE ( 11 )
335
336!
337!-- Read user-defined namelist
338    READ ( 11, particles_par )
339   
340   
341    message_string = 'namelist particles_par is deprecated and will be ' //    &
342                     'removed in near future. Please use namelist ' //         &
343                     'particle_parameters instead'
344    CALL message( 'package_parin', 'PA0487', 0, 1, 0, 6, 0 )
345
346!
347!-- Set flag that indicates that particles are switched on
348    particle_advection = .TRUE.
349
350 31 CONTINUE
351
352 END SUBROUTINE package_parin
Note: See TracBrowser for help on using the repository browser.