AverageField.C
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-2019 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 "AverageField.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 :
33  Field<Type>(size),
34  average_(Zero)
35 {}
36 
37 
38 template<class Type>
40 (
41  const Field<Type>& f,
42  const Type& average
43 )
44 :
45  Field<Type>(f),
46  average_(average)
47 {}
48 
49 
50 template<class Type>
52 :
53  Field<Type>(is),
54  average_(pTraits<Type>(is))
55 {}
56 
57 
58 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
59 
60 template<class Type>
62 {
63  return average_;
64 }
65 
66 
67 template<class Type>
69 {
70  return average_;
71 }
72 
73 
74 template<class Type>
76 {
77  os << static_cast<const Field<Type>&>(*this)
78  << token::NL
79  << average_;
80 
81  return os.good();
82 }
83 
84 
85 // ************************************************************************* //
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
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Traits class for primitives.
Definition: pTraits.H:50
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:333
Pre-declare SubField and related Field type.
Definition: Field.H:56
static const zero Zero
Definition: zero.H:97
AverageField(const label size)
Construct from size (does not set values)
Definition: AverageField.C:31
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
labelList f(nPoints)
bool writeData(Ostream &os) const
Definition: AverageField.C:75
const Type & average() const
Definition: AverageField.C:61