source: palm/trunk/SOURCE/init_coupling.f90

Last change on this file was 4828, checked in by Giersch, 5 months ago

Copyright updated to year 2021, interface pmc_sort removed to accelarate the nesting code

  • Property svn:keywords set to Id
File size: 4.6 KB
Line 
1!> @file init_coupling.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 terms of the GNU General
6! Public License as published by the Free Software Foundation, either version 3 of the License, or
7! (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
10! implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
11! Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with PALM. If not, see
14! <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2021 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21!
22!
23! Former revisions:
24! ------------------
25! $Id: init_coupling.f90 4828 2021-01-05 11:21:41Z banzhafs $
26! file re-formatted to follow the PALM coding standard
27!
28! 4564 2020-06-12 14:03:36Z raasch
29! Vertical nesting method of Huq et al. (2019) removed
30!
31! 4444 2020-03-05 15:59:50Z raasch
32! bugfix: cpp-directives for serial mode added
33!
34! 4360 2020-01-07 11:25:50Z suehring
35! Corrected "Former revisions" section
36!
37! 3655 2019-01-07 16:51:22Z knoop
38! references to mrun replaced by palmrun, and updated
39!
40! 222 2009-01-12 16:04:16Z letzel
41! Initial revision
42!
43! Description:
44! ------------
45!> Initializing coupling via MPI-1 or MPI-2 if the coupled version of PALM is called.
46!--------------------------------------------------------------------------------------------------!
47  SUBROUTINE init_coupling
48
49
50    USE control_parameters,                                                                        &
51        ONLY:  coupling_char, coupling_mode
52
53    USE kinds
54
55    USE pegrid
56
57    IMPLICIT NONE
58
59!
60!-- Local variables
61#if defined( __parallel )
62    INTEGER(iwp) ::  i            !<
63    INTEGER(iwp) ::  inter_color  !<
64#endif
65
66    INTEGER(iwp), DIMENSION(:) ::  bc_data(0:3) = 0  !<
67
68!
69!-- Get information about the coupling mode from the environment variable which has been set by the
70!-- mpiexec command.
71!-- This method is currently not used because the mpiexec command is not available on some machines.
72!    CALL GET_ENVIRONMENT_VARIABLE( 'coupling_mode', coupling_mode, i )
73!    IF ( i == 0 )  coupling_mode = 'uncoupled'
74!    IF ( coupling_mode == 'ocean_to_atmosphere' )  coupling_char = '_O'
75
76!
77!-- Get information about the coupling mode from standard input (PE0 only) and distribute it to the
78!-- other PEs. Distribute PEs to 2 new communicators.
79!-- ATTENTION: numprocs will be reset according to the new communicators
80#if defined ( __parallel )
81
82    IF ( myid == 0 )  THEN
83       READ (*,*,ERR=10,END=10)  coupling_mode, bc_data(1), bc_data(2)
8410     CONTINUE
85       IF ( TRIM( coupling_mode ) == 'coupled_run' )  THEN
86          i = 1
87       ELSE
88          i = 0
89       ENDIF
90       bc_data(0) = i
91
92!
93!--    Check if '_O' has to be used as file extension in an uncoupled ocean run. This is required,
94!--    if this run shall be continued as a coupled run.
95       IF ( TRIM( coupling_mode ) == 'precursor_ocean' )  bc_data(3) = 1
96
97    ENDIF
98
99    CALL MPI_BCAST( bc_data(0), 4, MPI_INTEGER, 0, MPI_COMM_WORLD, ierr )
100    i = bc_data(0)
101
102    IF ( i == 0 )  THEN
103       coupling_mode = 'uncoupled'
104!
105!--    In case of a precursor ocean run, an additional flag file is created.
106!--    This is necessary for data_output_2d_on_each_pe = .T.
107       IF ( bc_data(3) == 1 )  THEN
108          OPEN( 90, FILE='PRECURSOR_OCEAN', FORM='FORMATTED' )
109          WRITE ( 90, '(''TRUE'')' )
110          CLOSE ( 90 )
111       ENDIF
112    ELSE
113       comm_inter = MPI_COMM_WORLD
114
115       IF ( myid < bc_data(1) ) THEN
116          inter_color     = 0
117          numprocs        = bc_data(1)
118          coupling_mode   = 'atmosphere_to_ocean'
119       ELSE
120          inter_color     = 1
121          numprocs        = bc_data(2)
122          coupling_mode   = 'ocean_to_atmosphere'
123       ENDIF
124
125       CALL MPI_COMM_SPLIT( MPI_COMM_WORLD, inter_color, 0, comm_palm, ierr )
126       comm2d = comm_palm
127
128!
129!--    Write a flag file for the ocean model and the other atmosphere processes.
130       OPEN( 90, FILE='COUPLING_PORT_OPENED', FORM='FORMATTED' )
131       WRITE ( 90, '(''TRUE'')' )
132       CLOSE ( 90 )
133    ENDIF
134#endif
135
136!
137!-- In case of a precursor ocean run (followed by a coupled run), or a coupled atmosphere-ocean run,
138!-- set the file extension for the ocean files.
139    IF ( TRIM( coupling_mode ) == 'ocean_to_atmosphere' .OR. bc_data(3) == 1 )  THEN
140       coupling_char = '_O'
141    ENDIF
142
143 END SUBROUTINE init_coupling
Note: See TracBrowser for help on using the repository browser.