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

Last change on this file since 2177 was 2177, checked in by hellstea, 4 years ago

Minor changes in nesting

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