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

Last change on this file since 3484 was 3484, checked in by hellstea, 3 years ago

Nesting interpolation made mass-conservative

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