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

Last change on this file since 3258 was 3258, checked in by Giersch, 3 years ago

current revision number for user interface has been changed due to modifications in revision 3240

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