source: palm/trunk/SOURCE/user_check_data_output_pr.f90 @ 1683

Last change on this file since 1683 was 1683, checked in by knoop, 6 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 3.5 KB
Line 
1!> @file user_check_data_output_pr.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!
22!
23! Former revisions:
24! -----------------
25! $Id: user_check_data_output_pr.f90 1683 2015-10-07 23:57:51Z knoop $
26!
27! 1682 2015-10-07 23:56:08Z knoop
28! Code annotations made doxygen readable
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! 1036 2012-10-22 13:43:42Z raasch
38! code put under GPL (PALM 3.9)
39!
40! 211 2008-11-11 04:46:24Z raasch
41! Former file user_interface.f90 split into one file per subroutine
42!
43! Description:
44! ------------
45!> Set the unit of user defined profile output quantities. For those variables
46!> not recognized by the user, the parameter unit is set to "illegal", which
47!> tells the calling routine that the output variable is not defined and leads
48!> to a program abort.
49!------------------------------------------------------------------------------!
50 SUBROUTINE user_check_data_output_pr( variable, var_count, unit )
51 
52
53    USE arrays_3d
54
55    USE indices
56
57    USE kinds
58
59    USE netcdf_control
60
61    USE profil_parameter
62
63    USE statistics
64
65    USE user
66
67    IMPLICIT NONE
68
69    CHARACTER (LEN=*) ::  unit     !<
70    CHARACTER (LEN=*) ::  variable !<
71
72    INTEGER(iwp) ::  user_pr_index !<
73    INTEGER(iwp) ::  var_count     !<
74
75    SELECT CASE ( TRIM( variable ) )
76
77!
78!--    Uncomment and extend the following lines, if necessary.
79!--    Add additional CASE statements depending on the number of quantities
80!--    for which profiles are to be calculated. The respective calculations
81!--    to be performed have to be added in routine user_statistics.
82!--    The quantities are (internally) identified by a user-profile-number
83!--    (see variable "user_pr_index" below). The first user-profile must be assigned
84!--    the number "pr_palm+1", the second one "pr_palm+2", etc. The respective
85!--    user-profile-numbers have also to be used in routine user_statistics!
86!       CASE ( 'u*v*' )                      ! quantity string as given in
87!                                            ! data_output_pr_user
88!          user_pr_index = pr_palm + 1
89!          dopr_index(var_count)  = user_pr_index    ! quantities' user-profile-number
90!          dopr_unit(var_count)   = 'm2/s2'  ! quantity unit
91!          hom(:,2,user_pr_index,:)       = SPREAD( zu, 2, statistic_regions+1 )
92!                                            ! grid on which the quantity is
93!                                            ! defined (use zu or zw)
94
95       CASE DEFAULT
96          unit = 'illegal'
97
98    END SELECT
99
100
101 END SUBROUTINE user_check_data_output_pr
102
Note: See TracBrowser for help on using the repository browser.