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