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

Last change on this file since 2951 was 2951, checked in by kanani, 3 years ago

Add cpu measures for nesting initialization

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