source: palm/trunk/SOURCE/user_data_output_3d.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: 3.4 KB
Line 
1!> @file user_data_output_3d.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: user_data_output_3d.f90 1682 2015-10-07 23:56:08Z knoop $
26!
27! 1551 2015-03-03 14:18:16Z maronga
28! Replaced nzb and nzt+1 with the new array bounds nzb_do and nzt_do.
29!
30! 1320 2014-03-20 08:40:49Z raasch
31! kind-parameters added to all INTEGER and REAL declaration statements,
32! kinds are defined in new module kinds,
33! revision history before 2012 removed,
34! comment fields (!:) to be used for variable explanations added to
35! all variable declaration statements
36!
37! 1106 2013-03-04 05:31:38Z raasch
38! array_kind renamed precision_kind
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).
50!------------------------------------------------------------------------------!
51 SUBROUTINE user_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
52 
53
54    USE indices
55
56    USE kinds
57
58    USE user
59
60    IMPLICIT NONE
61
62    CHARACTER (LEN=*) ::  variable !<
63
64    INTEGER(iwp) ::  av    !<
65    INTEGER(iwp) ::  i     !<
66    INTEGER(iwp) ::  j     !<
67    INTEGER(iwp) ::  k     !<
68    INTEGER(iwp) ::  nzb_do !< lower limit of the data output (usually 0)
69    INTEGER(iwp) ::  nzt_do !< vertical upper limit of the data output (usually nz_do3d)
70
71    LOGICAL      ::  found !<
72
73   REAL(sp), DIMENSION(nxlg:nxrg,nysg:nyng,nzb_do:nzt_do) ::  local_pf !<
74
75
76    found = .TRUE.
77
78    SELECT CASE ( TRIM( variable ) )
79
80!
81!--    Uncomment and extend the following lines, if necessary.
82!--    The arrays for storing the user defined quantities (here u2 and u2_av)
83!--    have to be declared and defined by the user!
84!--    Sample for user-defined output:
85!       CASE ( 'u2' )
86!          IF ( av == 0 )  THEN
87!             DO  i = nxlg, nxrg
88!                DO  j = nysg, nyng
89!                   DO  k = nzb_do, nzt_do
90!                      local_pf(i,j,k) = u2(k,j,i)
91!                   ENDDO
92!                ENDDO
93!             ENDDO
94!          ELSE
95!             DO  i = nxlg, nxrg
96!                DO  j = nysg, nyng
97!                   DO  k = nzb_do, nzt_do
98!                      local_pf(i,j,k) = u2_av(k,j,i)
99!                   ENDDO
100!                ENDDO
101!             ENDDO
102!          ENDIF
103!
104
105       CASE DEFAULT
106          found = .FALSE.
107
108    END SELECT
109
110
111 END SUBROUTINE user_data_output_3d
112
Note: See TracBrowser for help on using the repository browser.