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

Last change on this file since 3494 was 3494, checked in by suehring, 3 years ago

Surface output revised and some bugs are fixed + new post-processing tool to convert binary surface output to Paraview readable VTK files

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