Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / thermophysicalModels / laminarFlameSpeed / constant / constant.H
blobf75f651c7a76cc3243394fef1ddd4ee8dc9a1db9
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::laminarFlameSpeedModels::constant
27 Description
28     Constant laminar flame speed model.
30 SourceFiles
31     selectLaminarFlameSpeed.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef constant_H
36 #define constant_H
38 #include "laminarFlameSpeed.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
44 namespace laminarFlameSpeedModels
47 /*---------------------------------------------------------------------------*\
48                            Class constant Declaration
49 \*---------------------------------------------------------------------------*/
51 class constant
53     public laminarFlameSpeed
56 private:
58     // Const laminar flame speed
60         dimensionedScalar Su_;
63     // Private member functions
65         //- Construct as copy (not implemented)
66         constant(const constant&);
67         void operator=(const constant&);
70 public:
72     //- Runtime type information
73     TypeName("constant");
76     // Constructors
78         //- Construct from dictionary and hhuCombustionThermo
79         constant
80         (
81             const dictionary&,
82             const hhuCombustionThermo&
83         );
86     // Destructor
88         ~constant();
91     // Member functions
93         //- Return the laminar flame speed [m/s]
94         tmp<volScalarField> operator()() const;
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 } // End laminarFlameSpeedModels
101 } // End namespace Foam
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 #endif
107 // ************************************************************************* //