source: palm/trunk/SOURCE/sor.f90 @ 2000

Last change on this file since 2000 was 2000, checked in by knoop, 5 years ago

Forced header and separation lines into 80 columns

  • Property svn:keywords set to Id
File size: 8.0 KB
Line 
1!> @file sor.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-2016 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22! Forced header and separation lines into 80 columns
23!
24! Former revisions:
25! -----------------
26! $Id: sor.f90 2000 2016-08-20 18:09:15Z knoop $
27!
28! 1762 2016-02-25 12:31:13Z hellstea
29! Introduction of nested domain feature
30!
31! 1682 2015-10-07 23:56:08Z knoop
32! Code annotations made doxygen readable
33!
34! 1353 2014-04-08 15:21:23Z heinze
35! REAL constants provided with KIND-attribute
36!
37! 1320 2014-03-20 08:40:49Z raasch
38! ONLY-attribute added to USE-statements,
39! kind-parameters added to all INTEGER and REAL declaration statements,
40! kinds are defined in new module kinds,
41! old module precision_kind is removed,
42! revision history before 2012 removed,
43! comment fields (!:) to be used for variable explanations added to
44! all variable declaration statements
45!
46! 1036 2012-10-22 13:43:42Z raasch
47! code put under GPL (PALM 3.9)
48!
49! Revision 1.1  1997/08/11 06:25:56  raasch
50! Initial revision
51!
52!
53! Description:
54! ------------
55!> Solve the Poisson-equation with the SOR-Red/Black-scheme.
56!------------------------------------------------------------------------------!
57 SUBROUTINE sor( d, ddzu, ddzw, p )
58 
59
60    USE grid_variables,                                                        &
61        ONLY:  ddx2, ddy2
62
63    USE indices,                                                               &
64        ONLY:  nbgp, nxl, nxlg, nxr, nxrg, nyn, nyng, nys, nysg, nz, nzb, nzt
65
66    USE kinds
67
68    USE control_parameters,                                                    &
69        ONLY:  bc_lr_cyc, bc_ns_cyc, ibc_p_b, ibc_p_t, inflow_l, inflow_n,     &
70               inflow_r, inflow_s, nest_bound_l, nest_bound_n, nest_bound_r,   &
71               nest_bound_s, n_sor, omega_sor, outflow_l, outflow_n,           &
72               outflow_r, outflow_s
73
74    IMPLICIT NONE
75
76    INTEGER(iwp) ::  i              !<
77    INTEGER(iwp) ::  j              !<
78    INTEGER(iwp) ::  k              !<
79    INTEGER(iwp) ::  n              !<
80    INTEGER(iwp) ::  nxl1           !<
81    INTEGER(iwp) ::  nxl2           !<
82    INTEGER(iwp) ::  nys1           !<
83    INTEGER(iwp) ::  nys2           !<
84
85    REAL(wp)     ::  ddzu(1:nz+1)   !<
86    REAL(wp)     ::  ddzw(1:nzt+1)  !<
87
88    REAL(wp)     ::  d(nzb+1:nzt,nys:nyn,nxl:nxr)      !<
89    REAL(wp)     ::  p(nzb:nzt+1,nysg:nyng,nxlg:nxrg)  !<
90
91    REAL(wp), DIMENSION(:), ALLOCATABLE ::  f1         !<
92    REAL(wp), DIMENSION(:), ALLOCATABLE ::  f2         !<
93    REAL(wp), DIMENSION(:), ALLOCATABLE ::  f3         !<
94
95    ALLOCATE( f1(1:nz), f2(1:nz), f3(1:nz) )
96
97!
98!-- Compute pre-factors.
99    DO  k = 1, nz
100         f2(k) = ddzu(k+1) * ddzw(k)
101         f3(k) = ddzu(k)   * ddzw(k)
102         f1(k) = 2.0_wp * ( ddx2 + ddy2 ) + f2(k) + f3(k)
103    ENDDO
104
105!
106!-- Limits for RED- and BLACK-part.
107    IF ( MOD( nxl , 2 ) == 0 )  THEN
108       nxl1 = nxl
109       nxl2 = nxl + 1
110    ELSE
111       nxl1 = nxl + 1
112       nxl2 = nxl
113    ENDIF
114    IF ( MOD( nys , 2 ) == 0 )  THEN
115       nys1 = nys
116       nys2 = nys + 1
117    ELSE
118       nys1 = nys + 1
119       nys2 = nys
120    ENDIF
121
122    DO  n = 1, n_sor
123
124!
125!--    RED-part
126       DO  i = nxl1, nxr, 2
127          DO  j = nys2, nyn, 2
128             DO  k = nzb+1, nzt
129                p(k,j,i) = p(k,j,i) + omega_sor / f1(k) * (            &
130                               ddx2 * ( p(k,j,i+1) + p(k,j,i-1) ) +    &
131                               ddy2 * ( p(k,j+1,i) + p(k,j-1,i) ) +    &
132                               f2(k) * p(k+1,j,i)                 +    &
133                               f3(k) * p(k-1,j,i)                 -    &
134                               d(k,j,i)                           -    &
135                               f1(k) * p(k,j,i)           )
136             ENDDO
137          ENDDO
138       ENDDO
139
140       DO  i = nxl2, nxr, 2
141          DO  j = nys1, nyn, 2
142             DO  k = nzb+1, nzt
143                p(k,j,i) = p(k,j,i) + omega_sor / f1(k) * (            &
144                               ddx2 * ( p(k,j,i+1) + p(k,j,i-1) ) +    &
145                               ddy2 * ( p(k,j+1,i) + p(k,j-1,i) ) +    &
146                               f2(k) * p(k+1,j,i)                 +    &
147                               f3(k) * p(k-1,j,i)                 -    &
148                               d(k,j,i)                           -    &
149                               f1(k) * p(k,j,i)           )
150             ENDDO
151          ENDDO
152       ENDDO
153
154!
155!--    Exchange of boundary values for p.
156       CALL exchange_horiz( p, nbgp )
157
158!
159!--    Horizontal (Neumann) boundary conditions in case of non-cyclic boundaries
160       IF ( .NOT. bc_lr_cyc )  THEN
161          IF ( inflow_l .OR. outflow_l .OR. nest_bound_l )  p(:,:,nxl-1) = p(:,:,nxl)
162          IF ( inflow_r .OR. outflow_r .OR. nest_bound_r )  p(:,:,nxr+1) = p(:,:,nxr)
163       ENDIF
164       IF ( .NOT. bc_ns_cyc )  THEN
165          IF ( inflow_n .OR. outflow_n .OR. nest_bound_n )  p(:,nyn+1,:) = p(:,nyn,:)
166          IF ( inflow_s .OR. outflow_s .OR. nest_bound_s )  p(:,nys-1,:) = p(:,nys,:)
167       ENDIF
168
169!
170!--    BLACK-part
171       DO  i = nxl1, nxr, 2
172          DO  j = nys1, nyn, 2
173             DO  k = nzb+1, nzt
174                p(k,j,i) = p(k,j,i) + omega_sor / f1(k) * (            &
175                               ddx2 * ( p(k,j,i+1) + p(k,j,i-1) ) +    &
176                               ddy2 * ( p(k,j+1,i) + p(k,j-1,i) ) +    &
177                               f2(k) * p(k+1,j,i)                 +    &
178                               f3(k) * p(k-1,j,i)                 -    &
179                               d(k,j,i)                           -    &
180                               f1(k) * p(k,j,i)           )
181             ENDDO
182          ENDDO
183       ENDDO
184
185       DO  i = nxl2, nxr, 2
186          DO  j = nys2, nyn, 2
187             DO  k = nzb+1, nzt
188                p(k,j,i) = p(k,j,i) + omega_sor / f1(k) * (            &
189                               ddx2 * ( p(k,j,i+1) + p(k,j,i-1) ) +    &
190                               ddy2 * ( p(k,j+1,i) + p(k,j-1,i) ) +    &
191                               f2(k) * p(k+1,j,i)                 +    &
192                               f3(k) * p(k-1,j,i)                 -    &
193                               d(k,j,i)                           -    &
194                               f1(k) * p(k,j,i)           )
195             ENDDO
196          ENDDO
197       ENDDO
198
199!
200!--    Exchange of boundary values for p.
201       CALL exchange_horiz( p, nbgp )
202
203!
204!--    Boundary conditions top/bottom.
205!--    Bottom boundary
206       IF ( ibc_p_b == 1 )  THEN       !       Neumann
207          p(nzb,:,:) = p(nzb+1,:,:)
208       ELSE                            !       Dirichlet
209          p(nzb,:,:) = 0.0_wp
210       ENDIF
211
212!
213!--    Top boundary
214       IF ( ibc_p_t == 1 )  THEN                 !  Neumann
215          p(nzt+1,:,:) = p(nzt,:,:)
216       ELSE                      !  Dirichlet
217          p(nzt+1,:,:) = 0.0_wp
218       ENDIF
219
220!
221!--    Horizontal (Neumann) boundary conditions in case of non-cyclic boundaries
222       IF ( .NOT. bc_lr_cyc )  THEN
223          IF ( inflow_l .OR. outflow_l .OR. nest_bound_l )  p(:,:,nxl-1) = p(:,:,nxl)
224          IF ( inflow_r .OR. outflow_r .OR. nest_bound_r )  p(:,:,nxr+1) = p(:,:,nxr)
225       ENDIF
226       IF ( .NOT. bc_ns_cyc )  THEN
227          IF ( inflow_n .OR. outflow_n .OR. nest_bound_n )  p(:,nyn+1,:) = p(:,nyn,:)
228          IF ( inflow_s .OR. outflow_s .OR. nest_bound_s )  p(:,nys-1,:) = p(:,nys,:)
229       ENDIF
230
231
232    ENDDO
233
234    DEALLOCATE( f1, f2, f3 )
235
236 END SUBROUTINE sor
Note: See TracBrowser for help on using the repository browser.