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

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

Reading/Writing? data in case of restart runs revised

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