00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::AverageIOField 00026 00027 Description 00028 A primitive field + average with IO. 00029 00030 SourceFiles 00031 AverageIOField.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef AverageIOField_H 00036 #define AverageIOField_H 00037 00038 #include <OpenFOAM/regIOobject.H> 00039 #include <OpenFOAM/Field.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class AverageIOField Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 template<class Type> 00051 class AverageIOField 00052 : 00053 public regIOobject, 00054 public Field<Type> 00055 { 00056 // Private data 00057 00058 //- The average of the field 00059 Type average_; 00060 00061 00062 public: 00063 00064 TypeName("AverageField"); 00065 00066 00067 // Constructors 00068 00069 //- Construct from IOobject 00070 AverageIOField 00071 ( 00072 const IOobject& 00073 ); 00074 00075 //- Construct from IOobject and size (does not set values) 00076 AverageIOField 00077 ( 00078 const IOobject&, 00079 const label size 00080 ); 00081 00082 //- Construct from components 00083 AverageIOField 00084 ( 00085 const IOobject&, 00086 const Type& average, 00087 const Field<Type>& 00088 ); 00089 00090 00091 // Member functions 00092 00093 const Type& average() const 00094 { 00095 return average_; 00096 } 00097 00098 Type& average() 00099 { 00100 return average_; 00101 } 00102 00103 bool writeData(Ostream& os) const; 00104 }; 00105 00106 00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00108 00109 } // End namespace Foam 00110 00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00112 00113 #ifdef NoRepository 00114 # include <finiteVolume/AverageIOField.C> 00115 #endif 00116 00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00118 00119 #endif 00120 00121 // ************************ vim: set sw=4 sts=4 et: ************************ //
