source: palm/trunk/SOURCE/advec_s_up.f90 @ 1682

Last change on this file since 1682 was 1682, checked in by knoop, 9 years ago

Code annotations made doxygen readable

  • Property svn:keywords set to Id
File size: 7.6 KB
Line 
1!> @file advec_s_up.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! Code annotations made doxygen readable
22!
23! Former revisions:
24! -----------------
25! $Id: advec_s_up.f90 1682 2015-10-07 23:56:08Z knoop $
26!
27! 1374 2014-04-25 12:55:07Z raasch
28! missing variables added to ONLY list
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! revision history before 2012 removed,
38! comment fields (!:) to be used for variable explanations added to
39! all variable declaration statements
40!
41! 1036 2012-10-22 13:43:42Z raasch
42! code put under GPL (PALM 3.9)
43!
44! 1010 2012-09-20 07:59:54Z raasch
45! cpp switch __nopointer added for pointer free version
46!
47! 981 2012-08-09 14:57:44Z maronga
48! Typo removed
49!
50! Revision 1.1  1997/08/29 08:54:33  raasch
51! Initial revision
52!
53!
54! Description:
55! ------------
56!> Advection term for scalar quantities using the Upstream scheme.
57!> NOTE: vertical advection at k=1 still has wrong grid spacing for w>0!
58!>       The same problem occurs for all topography boundaries!
59!------------------------------------------------------------------------------!
60 MODULE advec_s_up_mod
61 
62
63    PRIVATE
64    PUBLIC advec_s_up
65
66    INTERFACE advec_s_up
67       MODULE PROCEDURE advec_s_up
68       MODULE PROCEDURE advec_s_up_ij
69    END INTERFACE advec_s_up
70
71 CONTAINS
72
73
74!------------------------------------------------------------------------------!
75! Description:
76! ------------
77!> Call for all grid points
78!------------------------------------------------------------------------------!
79    SUBROUTINE advec_s_up( sk )
80
81       USE arrays_3d,                                                          &
82           ONLY:  ddzu, tend, u, v, w
83
84       USE control_parameters,                                                 &
85           ONLY:  u_gtrans, v_gtrans
86
87       USE grid_variables,                                                     &
88           ONLY:  ddx, ddy
89
90       USE indices,                                                            &
91           ONLY:  nxl, nxlg, nxr, nxrg, nyn, nyng, nys, nysg, nzb, nzb_s_inner,&
92                  nzt
93
94       USE kinds
95
96
97       IMPLICIT NONE
98
99       INTEGER(iwp) ::  i !<
100       INTEGER(iwp) ::  j !<
101       INTEGER(iwp) ::  k !<
102
103       REAL(wp) ::  ukomp !<
104       REAL(wp) ::  vkomp !<
105       REAL(wp) ::  wkomp !<
106#if defined( __nopointer )
107       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  sk !<
108#else
109       REAL(wp), DIMENSION(:,:,:), POINTER ::  sk
110#endif
111
112
113       DO  i = nxl, nxr
114          DO  j = nys, nyn
115             DO  k = nzb_s_inner(j,i)+1, nzt
116!
117!--             x-direction
118                ukomp = 0.5_wp * ( u(k,j,i) + u(k,j,i+1) ) - u_gtrans
119                IF ( ukomp > 0.0_wp )  THEN
120                   tend(k,j,i) = tend(k,j,i) - ukomp *                         &
121                                         ( sk(k,j,i) - sk(k,j,i-1) ) * ddx
122                ELSE
123                   tend(k,j,i) = tend(k,j,i) - ukomp *                         &
124                                         ( sk(k,j,i+1) - sk(k,j,i) ) * ddx
125                ENDIF
126!
127!--             y-direction
128                vkomp = 0.5_wp * ( v(k,j,i) + v(k,j+1,i) ) - v_gtrans
129                IF ( vkomp > 0.0_wp )  THEN
130                   tend(k,j,i) = tend(k,j,i) - vkomp *                         &
131                                         ( sk(k,j,i) - sk(k,j-1,i) ) * ddy
132                ELSE
133                   tend(k,j,i) = tend(k,j,i) - vkomp *                         &
134                                         ( sk(k,j+1,i) - sk(k,j,i) ) * ddy
135                ENDIF
136!
137!--             z-direction
138                wkomp = 0.5_wp * ( w(k,j,i) + w(k-1,j,i) )
139                IF ( wkomp > 0.0_wp )  THEN
140                   tend(k,j,i) = tend(k,j,i) - wkomp *                         &
141                                         ( sk(k,j,i) - sk(k-1,j,i) ) * ddzu(k)
142                ELSE
143                   tend(k,j,i) = tend(k,j,i) - wkomp *                         &
144                                         ( sk(k+1,j,i)-sk(k,j,i) ) * ddzu(k+1)
145                ENDIF
146
147             ENDDO
148          ENDDO
149       ENDDO
150
151    END SUBROUTINE advec_s_up
152
153
154!------------------------------------------------------------------------------!
155! Description:
156! ------------
157!> Call for grid point i,j
158!------------------------------------------------------------------------------!
159    SUBROUTINE advec_s_up_ij( i, j, sk )
160
161       USE arrays_3d,                                                          &
162           ONLY:  ddzu, tend, u, v, w
163
164       USE control_parameters,                                                 &
165           ONLY:  u_gtrans, v_gtrans
166
167       USE grid_variables,                                                     &
168           ONLY:  ddx, ddy
169
170       USE indices,                                                            &
171           ONLY:  nxlg, nxrg, nyng, nysg, nzb, nzb_s_inner, nzt
172
173       USE kinds
174
175
176       IMPLICIT NONE
177
178       INTEGER(iwp) ::  i !<
179       INTEGER(iwp) ::  j !<
180       INTEGER(iwp) ::  k !<
181
182       REAL(wp) ::  ukomp !<
183       REAL(wp) ::  vkomp !<
184       REAL(wp) ::  wkomp !<
185       
186#if defined( __nopointer )
187       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  sk !<
188#else
189       REAL(wp), DIMENSION(:,:,:), POINTER ::  sk
190#endif
191
192
193       DO  k = nzb_s_inner(j,i)+1, nzt
194!
195!--       x-direction
196          ukomp = 0.5_wp * ( u(k,j,i) + u(k,j,i+1) ) - u_gtrans
197          IF ( ukomp > 0.0_wp )  THEN
198             tend(k,j,i) = tend(k,j,i) - ukomp *                               &
199                                         ( sk(k,j,i) - sk(k,j,i-1) ) * ddx
200          ELSE
201             tend(k,j,i) = tend(k,j,i) - ukomp *                               &
202                                         ( sk(k,j,i+1) - sk(k,j,i) ) * ddx
203          ENDIF
204!
205!--       y-direction
206          vkomp = 0.5_wp * ( v(k,j,i) + v(k,j+1,i) ) - v_gtrans
207          IF ( vkomp > 0.0_wp )  THEN
208             tend(k,j,i) = tend(k,j,i) - vkomp *                               &
209                                         ( sk(k,j,i) - sk(k,j-1,i) ) * ddy
210          ELSE
211             tend(k,j,i) = tend(k,j,i) - vkomp *                               &
212                                         ( sk(k,j+1,i) - sk(k,j,i) ) * ddy
213          ENDIF
214!
215!--       z-direction
216          wkomp = 0.5_wp * ( w(k,j,i) + w(k-1,j,i) )
217          IF ( wkomp > 0.0_wp )  THEN
218             tend(k,j,i) = tend(k,j,i) - wkomp *                               &
219                                         ( sk(k,j,i) - sk(k-1,j,i) ) * ddzu(k)
220          ELSE
221             tend(k,j,i) = tend(k,j,i) - wkomp *                               &
222                                         ( sk(k+1,j,i)-sk(k,j,i) ) * ddzu(k+1)
223          ENDIF
224
225       ENDDO
226
227    END SUBROUTINE advec_s_up_ij
228
229 END MODULE advec_s_up_mod
Note: See TracBrowser for help on using the repository browser.