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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "ignition.H"
29 #include "fvMesh.H"
30 
31 
32 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
33 
35 {
36  if (!ignite())
37  {
38  return false;
39  }
40 
41  bool igning = false;
42 
43  forAll(ignSites_, i)
44  {
45  if (ignSites_[i].igniting())
46  {
47  igning = true;
48  }
49  }
50 
51  return igning;
52 }
53 
54 
56 {
57  if (!ignite())
58  {
59  return false;
60  }
61 
62  bool igned = false;
63 
64  forAll(ignSites_, i)
65  {
66  if (ignSites_[i].ignited())
67  {
68  igned = true;
69  }
70  }
71 
72  return igned;
73 }
74 
75 
76 // ************************************************************************* //
Foam::ignition::ignited
bool ignited() const
Has the mixture been ignited?
Definition: ignition.C:55
Foam::ignition::ignite
bool ignite() const
Definition: ignition.H:97
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
ignition.H
fvMesh.H
Foam::ignition::igniting
bool igniting() const
Are any of the ignition site currently igniting.
Definition: ignition.C:34