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::ignition 00026 00027 Description 00028 Foam::ignition 00029 00030 SourceFiles 00031 ignition.C 00032 ignitionIO.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef ignition_H 00037 #define ignition_H 00038 00039 #include "ignitionSite.H" 00040 #include <OpenFOAM/Switch.H> 00041 00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00043 00044 namespace Foam 00045 { 00046 00047 class fvMesh; 00048 00049 /*---------------------------------------------------------------------------*\ 00050 Class ignition Declaration 00051 \*---------------------------------------------------------------------------*/ 00052 00053 class ignition 00054 { 00055 // Private data 00056 00057 const fvMesh& mesh_; 00058 00059 Switch ignite_; 00060 00061 PtrList<ignitionSite> ignSites_; 00062 00063 00064 // Private Member Functions 00065 00066 //- Disallow default bitwise copy construct 00067 ignition(const ignition&); 00068 00069 //- Disallow default bitwise assignment 00070 void operator=(const ignition&); 00071 00072 00073 public: 00074 00075 // Constructors 00076 00077 //- Construct from Istream and database 00078 ignition(const dictionary&, const Time&, const fvMesh&); 00079 00080 //- Construct from Istream and engineTime 00081 ignition(const dictionary&, const engineTime&, const fvMesh&); 00082 00083 00084 // Member Functions 00085 00086 //- Return the set of ignition sites 00087 const PtrList<ignitionSite>& sites() 00088 { 00089 return ignSites_; 00090 } 00091 00092 00093 // Check 00094 00095 bool ignite() const 00096 { 00097 return ignite_; 00098 } 00099 00100 //- Are any of the ignition site currently igniting 00101 bool igniting() const; 00102 00103 //- Has the mixture been ignited? 00104 bool ignited() const; 00105 }; 00106 00107 00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00109 00110 } // End namespace Foam 00111 00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00113 00114 #endif 00115 00116 // ************************ vim: set sw=4 sts=4 et: ************************ //
