Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
engine
ignition
ignition.H
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) 1991-2010 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
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 <
OpenFOAM/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
// Private Member Functions
65
66
//- Disallow default bitwise copy construct
67
ignition
(
const
ignition
&);
68
69
//- Disallow default bitwise assignment
70
void
operator=(
const
ignition
&);
71
72
73
public
:
74
75
// Constructors
76
77
//- Construct from Istream and database
78
ignition
(
const
dictionary
&,
const
Time
&,
const
fvMesh
&);
79
80
//- Construct from Istream and engineTime
81
ignition
(
const
dictionary
&,
const
engineTime
&,
const
fvMesh
&);
82
83
84
// Member Functions
85
86
//- Return the set of ignition sites
87
const
PtrList<ignitionSite>
&
sites
()
88
{
89
return
ignSites_;
90
}
91
92
93
// Check
94
95
bool
ignite
()
const
96
{
97
return
ignite_;
98
}
99
100
//- Are any of the ignition site currently igniting
101
bool
igniting
()
const
;
102
103
//- Has the mixture been ignited?
104
bool
ignited
()
const
;
105
};
106
107
108
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109
110
}
// End namespace Foam
111
112
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114
#endif
115
116
// ************************ vim: set sw=4 sts=4 et: ************************ //