source: palm/trunk/SOURCE/user_data_output_2d.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.6 KB
RevLine 
[1682]1!> @file user_data_output_2d.f90
[1036]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!
[1310]16! Copyright 1997-2014 Leibniz Universitaet Hannover
[1036]17!--------------------------------------------------------------------------------!
18!
[484]19! Current revisions:
[211]20! -----------------
[1682]21! Code annotations made doxygen readable
[1321]22!
23! Former revisions:
24! -----------------
25! $Id: user_data_output_2d.f90 1682 2015-10-07 23:56:08Z knoop $
26!
[1552]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!
[1321]30! 1320 2014-03-20 08:40:49Z raasch
[1320]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
[211]36!
[1037]37! 1036 2012-10-22 13:43:42Z raasch
38! code put under GPL (PALM 3.9)
39!
[226]40! 211 2008-11-11 04:46:24Z raasch
41! Former file user_interface.f90 split into one file per subroutine
42!
[211]43! Description:
44! ------------
[1682]45!> Resorts the user-defined output quantity with indices (k,j,i) to a
46!> temporary array with indices (i,j,k) and sets the grid on which it is defined.
47!> Allowed values for grid are "zu" and "zw".
[211]48!------------------------------------------------------------------------------!
[1682]49 SUBROUTINE user_data_output_2d( av, variable, found, grid, local_pf, two_d, nzb_do, nzt_do )
50 
[211]51
52    USE indices
[1320]53
54    USE kinds
55
[211]56    USE user
57
58    IMPLICIT NONE
59
[1682]60    CHARACTER (LEN=*) ::  grid     !<
61    CHARACTER (LEN=*) ::  variable !<
[211]62
[1682]63    INTEGER(iwp) ::  av !<
64    INTEGER(iwp) ::  i  !<
65    INTEGER(iwp) ::  j  !<
66    INTEGER(iwp) ::  k  !<
67    INTEGER(iwp) ::  nzb_do !< lower limit of the domain (usually nzb)
68    INTEGER(iwp) ::  nzt_do !< upper limit of the domain (usually nzt+1)
[211]69
[1682]70    LOGICAL      ::  found !<
71    LOGICAL      ::  two_d !< flag parameter that indicates 2D variables (horizontal cross sections)
[211]72
[1682]73    REAL(wp), DIMENSION(nxlg:nxrg,nysg:nyng,nzb:nzt+1) ::  local_pf !<
[211]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_xy', 'u2_xz', 'u2_yz' )
86!          IF ( av == 0 )  THEN
[667]87!             DO  i = nxlg, nxrg
88!                DO  j = nysg, nyng
[1551]89!                   DO  k = nzb_do, nzt_do
[211]90!                      local_pf(i,j,k) = u2(k,j,i)
91!                   ENDDO
92!                ENDDO
93!             ENDDO
94!          ELSE
[667]95!             DO  i = nxlg, nxrg
96!                DO  j = nysg, nyng
[1551]97!                   DO  k = nzb_do, nzt_do
[211]98!                      local_pf(i,j,k) = u2_av(k,j,i)
99!                   ENDDO
100!                ENDDO
101!             ENDDO
102!          ENDIF
103!
104!          grid = 'zu'
105
[343]106
[211]107       CASE DEFAULT
108          found = .FALSE.
109          grid  = 'none'
110
111    END SELECT
112
113
114 END SUBROUTINE user_data_output_2d
115
Note: See TracBrowser for help on using the repository browser.