ignition.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 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 \*---------------------------------------------------------------------------*/
25 
26 #include "ignition.H"
27 #include "fvMesh.H"
28 
29 
30 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
31 
33 {
34  if (!ignite())
35  {
36  return false;
37  }
38 
39  bool igning = false;
40 
41  forAll(ignSites_, i)
42  {
43  if (ignSites_[i].igniting())
44  {
45  igning = true;
46  }
47  }
48 
49  return igning;
50 }
51 
52 
54 {
55  if (!ignite())
56  {
57  return false;
58  }
59 
60  bool igned = false;
61 
62  forAll(ignSites_, i)
63  {
64  if (ignSites_[i].ignited())
65  {
66  igned = true;
67  }
68  }
69 
70  return igned;
71 }
72 
73 
74 // ************************************************************************* //
#define forAll(list, i)
Definition: UList.H:421
bool ignite() const
Definition: ignition.H:94
bool ignited() const
Has the mixture been ignited?
Definition: ignition.C:53
bool igniting() const
Are any of the ignition site currently igniting.
Definition: ignition.C:32