noSoot.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) 2013-2019 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 Class
25  Foam::radiationModels::sootModels::noSoot
26 
27 Description
28  Dummy soot model for 'none'
29 
30 SourceFiles
31  noSoot.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noSoot_H
36 #define noSoot_H
37 
38 #include "sootModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace radiationModels
45 {
46 namespace sootModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class noSoot Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class noSoot
54 :
55  public sootModel
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("none");
61 
62 
63  // Constructors
64 
65  //- Construct from components
66  noSoot(const dictionary& dict, const fvMesh& mesh, const word&);
67 
68 
69  //- Destructor
70  virtual ~noSoot();
71 
72 
73  // Member Functions
74 
75  // Edit
76 
77  //- Main update/correction routine
78  void correct();
79 
80  // Access
81 
82  //- Return Ysoot
83  const volScalarField& soot() const;
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace sootModels
90 } // End namespace radiationModels
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
virtual ~noSoot()
Destructor.
Definition: noSoot.C:63
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
noSoot(const dictionary &dict, const fvMesh &mesh, const word &)
Construct from components.
Definition: noSoot.C:52
void correct()
Main update/correction routine.
Definition: noSoot.C:69
const volScalarField & soot() const
Return Ysoot.
Definition: noSoot.C:74
A class for handling words, derived from string.
Definition: word.H:59
Dummy soot model for &#39;none&#39;.
Definition: noSoot.H:52
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Base class for soot models.
Definition: sootModel.H:50
const fvMesh & mesh() const
Reference to the mesh.
Definition: sootModel.H:112
Namespace for OpenFOAM.
const dictionary & dict() const
Reference to the dictionary.
Definition: sootModel.H:118
TypeName("none")
Runtime type information.