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

Last change on this file since 4017 was 4017, checked in by schwenkel, 2 years ago

Modularization of all lagrangian particle model code components

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