source: palm/trunk/SOURCE/user_data_output_3d.f90 @ 2716

Last change on this file since 2716 was 2716, checked in by kanani, 4 years ago

Correction of "Former revisions" section

  • Property svn:keywords set to Id
File size: 3.7 KB
Line 
1!> @file user_data_output_3d.f90
2!------------------------------------------------------------------------------!
3! This file is part of the PALM model system.
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_3d.f90 2716 2017-12-29 16:35:59Z kanani $
27! Corrected "Former revisions" section
28!
29! 2696 2017-12-14 17:12:51Z kanani
30! Change in file header (GPL part)
31!
32! 2512 2017-10-04 08:26:59Z raasch
33! ghost layer points removed from output array local_pf
34!
35! 2101 2017-01-05 16:42:31Z suehring
36!
37! 2000 2016-08-20 18:09:15Z knoop
38! Forced header and separation lines into 80 columns
39!
40! 1682 2015-10-07 23:56:08Z knoop
41! Code annotations made doxygen readable
42!
43! 1551 2015-03-03 14:18:16Z maronga
44! Replaced nzb and nzt+1 with the new array bounds nzb_do and nzt_do.
45!
46! 1320 2014-03-20 08:40:49Z raasch
47! kind-parameters added to all INTEGER and REAL declaration statements,
48! kinds are defined in new module kinds,
49! revision history before 2012 removed,
50! comment fields (!:) to be used for variable explanations added to
51! all variable declaration statements
52!
53! 1106 2013-03-04 05:31:38Z raasch
54! array_kind renamed precision_kind
55!
56! 1036 2012-10-22 13:43:42Z raasch
57! code put under GPL (PALM 3.9)
58!
59! 211 2008-11-11 04:46:24Z raasch
60! Former file user_interface.f90 split into one file per subroutine
61!
62! Description:
63! ------------
64!> Resorts the user-defined output quantity with indices (k,j,i) to a
65!> temporary array with indices (i,j,k).
66!------------------------------------------------------------------------------!
67 SUBROUTINE user_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
68 
69
70    USE indices
71
72    USE kinds
73
74    USE user
75
76    IMPLICIT NONE
77
78    CHARACTER (LEN=*) ::  variable !<
79
80    INTEGER(iwp) ::  av    !<
81    INTEGER(iwp) ::  i     !<
82    INTEGER(iwp) ::  j     !<
83    INTEGER(iwp) ::  k     !<
84    INTEGER(iwp) ::  nzb_do !< lower limit of the data output (usually 0)
85    INTEGER(iwp) ::  nzt_do !< vertical upper limit of the data output (usually nz_do3d)
86
87    LOGICAL      ::  found !<
88
89   REAL(sp), DIMENSION(nxl:nxr,nys:nyn,nzb_do:nzt_do) ::  local_pf !<
90
91
92    found = .TRUE.
93
94    SELECT CASE ( TRIM( variable ) )
95
96!
97!--    Uncomment and extend the following lines, if necessary.
98!--    The arrays for storing the user defined quantities (here u2 and u2_av)
99!--    have to be declared and defined by the user!
100!--    Sample for user-defined output:
101!       CASE ( 'u2' )
102!          IF ( av == 0 )  THEN
103!             DO  i = nxl, nxr
104!                DO  j = nys, nyn
105!                   DO  k = nzb_do, nzt_do
106!                      local_pf(i,j,k) = u2(k,j,i)
107!                   ENDDO
108!                ENDDO
109!             ENDDO
110!          ELSE
111!             DO  i = nxl, nxr
112!                DO  j = nys, nyn
113!                   DO  k = nzb_do, nzt_do
114!                      local_pf(i,j,k) = u2_av(k,j,i)
115!                   ENDDO
116!                ENDDO
117!             ENDDO
118!          ENDIF
119!
120
121       CASE DEFAULT
122          found = .FALSE.
123
124    END SELECT
125
126
127 END SUBROUTINE user_data_output_3d
128
Note: See TracBrowser for help on using the repository browser.