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