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

Last change on this file since 2716 was 2716, checked in by kanani, 6 years ago

Correction of "Former revisions" section

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