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

Last change on this file since 3648 was 3648, checked in by suehring, 2 years ago

Rename surface_output_mod into surface_data_output_mod, same with all corresponding subroutines

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