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::zeroField 00026 00027 Description 00028 A class representing the concept of a field of 0 used to avoid unnecessary 00029 manipulations for objects which are known to be zero at compile-time. 00030 00031 Used for example as the argument to a function in which certain terms are 00032 optional, see source terms in the MULES solvers. 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef zeroField_H 00037 #define zeroField_H 00038 00039 #include <OpenFOAM/zero.H> 00040 #include <OpenFOAM/scalar.H> 00041 00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00043 00044 namespace Foam 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class zeroField Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 class zeroField 00052 : 00053 public zero 00054 { 00055 public: 00056 00057 // Constructors 00058 00059 //- Construct null 00060 zeroField() 00061 {} 00062 00063 00064 // Member Operators 00065 00066 inline scalar operator[](const label) const; 00067 00068 inline zeroField field() const; 00069 00070 inline zeroField oldTime() const; 00071 }; 00072 00073 00074 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00075 00076 } // End namespace Foam 00077 00078 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00079 00080 # include <OpenFOAM/zeroFieldI.H> 00081 00082 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00083 00084 #endif 00085 00086 // ************************ vim: set sw=4 sts=4 et: ************************ //
