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 | Copyright (C) 2011 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 #include "correlationFunction.H"
27 #include "IOstreams.H"
28 
29 template<class Type>
31 {
32  Field<scalar> averageCF(averaged());
33 
34  forAll(averageCF, v)
35  {
36  os << v*sampleInterval()
37  << token::SPACE
38  << averageCF[v]
39  << nl;
40  }
41 
42  return os.good();
43 }
44 
45 
46 template<class Type>
47 Foam::Ostream& Foam::operator<<
48 (
49  Ostream& os,
51 )
52 {
53  os << cF.duration()
54  << nl << cF.sampleInterval()
55  << nl << cF.averagingInterval()
56  << nl << cF.sampleSteps()
57  << nl << cF.tZeroBuffers()
58  << nl << static_cast<const bufferedAccumulator<scalar>&>(cF);
59 
60  // Check state of Ostream
61  os.check
62  (
63  "Foam::Ostream& Foam::operator<<"
64  "(Ostream&, const correlationFunction<Type>&)"
65  );
66 
67  return os;
68 }
69 
70 
71 // ************************************************************************* //
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
static const char nl
Definition: Ostream.H:260
#define forAll(list, i)
Definition: UList.H:421
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:333
bool writeAveraged(Ostream &) const
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53