OpenFOAM: API Guide
v2006
The open source CFD toolbox
correlationFunctionIO.C
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 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
#include "
correlationFunction.H
"
29
#include "
IOstreams.H
"
30
31
template
<
class
Type>
32
bool
Foam::correlationFunction<Type>::writeAveraged
(
Ostream
& os)
const
33
{
34
Field<scalar>
averageCF(averaged());
35
36
forAll
(averageCF, v)
37
{
38
os << v*sampleInterval()
39
<< token::SPACE
40
<< averageCF[v]
41
<<
nl
;
42
}
43
44
return
os.
good
();
45
}
46
47
48
template
<
class
Type>
49
Foam::Ostream
& Foam::operator<<
50
(
51
Ostream
& os,
52
const
correlationFunction<Type>
& cF
53
)
54
{
55
os << cF.duration()
56
<<
nl
<< cF.sampleInterval()
57
<<
nl
<< cF.averagingInterval()
58
<<
nl
<< cF.sampleSteps()
59
<<
nl
<< cF.tZeroBuffers()
60
<< nl << static_cast<const bufferedAccumulator<scalar>&>(cF);
61
62
os.check(
FUNCTION_NAME
);
63
return
os;
64
}
65
66
67
// ************************************************************************* //
Foam::correlationFunction
Definition:
correlationFunction.H:49
IOstreams.H
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition:
stdFoam.H:296
correlationFunction.H
Foam::correlationFunction::writeAveraged
bool writeAveraged(Ostream &) const
Definition:
correlationFunctionIO.C:32
Foam::Field< scalar >
Foam::nl
constexpr char nl
Definition:
Ostream.H:385
FUNCTION_NAME
#define FUNCTION_NAME
Definition:
messageStream.H:265
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition:
Ostream.H:56
Foam::IOstream::good
bool good() const
Return true if next operation might succeed.
Definition:
IOstream.H:224
src
lagrangian
molecularDynamics
molecularMeasurements
correlationFunction
correlationFunctionIO.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.