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

Last change on this file since 2001 was 2001, checked in by knoop, 5 years ago

last commit documented

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