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

Last change on this file since 3487 was 3487, checked in by maronga, 5 years ago

processed comments from a previous revision, adjustments of palmrungui and palm.f90 to release 6.0

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