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

Last change on this file since 3458 was 3458, checked in by kanani, 3 years ago

Reintegrated fixes/changes from branch chemistry

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