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

Last change on this file since 1762 was 1762, checked in by hellstea, 5 years ago

Introduction of nested domain system

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