source: palm/trunk/SOURCE/palm.f90 @ 3274

Last change on this file since 3274 was 3274, checked in by knoop, 3 years ago

Modularization of all bulk cloud physics code components

  • Property svn:keywords set to Id
File size: 18.6 KB
Line 
1!> @file palm.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!
23!
24! Former revisions:
25! -----------------
26! $Id: palm.f90 3274 2018-09-24 15:42:55Z knoop $
27! Modularization of all bulk cloud physics code components
28!
29! 3258 2018-09-18 07:23:31Z Giersch
30! current revision for user interface has been changed to 3240
31!
32! 3241 2018-09-12 15:02:00Z raasch
33! unused variables removed
34!
35! 3235 2018-09-07 14:06:15Z sward
36! Added mas_last_actions call and multi_agent_system_mod dependency
37!
38! 3232 2018-09-07 12:21:44Z raasch
39! references to mrun replaced by palmrun, and updated
40!
41! 3182 2018-07-27 13:36:03Z suehring
42! Deduct spinup_time from RUN_CONTROL output of main 3d run
43! (use time_since_reference_point instead of simulated_time)
44!
45! 2951 2018-04-06 09:05:08Z kanani
46! Add log_point_s for pmci_init
47!
48! 2903 2018-03-16 08:17:06Z hellstea
49! Nesting-related calls to pmci_ensure_nest_mass_conservation and pres after
50! the nest initialization are removed as they may create unwanted initial
51! perturbation in some cases.
52!
53! 2894 2018-03-15 09:17:58Z Giersch
54! Modified todo list, _write_restart_data/_last_actions has been renamed to
55! _wrd_local, unit 14 will be opened now for each io_group
56! write_3d_binary is called wrd_local now, wrd_global moved from wrd_local to
57! palm.f90, unit 14 is closed directly after the wrd_local call, Module related
58! routines for writing restart data have been moved to wrd_local
59!
60! 2801 2018-02-14 16:01:55Z suehring
61! Changed lpm from subroutine to module.
62! Introduce particle transfer in nested models.
63!
64! 2766 2018-01-22 17:17:47Z kanani
65! Removed preprocessor directive __chem
66!
67! 2720 2018-01-02 16:27:15Z kanani
68! Version update to 5.0
69!
70! 2718 2018-01-02 08:49:38Z maronga
71! Corrected "Former revisions" section
72!
73! 2696 2017-12-14 17:12:51Z kanani
74! Change in file header (GPL part)
75! Implementation of chemistry module (FK)
76! Introduce input-data standard
77! Rename lsm_last_actions into lsm_write_restart_data
78! Move usm_write_restart_data into io_blocks loop (MS)
79!
80! 2512 2017-10-04 08:26:59Z raasch
81! user interface required revision updated
82!
83! 2320 2017-07-21 12:47:43Z suehring
84! Modularize large-scale forcing and nudging
85!
86! 2298 2017-06-29 09:28:18Z raasch
87! type of write_binary changed from CHARACTER to LOGICAL,
88! user interface required revision updated, MPI2 related part removed
89!
90! 2296 2017-06-28 07:53:56Z maronga
91! Added call to new spinup routine
92!
93! 2292 2017-06-20 09:51:42Z schwenkel
94! Implementation of new microphysic scheme: cloud_scheme = 'morrison'
95! includes two more prognostic equations for cloud drop concentration (nc) 
96! and cloud water content (qc).
97!
98! 2261 2017-06-08 14:25:57Z raasch
99! output of run number for mrun to create unified cycle numbers
100!
101! 2233 2017-05-30 18:08:54Z suehring
102!
103! 2232 2017-05-30 17:47:52Z suehring
104! Renamed wall_flags_0 and wall_flags_00 into advc_flags_1 and advc_flags_2,
105! respectively, within copyin statement. Moreover, introduced further flag
106! array wall_flags_0.
107! Remove unused variables from ONLY list.
108!
109! 2178 2017-03-17 11:07:39Z hellstea
110! Calls for pmci_ensure_nest_mass_conservation and pres are added after
111! the nest initialization
112!
113! 2118 2017-01-17 16:38:49Z raasch
114! OpenACC directives and related code removed
115!
116! 2011 2016-09-19 17:29:57Z kanani
117! Flag urban_surface is now defined in module control_parameters.
118!
119! 2007 2016-08-24 15:47:17Z kanani
120! Temporarily added CALL for writing of restart data for urban surface model
121!
122! 2000 2016-08-20 18:09:15Z knoop
123! Forced header and separation lines into 80 columns
124!
125! 1976 2016-07-27 13:28:04Z maronga
126! Added call to radiation_last_actions for binary output of land surface model
127! data
128!
129! 1972 2016-07-26 07:52:02Z maronga
130! Added call to lsm_last_actions for binary output of land surface model data
131!
132! 1960 2016-07-12 16:34:24Z suehring
133! Separate humidity and passive scalar
134!
135! 1834 2016-04-07 14:34:20Z raasch
136! Initial version of purely vertical nesting introduced.
137!
138! 1833 2016-04-07 14:23:03Z raasch
139! required user interface version changed
140!
141! 1808 2016-04-05 19:44:00Z raasch
142! routine local_flush replaced by FORTRAN statement
143!
144! 1783 2016-03-06 18:36:17Z raasch
145! required user interface version changed
146!
147! 1781 2016-03-03 15:12:23Z raasch
148! pmc initialization moved from time_integration to here
149!
150! 1779 2016-03-03 08:01:28Z raasch
151! setting of nest_domain and coupling_char moved to the pmci
152!
153! 1764 2016-02-28 12:45:19Z raasch
154! cpp-statements for nesting removed, communicator settings cleaned up
155!
156! 1762 2016-02-25 12:31:13Z hellstea
157! Introduction of nested domain feature
158!
159! 1747 2016-02-08 12:25:53Z raasch
160! OpenACC-adjustment for new surface layer parameterization
161!
162! 1682 2015-10-07 23:56:08Z knoop
163! Code annotations made doxygen readable
164!
165! 1668 2015-09-23 13:45:36Z raasch
166! warning replaced by abort in case of failed user interface check
167!
168! 1666 2015-09-23 07:31:10Z raasch
169! check for user's interface version added
170!
171! 1482 2014-10-18 12:34:45Z raasch
172! adjustments for using CUDA-aware OpenMPI
173!
174! 1468 2014-09-24 14:06:57Z maronga
175! Adapted for use on up to 6-digit processor cores
176!
177! 1402 2014-05-09 14:25:13Z raasch
178! location messages added
179!
180! 1374 2014-04-25 12:55:07Z raasch
181! bugfix: various modules added
182!
183! 1320 2014-03-20 08:40:49Z raasch
184! ONLY-attribute added to USE-statements,
185! kind-parameters added to all INTEGER and REAL declaration statements,
186! kinds are defined in new module kinds,
187! old module precision_kind is removed,
188! revision history before 2012 removed,
189! comment fields (!:) to be used for variable explanations added to
190! all variable declaration statements
191!
192! 1318 2014-03-17 13:35:16Z raasch
193! module interfaces removed
194!
195! 1241 2013-10-30 11:36:58Z heinze
196! initialization of nuding and large scale forcing from external file
197!
198! 1221 2013-09-10 08:59:13Z raasch
199! +wall_flags_00, rflags_invers, rflags_s_inner in copyin statement
200!
201! 1212 2013-08-15 08:46:27Z raasch
202! +tri in copyin statement
203!
204! 1179 2013-06-14 05:57:58Z raasch
205! ref_state added to copyin-list
206!
207! 1113 2013-03-10 02:48:14Z raasch
208! openACC statements modified
209!
210! 1111 2013-03-08 23:54:10Z raasch
211! openACC statements updated
212!
213! 1092 2013-02-02 11:24:22Z raasch
214! unused variables removed
215!
216! 1036 2012-10-22 13:43:42Z raasch
217! code put under GPL (PALM 3.9)
218!
219! 1015 2012-09-27 09:23:24Z raasch
220! Version number changed from 3.8 to 3.8a.
221! OpenACC statements added + code changes required for GPU optimization
222!
223! 849 2012-03-15 10:35:09Z raasch
224! write_particles renamed lpm_write_restart_file
225!
226! Revision 1.1  1997/07/24 11:23:35  raasch
227! Initial revision
228!
229!
230! Description:
231! ------------
232!> Large-Eddy Simulation (LES) model for atmospheric and oceanic boundary-layer
233!> flows
234!> see the PALM homepage https://palm-model.org for further information
235!>
236!> @todo move chem_init call to init_3d_model or to check_parameters
237!------------------------------------------------------------------------------!
238 PROGRAM palm
239 
240
241    USE arrays_3d
242
243    USE chemistry_model_mod,                                                   &
244        ONLY:  chem_init
245
246    USE chem_photolysis_mod,                                                   &
247        ONLY:  photolysis_init
248
249    USE control_parameters,                                                    &
250        ONLY:  air_chemistry, constant_diffusion, child_domain,                &
251               coupling_char, coupling_mode, do2d_at_begin, do3d_at_begin,     &
252               humidity, initializing_actions, io_blocks, io_group,            &
253               message_string,                                                 &
254               neutral, passive_scalar, runnr, simulated_time_chr, spinup,     &
255               time_since_reference_point, user_interface_current_revision,    &
256               user_interface_required_revision, version, write_binary
257
258    USE cpulog,                                                                &
259        ONLY:  cpu_log, log_point, log_point_s, cpu_statistics
260
261    USE indices,                                                               &
262        ONLY:  nbgp
263
264    USE kinds
265
266    USE bulk_cloud_model_mod,                                                  &
267        ONLY: bulk_cloud_model, microphysics_morrison, microphysics_seifert
268
269    USE multi_agent_system_mod,                                                &
270        ONLY:  agents_active, mas_last_actions
271
272    USE netcdf_data_input_mod,                                                 &
273        ONLY:  netcdf_data_input_inquire_file, netcdf_data_input_init,         &
274               netcdf_data_input_surface_data, netcdf_data_input_topo
275
276    USE particle_attributes,                                                   &
277        ONLY:  particle_advection
278
279    USE pegrid
280
281    USE pmc_particle_interface,                                                &
282        ONLY: pmcp_g_alloc_win
283
284    USE pmc_interface,                                                         &
285        ONLY:  nested_run, pmci_child_initialize, pmci_init,                   &
286               pmci_modelconfiguration, pmci_parent_initialize,                &
287               pmci_ensure_nest_mass_conservation
288
289    USE write_restart_data_mod,                                                &
290        ONLY:  wrd_global, wrd_local
291
292
293    IMPLICIT NONE
294
295!
296!-- Local variables
297    CHARACTER(LEN=9) ::  time_to_string  !<
298    INTEGER(iwp)     ::  i               !< loop counter for blocked I/O
299
300    version = 'PALM 5.0'
301    user_interface_required_revision = 'r3240'
302
303#if defined( __parallel )
304!
305!-- MPI initialisation. comm2d is preliminary set, because
306!-- it will be defined in init_pegrid but is used before in cpu_log.
307    CALL MPI_INIT( ierr )
308
309!
310!-- Initialize the coupling for nested-domain runs
311!-- comm_palm is the communicator which includes all PEs (MPI processes)
312!-- available for this (nested) model. If it is not a nested run, comm_palm
313!-- is returned as MPI_COMM_WORLD
314    CALL cpu_log( log_point_s(70), 'pmci_init', 'start' )
315    CALL pmci_init( comm_palm )
316    CALL cpu_log( log_point_s(70), 'pmci_init', 'stop' )
317    comm2d = comm_palm
318!
319!-- Get the (preliminary) number of MPI processes and the local PE-id (in case
320!-- of a further communicator splitting in init_coupling, these numbers will
321!-- be changed in init_pegrid).
322    IF ( nested_run )  THEN
323
324       CALL MPI_COMM_SIZE( comm_palm, numprocs, ierr )
325       CALL MPI_COMM_RANK( comm_palm, myid, ierr )
326
327    ELSE
328
329       CALL MPI_COMM_SIZE( MPI_COMM_WORLD, numprocs, ierr )
330       CALL MPI_COMM_RANK( MPI_COMM_WORLD, myid, ierr )
331!
332!--    Initialize PE topology in case of coupled atmosphere-ocean runs (comm_palm
333!--    will be splitted in init_coupling)
334       CALL init_coupling
335    ENDIF
336#endif
337
338!
339!-- Initialize measuring of the CPU-time remaining to the run
340    CALL local_tremain_ini
341
342!
343!-- Start of total CPU time measuring.
344    CALL cpu_log( log_point(1), 'total', 'start' )
345    CALL cpu_log( log_point(2), 'initialisation', 'start' )
346
347!
348!-- Open a file for debug output
349    WRITE (myid_char,'(''_'',I6.6)')  myid
350    OPEN( 9, FILE='DEBUG'//TRIM( coupling_char )//myid_char, FORM='FORMATTED' )
351
352!
353!-- Initialize dvrp logging. Also, one PE maybe split from the global
354!-- communicator for doing the dvrp output. In that case, the number of
355!-- PEs available for PALM is reduced by one and communicator comm_palm
356!-- is changed respectively.
357#if defined( __parallel )
358    CALL MPI_COMM_RANK( comm_palm, myid, ierr )
359!
360!-- TEST OUTPUT (TO BE REMOVED)
361    WRITE(9,*) '*** coupling_mode = "', TRIM( coupling_mode ), '"'
362    FLUSH( 9 )
363    IF ( TRIM( coupling_mode ) /= 'uncoupled' )  THEN
364       PRINT*, '*** PE', myid, ' Global target PE:', target_id, &
365               TRIM( coupling_mode )
366    ENDIF
367#endif
368
369    CALL init_dvrp_logging
370
371!
372!-- Read control parameters from NAMELIST files and read environment-variables
373    CALL parin
374
375!
376!-- Check for the user's interface version
377    IF ( user_interface_current_revision /= user_interface_required_revision )  &
378    THEN
379       message_string = 'current user-interface revision "' //                  &
380                        TRIM( user_interface_current_revision ) // '" does ' // &
381                        'not match the required revision ' //                   &
382                        TRIM( user_interface_required_revision )
383        CALL message( 'palm', 'PA0169', 1, 2, 0, 6, 0 )
384    ENDIF
385
386!
387!-- Determine processor topology and local array indices
388    CALL init_pegrid
389!
390!-- Check if input file according to input-data standard exists
391    CALL netcdf_data_input_inquire_file
392!
393!-- Read topography input data if required. This is required before the
394!-- numerical grid is finally created in init_grid
395    CALL netcdf_data_input_topo 
396!
397!-- Generate grid parameters, initialize generic topography and further process
398!-- topography information if required
399    CALL init_grid
400!
401!-- Read global attributes if available. 
402    CALL netcdf_data_input_init
403!
404!-- Read surface classification data, e.g. vegetation and soil types, water
405!-- surfaces, etc., if available. Some of these data is required before
406!-- check parameters is invoked.     
407    CALL netcdf_data_input_surface_data
408!
409!-- Initialize chemistry (called before check_parameters due to dependencies)
410!-- --> Needs to be moved!! What is the dependency about?
411! IF (  TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
412    IF ( air_chemistry )  THEN
413       CALL chem_init
414       CALL photolysis_init   ! probably also required for restart
415    ENDIF
416! END IF
417!
418!-- Check control parameters and deduce further quantities
419    CALL check_parameters
420
421!
422!-- Initialize all necessary variables
423    CALL init_3d_model
424
425!
426!-- Coupling protocol setup for nested-domain runs
427    IF ( nested_run )  THEN
428       CALL pmci_modelconfiguration
429!
430!--    Receive and interpolate initial data on children.
431!--    Child initialization must be made first if the model is both child and
432!--    parent if necessary
433       IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
434          CALL pmci_child_initialize
435!
436!--       Send initial condition data from parent to children
437          CALL pmci_parent_initialize
438!
439!--       Exchange_horiz is needed after the nest initialization
440          IF ( child_domain )  THEN
441             CALL exchange_horiz( u, nbgp )
442             CALL exchange_horiz( v, nbgp )
443             CALL exchange_horiz( w, nbgp )
444             IF ( .NOT. neutral )  THEN
445                CALL exchange_horiz( pt, nbgp )
446             ENDIF
447             IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e, nbgp )
448             IF ( humidity )  THEN
449                CALL exchange_horiz( q, nbgp )
450                IF ( bulk_cloud_model  .AND.  microphysics_morrison )  THEN
451                  CALL exchange_horiz( qc, nbgp )
452                  CALL exchange_horiz( nc, nbgp )
453                ENDIF
454                IF ( bulk_cloud_model  .AND.  microphysics_seifert )  THEN
455                   CALL exchange_horiz( qr, nbgp ) 
456                   CALL exchange_horiz( nr, nbgp )
457                ENDIF
458             ENDIF
459             IF ( passive_scalar )  CALL exchange_horiz( s, nbgp )
460          ENDIF
461       ENDIF
462
463       CALL pmcp_g_alloc_win                    ! Must be called after pmci_child_initialize and pmci_parent_initialize
464    ENDIF
465
466!
467!-- Output of program header
468    IF ( myid == 0 )  CALL header
469
470    CALL cpu_log( log_point(2), 'initialisation', 'stop' )
471
472!
473!-- Integration of the non-atmospheric equations (land surface model, urban
474!-- surface model)
475    IF ( spinup )  THEN
476       CALL time_integration_spinup
477    ENDIF
478
479!
480!-- Set start time in format hh:mm:ss
481    simulated_time_chr = time_to_string( time_since_reference_point )
482
483!
484!-- If required, output of initial arrays
485    IF ( do2d_at_begin )  THEN
486       CALL data_output_2d( 'xy', 0 )
487       CALL data_output_2d( 'xz', 0 )
488       CALL data_output_2d( 'yz', 0 )
489    ENDIF
490
491    IF ( do3d_at_begin )  THEN
492       CALL data_output_3d( 0 )
493    ENDIF
494
495!
496!-- Integration of the model equations using timestep-scheme
497    CALL time_integration
498
499!
500!-- If required, write binary data for restart runs
501    IF ( write_binary )  THEN
502
503       CALL cpu_log( log_point(22), 'wrd_local', 'start' )
504
505       CALL location_message( 'writing restart data', .FALSE. )
506
507       DO  i = 0, io_blocks-1
508          IF ( i == io_group )  THEN
509
510!
511!--          Open binary file
512             CALL check_open( 14 )
513!
514!--          Write control parameters and other global variables for restart.
515             IF ( myid == 0 )  CALL wrd_global
516!
517!--          Write processor specific flow field data for restart runs
518             CALL wrd_local
519!
520!--          Close binary file
521             CALL close_file( 14 )
522
523          ENDIF
524#if defined( __parallel )
525          CALL MPI_BARRIER( comm2d, ierr )
526#endif
527       ENDDO
528
529       CALL location_message( 'finished', .TRUE. )
530
531       CALL cpu_log( log_point(22), 'wrd_local', 'stop' )
532
533!
534!--    If required, write particle data in own restart files
535       IF ( particle_advection )  CALL lpm_write_restart_file
536       
537    ENDIF
538
539!
540!-- If required, repeat output of header including the required CPU-time
541    IF ( myid == 0 )  CALL header
542!
543!-- If required, final  user-defined actions, and
544!-- last actions on the open files and close files. Unit 14 was opened
545!-- in wrd_local but it is closed here, to allow writing on this
546!-- unit in routine user_last_actions.
547    CALL cpu_log( log_point(4), 'last actions', 'start' )
548
549    IF ( myid == 0 .AND. agents_active ) CALL mas_last_actions
550    CALL user_last_actions
551    CALL close_file( 0 )
552    CALL close_dvrp
553
554    CALL cpu_log( log_point(4), 'last actions', 'stop' )
555
556!
557!-- Write run number to file (used by palmrun to create unified cycle numbers
558!-- for output files
559    IF ( myid == 0  .AND.  runnr > 0 )  THEN
560       OPEN( 90, FILE='RUN_NUMBER', FORM='FORMATTED' )
561       WRITE( 90, '(I4)' )  runnr
562       CLOSE( 90 )
563    ENDIF
564
565!
566!-- Take final CPU-time for CPU-time analysis
567    CALL cpu_log( log_point(1), 'total', 'stop' )
568    CALL cpu_statistics
569
570#if defined( __parallel )
571    CALL MPI_FINALIZE( ierr )
572#endif
573
574 END PROGRAM palm
Note: See TracBrowser for help on using the repository browser.