AverageIOField.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 | 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 Class
25  Foam::AverageIOField
26 
27 Description
28  A primitive field + average with IO.
29 
30 SourceFiles
31  AverageIOField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef AverageIOField_H
36 #define AverageIOField_H
37 
38 #include "regIOobject.H"
39 #include "Field.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class AverageIOField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class AverageIOField
52 :
53  public regIOobject,
54  public Field<Type>
55 {
56  // Private data
57 
58  //- The average of the field
59  Type average_;
60 
61 
62 public:
63 
64  TypeName("AverageField");
65 
66 
67  // Constructors
68 
69  //- Construct from IOobject
71  (
72  const IOobject&
73  );
74 
75  //- Construct from IOobject and size (does not set values)
77  (
78  const IOobject&,
79  const label size
80  );
81 
82  //- Construct from components
84  (
85  const IOobject&,
86  const Type& average,
87  const Field<Type>&
88  );
89 
90 
91  // Member functions
92 
93  const Type& average() const
94  {
95  return average_;
96  }
97 
98  Type& average()
99  {
100  return average_;
101  }
102 
103  bool writeData(Ostream& os) const;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #ifdef NoRepository
114 # include "AverageIOField.C"
115 #endif
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
AverageIOField(const IOobject &)
Construct from IOobject.
A primitive field + average with IO.
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
bool writeData(Ostream &os) const
Pure virtual writaData function.
Namespace for OpenFOAM.
const Type & average() const
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
Pre-declare SubField and related Field type.
Definition: Field.H:57
TypeName("AverageField")
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:60
label size() const
Return the number of elements in the UList.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53