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

Last change on this file since 3232 was 3232, checked in by raasch, 3 years ago

references to mrun replaced by palmrun, and updated

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