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

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

Merge of branch palm4u into trunk

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