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

Last change on this file since 3241 was 3241, checked in by raasch, 3 years ago

various changes to avoid compiler warnings (mainly removal of unused variables)

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