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

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

last commit documented

  • Property svn:keywords set to Id
File size: 3.5 KB
RevLine 
[1682]1!> @file user_data_output_3d.f90
[2000]2!------------------------------------------------------------------------------!
[1036]3! This file is part of PALM.
4!
[2000]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.
[1036]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!
[2101]17! Copyright 1997-2017 Leibniz Universitaet Hannover
[2000]18!------------------------------------------------------------------------------!
[1036]19!
[484]20! Current revisions:
[1106]21! ------------------
[1321]22!
[2001]23!
[1321]24! Former revisions:
25! -----------------
26! $Id: user_data_output_3d.f90 2101 2017-01-05 16:42:31Z suehring $
27!
[2001]28! 2000 2016-08-20 18:09:15Z knoop
29! Forced header and separation lines into 80 columns
30!
[1683]31! 1682 2015-10-07 23:56:08Z knoop
32! Code annotations made doxygen readable
33!
[1552]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!
[1321]37! 1320 2014-03-20 08:40:49Z raasch
[1320]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
[1321]42! all variable declaration statements
[211]43!
[1107]44! 1106 2013-03-04 05:31:38Z raasch
45! array_kind renamed precision_kind
46!
[1037]47! 1036 2012-10-22 13:43:42Z raasch
48! code put under GPL (PALM 3.9)
49!
[226]50! 211 2008-11-11 04:46:24Z raasch
51! Former file user_interface.f90 split into one file per subroutine
52!
[211]53! Description:
54! ------------
[1682]55!> Resorts the user-defined output quantity with indices (k,j,i) to a
56!> temporary array with indices (i,j,k).
[211]57!------------------------------------------------------------------------------!
[1682]58 SUBROUTINE user_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
59 
[211]60
61    USE indices
[1320]62
63    USE kinds
64
[211]65    USE user
66
67    IMPLICIT NONE
68
[1682]69    CHARACTER (LEN=*) ::  variable !<
[211]70
[1682]71    INTEGER(iwp) ::  av    !<
72    INTEGER(iwp) ::  i     !<
73    INTEGER(iwp) ::  j     !<
74    INTEGER(iwp) ::  k     !<
75    INTEGER(iwp) ::  nzb_do !< lower limit of the data output (usually 0)
76    INTEGER(iwp) ::  nzt_do !< vertical upper limit of the data output (usually nz_do3d)
[211]77
[1682]78    LOGICAL      ::  found !<
[211]79
[1682]80   REAL(sp), DIMENSION(nxlg:nxrg,nysg:nyng,nzb_do:nzt_do) ::  local_pf !<
[211]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' )
93!          IF ( av == 0 )  THEN
[667]94!             DO  i = nxlg, nxrg
95!                DO  j = nysg, nyng
[1551]96!                   DO  k = nzb_do, nzt_do
[211]97!                      local_pf(i,j,k) = u2(k,j,i)
98!                   ENDDO
99!                ENDDO
100!             ENDDO
101!          ELSE
[667]102!             DO  i = nxlg, nxrg
103!                DO  j = nysg, nyng
[1551]104!                   DO  k = nzb_do, nzt_do
[211]105!                      local_pf(i,j,k) = u2_av(k,j,i)
106!                   ENDDO
107!                ENDDO
108!             ENDDO
109!          ENDIF
110!
111
112       CASE DEFAULT
113          found = .FALSE.
114
115    END SELECT
116
117
118 END SUBROUTINE user_data_output_3d
119
Note: See TracBrowser for help on using the repository browser.