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

Last change on this file since 1834 was 1834, checked in by raasch, 5 years ago

last commit documented

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