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

Last change on this file since 2114 was 2101, checked in by suehring, 7 years ago

last commit documented

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