combustionModelI.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) 2011-2015 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 
35 {
36  if (turbulencePtr_)
37  {
38  return turbulencePtr_->phi();
39  }
40  else
41  {
43  << "turbulencePtr_ is empty. Please use "
44  << "combustionModel::setTurbulence "
45  << "(compressibleTurbulenceModel&)"
46  << abort(FatalError);
47 
48  return turbulencePtr_->phi();
49  }
50 }
51 
52 
55 {
56  if (turbulencePtr_)
57  {
58  return *turbulencePtr_;
59  }
60  else
61  {
63  << "turbulencePtr_ is empty. Please use "
64  << "combustionModel::setTurbulence "
65  << "(compressibleTurbulenceModel& )"
66  << abort(FatalError);
67 
68  return *turbulencePtr_;
69  }
70 }
71 
72 
74 {
75  return active_;
76 }
77 
78 
80 (
82 )
83 {
84  turbulencePtr_ = &turbModel;
85 }
86 
87 
89 {
90  return coeffs_;
91 }
92 
93 // ************************************************************************* //
Foam::Switch
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:60
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::combustionModel::mesh_
const fvMesh & mesh_
Reference to the mesh database.
Definition: combustionModel.H:70
Foam::combustionModel::mesh
const fvMesh & mesh() const
Return const access to the mesh database.
Definition: combustionModelI.H:28
Foam::combustionModel::turbulence
const compressibleTurbulenceModel & turbulence() const
Return access to turbulence.
Definition: combustionModelI.H:54
Foam::combustionModel::coeffs
const dictionary & coeffs() const
Return const dictionary of the model.
Definition: combustionModelI.H:88
Foam::combustionModel::active
const Switch & active() const
Is combustion active?
Definition: combustionModelI.H:73
Foam::FatalError
error FatalError
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:131
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:318
Foam::combustionModel::setTurbulence
void setTurbulence(compressibleTurbulenceModel &turbModel)
Set turbulence.
Definition: combustionModelI.H:80
Foam::combustionModel::phi
tmp< surfaceScalarField > phi() const
Return const access to phi.
Definition: combustionModelI.H:34
Foam::compressibleTurbulenceModel
Abstract base class for turbulence models (RAS, LES and laminar).
Definition: compressibleTurbulenceModel.H:51