source: palm/trunk/SOURCE/user_statistics.f90 @ 1692

Last change on this file since 1692 was 1683, checked in by knoop, 9 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 5.5 KB
Line 
1!> @file user_statistics.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-2014 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21!
22!
23! Former revisions:
24! -----------------
25! $Id: user_statistics.f90 1683 2015-10-07 23:57:51Z maronga $
26!
27! 1682 2015-10-07 23:56:08Z knoop
28! Code annotations made doxygen readable
29!
30! 1353 2014-04-08 15:21:23Z heinze
31! REAL constants provided with KIND-attribute
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! 1046 2012-11-09 14:38:45Z maronga
42! added preprocessor directive for parameter file check
43!
44! 1036 2012-10-22 13:43:42Z raasch
45! code put under GPL (PALM 3.9)
46!
47! 211 2008-11-11 04:46:24Z raasch
48! Former file user_interface.f90 split into one file per subroutine
49!
50! Description:
51! ------------
52!> Calculation of user-defined statistics, i.e. horizontally averaged profiles
53!> and time series.
54!> This routine is called for every statistic region sr defined by the user,
55!> but at least for the region "total domain" (sr=0).
56!> See section 3.5.4 on how to define, calculate, and output user defined
57!> quantities.
58!------------------------------------------------------------------------------!
59 SUBROUTINE user_statistics( mode, sr, tn )
60 
61
62    USE arrays_3d
63   
64    USE indices
65   
66    USE kinds
67   
68    USE netcdf_control
69   
70    USE pegrid
71   
72    USE statistics
73   
74    USE user
75
76    IMPLICIT NONE
77
78    CHARACTER (LEN=*) ::  mode   !<
79
80    INTEGER(iwp) ::  i    !<
81    INTEGER(iwp) ::  j    !<
82    INTEGER(iwp) ::  k    !<
83    INTEGER(iwp) ::  sr   !<
84    INTEGER(iwp) ::  tn   !<
85
86    REAL(wp),                                                                  &
87       DIMENSION(dots_num_palm+1:dots_max) ::                                  &
88          ts_value_l   !<
89
90
91    IF ( mode == 'profiles' )  THEN
92
93!
94!--    Sample on how to calculate horizontally averaged profiles of user-
95!--    defined quantities. Each quantity is identified by the index
96!--    "pr_palm+#" where "#" is an integer starting from 1. These
97!--    user-profile-numbers must also be assigned to the respective strings
98!--    given by data_output_pr_user in routine user_check_data_output_pr.
99!       !$OMP DO
100!       DO  i = nxl, nxr
101!          DO  j = nys, nyn
102!             DO  k = nzb_s_inner(j,i)+1, nzt
103!!
104!!--             Sample on how to calculate the profile of the resolved-scale
105!!--             horizontal momentum flux u*v*
106!                sums_l(k,pr_palm+1,tn) = sums_l(k,pr_palm+1,tn) +               &
107!                      ( 0.5_wp * ( u(k,j,i) + u(k,j,i+1) ) - hom(k,1,1,sr) ) *     &
108!                      ( 0.5_wp * ( v(k,j,i) + v(k,j+1,i) ) - hom(k,1,2,sr) )       &
109!                                                 * rmask(j,i,sr)
110!!
111!!--             Further profiles can be defined and calculated by increasing
112!!--             the second index of array sums_l (replace ... appropriately)
113!                sums_l(k,pr_palm+2,tn) = sums_l(k,pr_palm+2,tn) + ...           &
114!                                         * rmask(j,i,sr)
115!             ENDDO
116!          ENDDO
117!       ENDDO
118
119    ELSEIF ( mode == 'time_series' )  THEN
120
121!
122!--    Sample on how to add values for the user-defined time series quantities.
123!--    These have to be defined before in routine user_init. This sample
124!--    creates two time series for the absolut values of the horizontal
125!--    velocities u and v.
126!       ts_value_l = 0.0_wp
127!       ts_value_l(dots_num_palm+1) = ABS( u_max )
128!       ts_value_l(dots_num_palm+2) = ABS( v_max )
129!
130!--     Collect / send values to PE0, because only PE0 outputs the time series.
131!--     CAUTION: Collection is done by taking the sum over all processors.
132!--              You may have to normalize this sum, depending on the quantity
133!--              that you like to calculate. For serial runs, nothing has to be
134!--              done.
135!--     HINT: If the time series value that you are calculating has the same
136!--           value on all PEs, you can omit the MPI_ALLREDUCE call and
137!--           assign ts_value(dots_num_palm+1:,sr) = ts_value_l directly.
138!#if defined( __parallel ) && ! defined ( __check )
139!       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
140!       CALL MPI_ALLREDUCE( ts_value_l(dots_num_palm+1),                         &
141!                           ts_value(dots_num_palm+1,sr),                        &
142!                           dots_max-dots_num_palm, MPI_REAL, MPI_SUM, comm2d,   &
143!                           ierr )
144!#else
145!       ts_value(dots_num_palm+1:,sr) = ts_value_l
146!#endif
147
148    ENDIF
149
150 END SUBROUTINE user_statistics
151
Note: See TracBrowser for help on using the repository browser.