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

Last change on this file since 3655 was 3655, checked in by knoop, 3 years ago

Bugfix: made "unit" and "found" intend INOUT in module interface subroutines + automatic copyright update

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