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

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

Code annotations made doxygen readable

  • Property svn:keywords set to Id
File size: 6.4 KB
Line 
1!> @file advec_s_pw.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_pw.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! Revision 1.1  1997/08/29 08:54:20  raasch
48! Initial revision
49!
50!
51! Description:
52! ------------
53!> Advection term for scalar variables using the Piacsek and Williams scheme
54!> (form C3). Contrary to PW itself, for reasons of accuracy their scheme is
55!> slightly modified as follows: the values of those scalars that are used for
56!> the computation of the flux divergence are reduced by the value of the
57!> relevant scalar at the location where the difference is computed (sk(k,j,i)).
58!> NOTE: at the first grid point above the surface computation still takes place!
59!------------------------------------------------------------------------------!
60 MODULE advec_s_pw_mod
61 
62
63    PRIVATE
64    PUBLIC advec_s_pw
65
66    INTERFACE advec_s_pw
67       MODULE PROCEDURE advec_s_pw
68       MODULE PROCEDURE advec_s_pw_ij
69    END INTERFACE
70 
71 CONTAINS
72
73
74!------------------------------------------------------------------------------!
75! Description:
76! ------------
77!> Call for all grid points
78!------------------------------------------------------------------------------!
79    SUBROUTINE advec_s_pw( sk )
80
81       USE arrays_3d,                                                          &
82           ONLY:  dd2zu, 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#if defined( __nopointer )
104       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  sk !<
105#else
106       REAL(wp), DIMENSION(:,:,:), POINTER ::  sk
107#endif
108 
109
110       DO  i = nxl, nxr
111          DO  j = nys, nyn
112             DO  k = nzb_s_inner(j,i)+1, nzt
113                tend(k,j,i) = tend(k,j,i)                                      &
114              -0.5_wp * ( ( u(k,j,i+1) - u_gtrans ) * ( sk(k,j,i+1) - sk(k,j,i) ) &
115                        - ( u(k,j,i)   - u_gtrans ) * ( sk(k,j,i-1) - sk(k,j,i) ) &
116                        ) * ddx                                                   &
117              -0.5_wp * ( ( v(k,j+1,i) - v_gtrans ) * ( sk(k,j+1,i) - sk(k,j,i) ) &
118                        - ( v(k,j,i)   - v_gtrans ) * ( sk(k,j-1,i) - sk(k,j,i) ) &
119                        ) * ddy                                                   &
120              -         (   w(k,j,i)                * ( sk(k+1,j,i) - sk(k,j,i) ) &
121                        -   w(k-1,j,i)              * ( sk(k-1,j,i) - sk(k,j,i) ) &
122                        ) * dd2zu(k)
123             ENDDO
124          ENDDO
125       ENDDO
126
127    END SUBROUTINE advec_s_pw
128
129
130!------------------------------------------------------------------------------!
131! Description:
132! ------------
133!> Call for grid point i,j
134!------------------------------------------------------------------------------!
135    SUBROUTINE advec_s_pw_ij( i, j, sk )
136
137       USE arrays_3d,                                                          &
138           ONLY:  dd2zu, tend, u, v, w
139
140       USE control_parameters,                                                 &
141           ONLY:  u_gtrans, v_gtrans
142
143       USE grid_variables,                                                     &
144           ONLY:  ddx, ddy
145
146       USE indices,                                                            &
147           ONLY:  nxlg, nxrg, nyng, nysg, nzb, nzb_s_inner, nzt
148
149       USE kinds
150
151
152       IMPLICIT NONE
153
154       INTEGER(iwp) ::  i !<
155       INTEGER(iwp) ::  j !<
156       INTEGER(iwp) ::  k !<
157
158#if defined( __nopointer )
159       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  sk !<
160#else
161       REAL(wp), DIMENSION(:,:,:), POINTER ::  sk
162#endif
163
164
165       DO  k = nzb_s_inner(j,i)+1, nzt
166          tend(k,j,i) = tend(k,j,i)                                            &
167              -0.5_wp * ( ( u(k,j,i+1) - u_gtrans ) * ( sk(k,j,i+1) - sk(k,j,i) ) &
168                        - ( u(k,j,i)   - u_gtrans ) * ( sk(k,j,i-1) - sk(k,j,i) ) &
169                        ) * ddx                                                   &
170              -0.5_wp * ( ( v(k,j+1,i) - v_gtrans ) * ( sk(k,j+1,i) - sk(k,j,i) ) &
171                        - ( v(k,j,i)   - v_gtrans ) * ( sk(k,j-1,i) - sk(k,j,i) ) &
172                        ) * ddy                                                   &
173              -         (   w(k,j,i)                * ( sk(k+1,j,i) - sk(k,j,i) ) &
174                        -   w(k-1,j,i)              * ( sk(k-1,j,i) - sk(k,j,i) ) &
175                        ) * dd2zu(k)
176       ENDDO
177
178    END SUBROUTINE advec_s_pw_ij
179
180 END MODULE advec_s_pw_mod
Note: See TracBrowser for help on using the repository browser.