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

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

reintegrate branch resler to trunk

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