combustionModelI.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-2018 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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
29 {
30  return mesh_;
31 }
32 
33 
36 {
37  return turb_;
38 }
39 
40 
42 {
43  return turbulence().rho();
44 }
45 
46 
48 {
49  return turbulence().alphaRhoPhi();
50 }
51 
52 
54 {
55  return active_;
56 }
57 
58 
60 {
61  return coeffs_;
62 }
63 
64 // ************************************************************************* //
const fvMesh & mesh_
Reference to the mesh database.
const compressibleTurbulenceModel & turbulence() const
Return access to turbulence.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const fvMesh & mesh() const
Return const access to the mesh database.
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.
Definition: Switch.H:60
const Switch & active() const
Is combustion active?
const dictionary & coeffs() const
Return const dictionary of the model.
const volScalarField & rho() const
Return const access to rho.
const compressibleTurbulenceModel & turb_
Reference to the turbulence model.
const surfaceScalarField & alphaRhoPhi() const
Access function to phase flux field.
Switch active_
Active.
dictionary coeffs_
Dictionary of the model.
const volScalarField & rho() const
Return the density field.
Abstract base class for turbulence models (RAS, LES and laminar).
tmp< surfaceScalarField > phi() const
Return const access to phi.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53