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

Last change on this file since 2699 was 2696, checked in by kanani, 7 years ago

Merge of branch palm4u into trunk

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