[1682] | 1 | !> @file user_spectra.f90 |
---|
[2000] | 2 | !------------------------------------------------------------------------------! |
---|
[2696] | 3 | ! This file is part of the PALM model system. |
---|
[1036] | 4 | ! |
---|
[2000] | 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. |
---|
[1036] | 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 | ! |
---|
[2718] | 17 | ! Copyright 1997-2018 Leibniz Universitaet Hannover |
---|
[2000] | 18 | !------------------------------------------------------------------------------! |
---|
[1036] | 19 | ! |
---|
[258] | 20 | ! Current revisions: |
---|
[211] | 21 | ! ----------------- |
---|
[1683] | 22 | ! |
---|
[3049] | 23 | ! |
---|
[1321] | 24 | ! Former revisions: |
---|
| 25 | ! ----------------- |
---|
| 26 | ! $Id: user_spectra.f90 3421 2018-10-24 18:39:32Z gronemeier $ |
---|
[3421] | 27 | ! Renamed output variables |
---|
| 28 | ! |
---|
| 29 | ! 3049 2018-05-29 13:52:36Z Giersch |
---|
[3049] | 30 | ! Error messages revised |
---|
| 31 | ! |
---|
| 32 | ! 3045 2018-05-28 07:55:41Z Giersch |
---|
[2716] | 33 | ! Corrected "Former revisions" section |
---|
| 34 | ! |
---|
| 35 | ! 2696 2017-12-14 17:12:51Z kanani |
---|
| 36 | ! Change in file header (GPL part) |
---|
[1321] | 37 | ! |
---|
[2716] | 38 | ! 2101 2017-01-05 16:42:31Z suehring |
---|
| 39 | ! |
---|
[2001] | 40 | ! 2000 2016-08-20 18:09:15Z knoop |
---|
| 41 | ! Forced header and separation lines into 80 columns |
---|
| 42 | ! |
---|
[1961] | 43 | ! 1960 2016-07-12 16:34:24Z suehring |
---|
| 44 | ! Consider additional spectra for passive scalar |
---|
| 45 | ! |
---|
[1834] | 46 | ! 1833 2016-04-07 14:23:03Z raasch |
---|
| 47 | ! spectrum renamed spectra_mod |
---|
| 48 | ! |
---|
[1683] | 49 | ! 1682 2015-10-07 23:56:08Z knoop |
---|
| 50 | ! Code annotations made doxygen readable |
---|
| 51 | ! |
---|
[1321] | 52 | ! 1320 2014-03-20 08:40:49Z raasch |
---|
[1320] | 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 |
---|
[211] | 59 | ! |
---|
[1037] | 60 | ! 1036 2012-10-22 13:43:42Z raasch |
---|
| 61 | ! code put under GPL (PALM 3.9) |
---|
| 62 | ! |
---|
[226] | 63 | ! 211 2008-11-11 04:46:24Z raasch |
---|
| 64 | ! Former file user_interface.f90 split into one file per subroutine |
---|
| 65 | ! |
---|
[211] | 66 | ! Description: |
---|
| 67 | ! ------------ |
---|
[1682] | 68 | !> Calculation of user-defined spectra. |
---|
| 69 | !> See section 3.5.4 on how to define, calculate, and output user defined |
---|
| 70 | !> quantities. |
---|
[211] | 71 | !------------------------------------------------------------------------------! |
---|
[1682] | 72 | SUBROUTINE user_spectra( mode, m, pr ) |
---|
| 73 | |
---|
[211] | 74 | |
---|
| 75 | USE arrays_3d |
---|
[1320] | 76 | |
---|
[258] | 77 | USE control_parameters |
---|
[1320] | 78 | |
---|
[211] | 79 | USE indices |
---|
[1320] | 80 | |
---|
| 81 | USE kinds |
---|
| 82 | |
---|
[1833] | 83 | USE spectra_mod |
---|
[1320] | 84 | |
---|
[211] | 85 | USE statistics |
---|
[1320] | 86 | |
---|
[211] | 87 | USE user |
---|
| 88 | |
---|
| 89 | IMPLICIT NONE |
---|
| 90 | |
---|
| 91 | CHARACTER (LEN=*) :: mode |
---|
| 92 | |
---|
[1682] | 93 | INTEGER(iwp) :: i !< |
---|
| 94 | INTEGER(iwp) :: j !< |
---|
| 95 | INTEGER(iwp) :: k !< |
---|
| 96 | INTEGER(iwp) :: m !< |
---|
| 97 | INTEGER(iwp) :: pr !< |
---|
[211] | 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 | |
---|
[3421] | 110 | CASE ( 'u', 'v', 'w', 'theta', 'q', 's' ) |
---|
[211] | 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 |
---|
[1320] | 119 | message_string = 'Spectra of ' // & |
---|
[274] | 120 | TRIM( data_output_sp(m) ) // ' can not be calculated' |
---|
[3046] | 121 | CALL message( 'user_spectra', 'UI0010', 0, 1, 0, 6, 0 ) |
---|
[258] | 122 | |
---|
[211] | 123 | END SELECT |
---|
| 124 | |
---|
| 125 | ELSEIF ( mode == 'data_output' ) THEN |
---|
| 126 | |
---|
| 127 | SELECT CASE ( TRIM( data_output_sp(m) ) ) |
---|
| 128 | |
---|
[3421] | 129 | CASE ( 'u', 'v', 'w', 'theta', 'q', 's' ) |
---|
[211] | 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 |
---|
[1320] | 137 | message_string = 'Spectra of ' // & |
---|
[258] | 138 | TRIM( data_output_sp(m) ) // ' are not defined' |
---|
| 139 | CALL message( 'user_spectra', 'UI0011', 0, 0, 0, 6, 0 ) |
---|
| 140 | |
---|
[211] | 141 | END SELECT |
---|
| 142 | |
---|
| 143 | ENDIF |
---|
| 144 | |
---|
| 145 | END SUBROUTINE user_spectra |
---|
| 146 | |
---|