source: palm/trunk/SOURCE/user_data_output_2d.f90 @ 1818

Last change on this file since 1818 was 1818, checked in by maronga, 6 years ago

last commit documented / copyright update

  • Property svn:keywords set to Id
File size: 3.6 KB
Line 
1!> @file user_data_output_2d.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!
22!
23! Former revisions:
24! -----------------
25! $Id: user_data_output_2d.f90 1818 2016-04-06 15:53:27Z maronga $
26!
27! 1682 2015-10-07 23:56:08Z knoop
28! Code annotations made doxygen readable
29!
30! 1551 2015-03-03 14:18:16Z maronga
31! Replaced nzb and nzt+1 with the new array bounds nzb_do and nzt_do.
32!
33! 1320 2014-03-20 08:40:49Z raasch
34! kind-parameters added to all INTEGER and REAL declaration statements,
35! kinds are defined in new module kinds,
36! revision history before 2012 removed,
37! comment fields (!:) to be used for variable explanations added to
38! all variable declaration statements
39!
40! 1036 2012-10-22 13:43:42Z raasch
41! code put under GPL (PALM 3.9)
42!
43! 211 2008-11-11 04:46:24Z raasch
44! Former file user_interface.f90 split into one file per subroutine
45!
46! Description:
47! ------------
48!> Resorts the user-defined output quantity with indices (k,j,i) to a
49!> temporary array with indices (i,j,k) and sets the grid on which it is defined.
50!> Allowed values for grid are "zu" and "zw".
51!------------------------------------------------------------------------------!
52 SUBROUTINE user_data_output_2d( av, variable, found, grid, local_pf, two_d, nzb_do, nzt_do )
53 
54
55    USE indices
56
57    USE kinds
58
59    USE user
60
61    IMPLICIT NONE
62
63    CHARACTER (LEN=*) ::  grid     !<
64    CHARACTER (LEN=*) ::  variable !<
65
66    INTEGER(iwp) ::  av !<
67    INTEGER(iwp) ::  i  !<
68    INTEGER(iwp) ::  j  !<
69    INTEGER(iwp) ::  k  !<
70    INTEGER(iwp) ::  nzb_do !< lower limit of the domain (usually nzb)
71    INTEGER(iwp) ::  nzt_do !< upper limit of the domain (usually nzt+1)
72
73    LOGICAL      ::  found !<
74    LOGICAL      ::  two_d !< flag parameter that indicates 2D variables (horizontal cross sections)
75
76    REAL(wp), DIMENSION(nxlg:nxrg,nysg:nyng,nzb:nzt+1) ::  local_pf !<
77
78
79    found = .TRUE.
80
81    SELECT CASE ( TRIM( variable ) )
82
83!
84!--    Uncomment and extend the following lines, if necessary.
85!--    The arrays for storing the user defined quantities (here u2 and u2_av)
86!--    have to be declared and defined by the user!
87!--    Sample for user-defined output:
88!       CASE ( 'u2_xy', 'u2_xz', 'u2_yz' )
89!          IF ( av == 0 )  THEN
90!             DO  i = nxlg, nxrg
91!                DO  j = nysg, nyng
92!                   DO  k = nzb_do, nzt_do
93!                      local_pf(i,j,k) = u2(k,j,i)
94!                   ENDDO
95!                ENDDO
96!             ENDDO
97!          ELSE
98!             DO  i = nxlg, nxrg
99!                DO  j = nysg, nyng
100!                   DO  k = nzb_do, nzt_do
101!                      local_pf(i,j,k) = u2_av(k,j,i)
102!                   ENDDO
103!                ENDDO
104!             ENDDO
105!          ENDIF
106!
107!          grid = 'zu'
108
109
110       CASE DEFAULT
111          found = .FALSE.
112          grid  = 'none'
113
114    END SELECT
115
116
117 END SUBROUTINE user_data_output_2d
118
Note: See TracBrowser for help on using the repository browser.