source: palm/trunk/SOURCE/user_actions.f90 @ 1960

Last change on this file since 1960 was 1960, checked in by suehring, 5 years ago

Separate balance equations for humidity and passive_scalar

  • Property svn:keywords set to Id
File size: 6.2 KB
Line 
1!> @file user_actions.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-2016 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! ------------------
21! New CASE statement for scalar tendency
22!
23! Former revisions:
24! -----------------
25! $Id: user_actions.f90 1960 2016-07-12 16:34:24Z suehring $
26!
27! 1873 2016-04-18 14:50:06Z maronga
28! Module renamed (removed _mod)
29!
30!
31! 1850 2016-04-08 13:29:27Z maronga
32! Module renamed
33!
34!
35! 1822 2016-04-07 07:49:42Z hoffmann
36! qr/nr-tendency removed.
37!
38! 1682 2015-10-07 23:56:08Z knoop
39! Code annotations made doxygen readable
40!
41! 1353 2014-04-08 15:21:23Z heinze
42! REAL constants provided with KIND-attribute
43!
44! 1320 2014-03-20 08:40:49Z raasch
45! kind-parameters added to all INTEGER and REAL declaration statements,
46! kinds are defined in new module kinds,
47! revision history before 2012 removed,
48! comment fields (!:) to be used for variable explanations added to
49! all variable declaration statements
50!
51! 1318 2014-03-17 13:35:16Z raasch
52! module interfaces removed
53!
54! 1053 2012-11-13 17:11:03Z hoffmann
55! +qr-tendency, nr-tendency
56!
57! 1036 2012-10-22 13:43:42Z raasch
58! code put under GPL (PALM 3.9)
59!
60! 211 2008-11-11 04:46:24Z raasch
61! Former file user_interface.f90 split into one file per subroutine
62!
63! Description:
64! ------------
65!> Execution of user-defined actions before or after single timesteps
66!------------------------------------------------------------------------------!
67 MODULE user_actions_mod
68 
69
70    PRIVATE
71    PUBLIC user_actions
72
73    INTERFACE user_actions
74       MODULE PROCEDURE user_actions
75       MODULE PROCEDURE user_actions_ij
76    END INTERFACE user_actions
77
78 CONTAINS
79
80
81!------------------------------------------------------------------------------!
82! Description:
83! ------------
84!> Call for all grid points
85!------------------------------------------------------------------------------!
86    SUBROUTINE user_actions( location )
87
88       USE control_parameters
89
90       USE cpulog
91
92       USE indices
93
94       USE kinds
95
96       USE pegrid
97
98       USE user
99
100       USE arrays_3d
101
102       IMPLICIT NONE
103
104       CHARACTER (LEN=*) ::  location !<
105
106       INTEGER(iwp) ::  i !<
107       INTEGER(iwp) ::  j !<
108       INTEGER(iwp) ::  k !<
109
110       CALL cpu_log( log_point(24), 'user_actions', 'start' )
111
112!
113!--    Here the user-defined actions follow
114!--    No calls for single grid points are allowed at locations before and
115!--    after the timestep, since these calls are not within an i,j-loop
116       SELECT CASE ( location )
117
118          CASE ( 'before_timestep' )
119!
120!--          Enter actions to be done before every timestep here
121
122
123          CASE ( 'after_integration' )
124!
125!--          Enter actions to be done after every time integration (before
126!--          data output)
127!--          Sample for user-defined output:
128!             DO  i = nxlg, nxrg
129!                DO  j = nysg, nyng
130!                   DO  k = nzb, nzt
131!                      u2(k,j,i) = u(k,j,i)**2
132!                   ENDDO
133!                ENDDO
134!             ENDDO
135!             DO  i = nxlg, nxr
136!                DO  j = nysg, nyn
137!                   DO  k = nzb, nzt+1
138!                      ustvst(k,j,i) =  &
139!                         ( 0.5_wp * ( u(k,j,i) + u(k,j,i+1) ) - hom(k,1,1,0) ) * &
140!                         ( 0.5_wp * ( v(k,j,i) + v(k,j+1,i) ) - hom(k,1,2,0) )
141!                   ENDDO
142!                ENDDO
143!             ENDDO
144
145
146          CASE ( 'after_timestep' )
147!
148!--          Enter actions to be done after every timestep here
149
150
151          CASE ( 'u-tendency' )
152!
153!--          Enter actions to be done in the u-tendency term here
154
155
156          CASE ( 'v-tendency' )
157
158
159          CASE ( 'w-tendency' )
160
161
162          CASE ( 'pt-tendency' )
163
164
165          CASE ( 'sa-tendency' )
166
167
168          CASE ( 'e-tendency' )
169
170
171          CASE ( 'q-tendency' )
172         
173         
174          CASE ( 's-tendency' )         
175
176
177          CASE DEFAULT
178             message_string = 'unknown location "' // location // '"'
179             CALL message( 'user_actions', 'UI0001', 1, 2, 0, 6, 0 )
180
181       END SELECT
182
183       CALL cpu_log( log_point(24), 'user_actions', 'stop' )
184
185    END SUBROUTINE user_actions
186
187
188!------------------------------------------------------------------------------!
189! Description:
190! ------------
191!> Call for grid point i,j
192!------------------------------------------------------------------------------!
193    SUBROUTINE user_actions_ij( i, j, location )
194
195       USE control_parameters
196       USE kinds
197       USE pegrid
198       USE user
199
200       IMPLICIT NONE
201
202       CHARACTER (LEN=*) ::  location
203
204       INTEGER(iwp) ::  i
205       INTEGER(iwp) ::  idum
206       INTEGER(iwp) ::  j
207
208!
209!--    Here the user-defined actions follow
210       SELECT CASE ( location )
211
212          CASE ( 'u-tendency' )
213!
214!--          Enter actions to be done in the u-tendency term here
215
216
217          CASE ( 'v-tendency' )
218
219
220          CASE ( 'w-tendency' )
221
222
223          CASE ( 'pt-tendency' )
224
225
226          CASE ( 'sa-tendency' )
227
228
229          CASE ( 'e-tendency' )
230
231
232          CASE ( 'q-tendency' )
233         
234         
235          CASE ( 's-tendency' )
236
237
238          CASE ( 'before_timestep', 'after_integration', 'after_timestep' )
239             message_string = 'location "' // location // '" is not ' // &
240                             'allowed to be called with parameters "i" and "j"'
241             CALL message( 'user_actions', 'UI0002', 1, 2, 0, 6, 0 )
242
243
244          CASE DEFAULT
245             message_string = 'unknown location "' // location // '"'
246             CALL message( 'user_actions', 'UI0001', 1, 2, 0, 6, 0 )
247             
248
249       END SELECT
250
251    END SUBROUTINE user_actions_ij
252
253 END MODULE user_actions_mod
Note: See TracBrowser for help on using the repository browser.