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

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

unused variables removed, missing working precision added, missing preprocessor directives added, bugfix concerning allocation of t_surf_wall_v in nopointer case, declaration statements rearranged to avoid compile time errors, mpi_abort arguments replaced to avoid compile errors

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