AverageIOField: Changed the average value to be member data.
[OpenFOAM-1.6.x.git] / src / finiteVolume / fields / fvPatchFields / derived / timeVaryingMappedFixedValue / AverageIOField.H
blob25634ab109dc503220d9ce4ee8cc71d9d73f92f8
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::AverageIOField
28 Description
29     A primitive field + average with IO.
31 SourceFiles
32     AverageIOField.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef AverageIOField_H
37 #define AverageIOField_H
39 #include "regIOobject.H"
40 #include "Field.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                         Class AverageIOField Declaration
49 \*---------------------------------------------------------------------------*/
51 template<class Type>
52 class AverageIOField
54     public regIOobject,
55     public Field<Type>
57     // Private data
59         //- The average of the field
60         Type average_;
63 public:
65     TypeName("AverageField");
68     // Constructors
70         //- Construct from IOobject
71         AverageIOField
72         (
73             const IOobject&
74         );
76         //- Construct from IOobject and size (does not set values)
77         AverageIOField
78         (
79             const IOobject&,
80             const label size
81         );
83         //- Construct from components
84         AverageIOField
85         (
86             const IOobject&,
87             const Type& average,
88             const Field<Type>&
89         );
92     // Member functions
94         const Type& average() const
95         {
96             return average_;
97         }
99         Type& average()
100         {
101             return average_;
102         }
104         bool writeData(Ostream& os) const;
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 } // End namespace Foam
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 #ifdef NoRepository
115 #   include "AverageIOField.C"
116 #endif
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 #endif
122 // ************************************************************************* //