src/engine/ignition/ignition.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::ignition
  27
  28 Description
  29     Foam::ignition
  30
  31 SourceFiles
  32     ignition.C
  33     ignitionIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef ignition_H
  38 #define ignition_H
  39
  40 #include "ignitionSite.H"
  41 #include "Switch.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class fvMesh;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class ignition Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class ignition
  55 {
  56     // Private data
  57
  58         const fvMesh& mesh_;
  59
  60         Switch ignite_;
  61
  62         PtrList<ignitionSite> ignSites_;
  63
  64
  65     // Private Member Functions
  66
  67         //- Disallow default bitwise copy construct
  68         ignition(const ignition&);
  69
  70         //- Disallow default bitwise assignment
  71         void operator=(const ignition&);
  72
  73
  74 public:
  75
  76     // Constructors
  77
  78         //- Construct from Istream and database
  79         ignition(const dictionary&, const Time&, const fvMesh&);
  80
  81         //- Construct from Istream and engineTime
  82         ignition(const dictionary&, const engineTime&, const fvMesh&);
  83
  84
  85     // Member Functions
  86
  87         //- Return the set of ignition sites
  88         const PtrList<ignitionSite>& sites()
  89         {
  90             return ignSites_;
  91         }
  92
  93
  94         // Check
  95
  96             bool ignite() const
  97             {
  98                 return ignite_;
  99             }
 100
 101             //- Are any of the ignition site currently igniting
 102             bool igniting() const;
 103
 104             //- Has the mixture been ignited?
 105             bool ignited() const;
 106 };
 107
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 } // End namespace Foam
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 #endif
 116
 117 // ************************************************************************* //