source: palm/trunk/SOURCE/user_spectra.f90 @ 3049

Last change on this file since 3049 was 3049, checked in by Giersch, 7 years ago

Revision history corrected

  • Property svn:keywords set to Id
File size: 4.3 KB
Line 
1!> @file user_spectra.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-2018 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: user_spectra.f90 3049 2018-05-29 13:52:36Z Giersch $
27! Error messages revised
28!
29! 3045 2018-05-28 07:55:41Z Giersch
30! Corrected "Former revisions" section
31!
32! 2696 2017-12-14 17:12:51Z kanani
33! Change in file header (GPL part)
34!
35! 2101 2017-01-05 16:42:31Z suehring
36!
37! 2000 2016-08-20 18:09:15Z knoop
38! Forced header and separation lines into 80 columns
39!
40! 1960 2016-07-12 16:34:24Z suehring
41! Consider additional spectra for passive scalar
42!
43! 1833 2016-04-07 14:23:03Z raasch
44! spectrum renamed spectra_mod
45!
46! 1682 2015-10-07 23:56:08Z knoop
47! Code annotations made doxygen readable 
48!
49! 1320 2014-03-20 08:40:49Z raasch
50! kind-parameters added to all INTEGER and REAL declaration statements,
51! kinds are defined in new module kinds,
52! old module precision_kind is removed,
53! revision history before 2012 removed,
54! comment fields (!:) to be used for variable explanations added to
55! all variable declaration statements
56!
57! 1036 2012-10-22 13:43:42Z raasch
58! code put under GPL (PALM 3.9)
59!
60! 211 2008-11-11 04:46:24Z raasch
61! Former file user_interface.f90 split into one file per subroutine
62!
63! Description:
64! ------------
65!> Calculation of user-defined spectra.
66!> See section 3.5.4 on how to define, calculate, and output user defined
67!> quantities.
68!------------------------------------------------------------------------------!
69 SUBROUTINE user_spectra( mode, m, pr )
70 
71
72    USE arrays_3d
73   
74    USE control_parameters
75   
76    USE indices
77   
78    USE kinds
79   
80    USE spectra_mod
81   
82    USE statistics
83   
84    USE user
85
86    IMPLICIT NONE
87
88    CHARACTER (LEN=*) ::  mode
89
90    INTEGER(iwp) ::  i    !<
91    INTEGER(iwp) ::  j    !<
92    INTEGER(iwp) ::  k    !<
93    INTEGER(iwp) ::  m    !<
94    INTEGER(iwp) ::  pr   !<
95
96
97!
98!-- Sample on how to calculate spectra of user-defined quantities.
99!-- Each quantity is identified by the corresponding user profile index
100!-- "pr_palm+#" where "#" is an integer starting from 1. These
101!-- user-profile-numbers must also be assigned to the respective strings
102!-- given by data_output_pr_user in routine user_check_data_output_pr.
103    IF ( mode == 'preprocess' )  THEN
104
105       SELECT CASE ( TRIM( data_output_sp(m) ) )
106         
107          CASE ( 'u', 'v', 'w', 'pt', 'q', 's' )
108!--          Not allowed here since these are the standard quantities used in
109!--          preprocess_spectra.
110       
111!          CASE ( 'u*v*' )
112!             pr = pr_palm+1
113!             d(nzb+1:nzt,nys:nyn,nxl:nxr) = ustvst(nzb+1:nzt,nys:nyn,nxl:nxr)
114       
115          CASE DEFAULT
116             message_string = 'Spectra of ' //                                 &
117                         TRIM( data_output_sp(m) ) // ' can not be calculated'
118             CALL message( 'user_spectra', 'UI0010', 0, 1, 0, 6, 0 )
119           
120       END SELECT
121
122    ELSEIF ( mode == 'data_output' )  THEN
123
124       SELECT CASE ( TRIM( data_output_sp(m) ) )
125
126          CASE ( 'u', 'v', 'w', 'pt', 'q', 's' )
127!--          Not allowed here since these are the standard quantities used in
128!--          data_output_spectra.
129
130!          CASE ( 'u*v*' )
131!             pr = 6
132
133          CASE DEFAULT
134             message_string = 'Spectra of ' //                                 &
135                              TRIM( data_output_sp(m) ) // ' are not defined'
136             CALL message( 'user_spectra', 'UI0011', 0, 0, 0, 6, 0 )
137             
138          END SELECT
139
140    ENDIF
141
142 END SUBROUTINE user_spectra
143
Note: See TracBrowser for help on using the repository browser.