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

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

update of palm version

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