OpenFOAM: API Guide
v2112
The open source CFD toolbox
correlationFunctionI.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | www.openfoam.com
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
Copyright (C) 2011-2016 OpenFOAM Foundation
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
\*---------------------------------------------------------------------------*/
27
28
template
<
class
Type>
29
inline
const
Foam::Field<Foam::Field<Type>
>&
30
Foam::correlationFunction<Type>::tZeroBuffers
()
const
31
{
32
return
tZeroBuffers_;
33
}
34
35
36
template
<
class
Type>
37
inline
Foam::scalar
Foam::correlationFunction<Type>::duration
()
const
38
{
39
return
duration_;
40
}
41
42
43
template
<
class
Type>
44
inline
Foam::scalar
Foam::correlationFunction<Type>::sampleInterval
()
const
45
{
46
return
sampleInterval_;
47
}
48
49
50
template
<
class
Type>
51
inline
Foam::scalar
Foam::correlationFunction<Type>::averagingInterval
()
const
52
{
53
return
averagingInterval_;
54
}
55
56
57
template
<
class
Type>
58
inline
Foam::label
Foam::correlationFunction<Type>::sampleSteps
()
const
59
{
60
return
sampleSteps_;
61
}
62
63
64
template
<
class
Type>
65
inline
Foam::label
Foam::correlationFunction<Type>::measurandFieldSize
()
const
66
{
67
return
tZeroBuffers_[0].size();
68
}
69
70
71
// ************************************************************************* //
Foam::correlationFunction::sampleSteps
label sampleSteps() const
Definition:
correlationFunctionI.H:58
Foam::correlationFunction::duration
scalar duration() const
Definition:
correlationFunctionI.H:37
Foam::correlationFunction::averagingInterval
scalar averagingInterval() const
Definition:
correlationFunctionI.H:51
Foam::Field
Generic templated field type.
Definition:
Field.H:63
Foam::correlationFunction::tZeroBuffers
const Field< Field< Type > > & tZeroBuffers() const
Definition:
correlationFunctionI.H:30
Foam::correlationFunction::measurandFieldSize
label measurandFieldSize() const
Definition:
correlationFunctionI.H:65
Foam::correlationFunction::sampleInterval
scalar sampleInterval() const
Definition:
correlationFunctionI.H:44
src
lagrangian
molecularDynamics
molecularMeasurements
correlationFunction
correlationFunctionI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.