initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / thermophysicalModels / laminarFlameSpeed / constant / constant.H
blobdce52f5d14a4f5e6099fb24d3a44bc0ed727a7ad
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::laminarFlameSpeedModels::constant
28 Description
29     Constant laminar flame speed model.
31 SourceFiles
32     selectLaminarFlameSpeed.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef constant_H
37 #define constant_H
39 #include "laminarFlameSpeed.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
45 namespace laminarFlameSpeedModels
48 /*---------------------------------------------------------------------------*\
49                            Class constant Declaration
50 \*---------------------------------------------------------------------------*/
52 class constant
54     public laminarFlameSpeed
57 private:
59     // Const laminar flame speed
61         dimensionedScalar Su_;
64     // Private member functions
66         //- Construct as copy (not implemented)
67         constant(const constant&);
68         void operator=(const constant&);
71 public:
73     //- Runtime type information
74     TypeName("constant");
77     // Constructors
79         //- Construct from dictionary and hhuCombustionThermo
80         constant
81         (
82             const dictionary&,
83             const hhuCombustionThermo&
84         );
87     // Destructor
89         ~constant();
92     // Member functions
94         //- Return the laminar flame speed [m/s]
95         tmp<volScalarField> operator()() const;
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 } // End laminarFlameSpeedModels
102 } // End namespace Foam
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 #endif
108 // ************************************************************************* //