noSoot.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2013-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::radiation::noSoot
28
29Group
30 grpRadiationSootSubModels
31
32Description
33 noSoot
34
35SourceFiles
36 noSoot.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef noSoot_H
41#define noSoot_H
42
43#include "sootModel.H"
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49namespace radiation
50{
51
52/*---------------------------------------------------------------------------*\
53 Class noSoot Declaration
54\*---------------------------------------------------------------------------*/
55class noSoot
56:
57 public sootModel
58{
59
60public:
61
62 //- Runtime type information
63 TypeName("none");
64
65
66 // Constructors
67
68 //- Construct from components
69 noSoot
70 (
71 const dictionary& dict,
72 const fvMesh& mesh,
73 const word& modelType
74 );
75
76
77 //- Destructor
78 virtual ~noSoot() = default;
79
80
81 // Member Functions
82
83 //- Main update/correction routine
84 void correct();
85
86 //- Return Ysoot. Not implemented.
87 const volScalarField& soot() const;
88
89};
90
91
92// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93
94} // End namespace Foam
95} // End namespace radiation
96
97// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98
99
100#endif
101
102// ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
void correct()
Main update/correction routine.
Definition: noSoot.C:63
TypeName("none")
Runtime type information.
const volScalarField & soot() const
Return Ysoot. Not implemented.
Definition: noSoot.C:67
virtual ~noSoot()=default
Destructor.
Base class for soor models.
Definition: sootModel.H:56
const fvMesh & mesh() const
Reference to the mesh.
Definition: sootModel.H:118
const dictionary & dict() const
Reference to the dictionary.
Definition: sootModel.H:124
A class for handling words, derived from Foam::string.
Definition: word.H:68
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73