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

Last change on this file since 3235 was 3235, checked in by sward, 3 years ago

Bugfix in MAS output, added related messages, reworked MAS cpu logging

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