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

Last change on this file since 2801 was 2801, checked in by thiele, 3 years ago

Introduce particle transfer in nested models

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