All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
correlationFunctionI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 template<class Type>
27 inline const Foam::Field<Foam::Field<Type>>&
29 {
30  return tZeroBuffers_;
31 }
32 
33 
34 template<class Type>
35 inline Foam::scalar Foam::correlationFunction<Type>::duration() const
36 {
37  return duration_;
38 }
39 
40 
41 template<class Type>
43 {
44  return sampleInterval_;
45 }
46 
47 
48 template<class Type>
50 {
51  return averagingInterval_;
52 }
53 
54 
55 template<class Type>
57 {
58  return sampleSteps_;
59 }
60 
61 
62 template<class Type>
64 {
65  return tZeroBuffers_[0].size();
66 }
67 
68 
69 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Pre-declare SubField and related Field type.
Definition: Field.H:56
const Field< Field< Type > > & tZeroBuffers() const