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

Last change on this file since 2696 was 2696, checked in by kanani, 4 years ago

Merge of branch palm4u into trunk

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