All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ignition.C
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-2022 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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
32 {
33  if (!ignite())
34  {
35  return false;
36  }
37 
38  bool igning = false;
39 
40  forAll(ignSites_, i)
41  {
42  if (ignSites_[i].igniting())
43  {
44  igning = true;
45  }
46  }
47 
48  return igning;
49 }
50 
51 
53 {
54  if (!ignite())
55  {
56  return false;
57  }
58 
59  bool igned = false;
60 
61  forAll(ignSites_, i)
62  {
63  if (ignSites_[i].ignited())
64  {
65  igned = true;
66  }
67  }
68 
69  return igned;
70 }
71 
72 
73 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
bool ignite() const
Definition: ignition.H:85
bool ignited() const
Has the mixture been ignited?
Definition: ignition.C:52
bool igniting() const
Are any of the ignition site currently igniting.
Definition: ignition.C:31