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

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

Merge chemistry branch at r3297 to trunk

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