ignition.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::ignition
26 
27 Description
28  Foam::ignition
29 
30 SourceFiles
31  ignition.C
32  ignitionIO.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef ignition_H
37 #define ignition_H
38 
39 #include "ignitionSite.H"
40 #include "Switch.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class fvMesh;
48 
49 /*---------------------------------------------------------------------------*\
50  Class ignition Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class ignition
54 {
55  // Private Data
56 
57  const fvMesh& mesh_;
58 
59  Switch ignite_;
60 
61  PtrList<ignitionSite> ignSites_;
62 
63 
64 public:
65 
66  // Constructors
67 
68  //- Construct from Istream and database
69  ignition(const dictionary&, const Time&, const fvMesh&);
70 
71  //- Disallow default bitwise copy construction
72  ignition(const ignition&) = delete;
73 
74 
75  // Member Functions
76 
77  //- Return the set of ignition sites
79  {
80  return ignSites_;
81  }
82 
83 
84  // Check
85 
86  bool ignite() const
87  {
88  return ignite_;
89  }
90 
91  //- Are any of the ignition site currently igniting
92  bool igniting() const;
93 
94  //- Has the mixture been ignited?
95  bool ignited() const;
96 
97 
98  // Member Operators
99 
100  //- Disallow default bitwise assignment
101  void operator=(const ignition&) = delete;
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
Foam::ignition.
Definition: ignition.H:52
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none/any.
Definition: Switch.H:60
ignition(const dictionary &, const Time &, const fvMesh &)
Construct from Istream and database.
void operator=(const ignition &)=delete
Disallow default bitwise assignment.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
bool igniting() const
Are any of the ignition site currently igniting.
const PtrList< ignitionSite > & sites()
Return the set of ignition sites.
Definition: ignition.H:77
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
bool ignited() const
Has the mixture been ignited?
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
Namespace for OpenFOAM.
bool ignite() const
Definition: ignition.H:85