initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / thermophysicalModels / specie / reaction / reactionRate / LandauTellerReactionRate / LandauTellerReactionRate.H
blob410088a37f7d49a362af81bb7c13dd82f68f7711
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::LandauTellerReactionRate
28 Description
29     Landau-Teller reaction rate.
31 SourceFiles
32     LandauTellerReactionRateI.H
34 \*---------------------------------------------------------------------------*/
36 #ifndef LandauTellerReactionRate_H
37 #define LandauTellerReactionRate_H
39 #include "scalarField.H"
40 #include "typeInfo.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                            Class LandauTellerReactionRate Declaration
49 \*---------------------------------------------------------------------------*/
51 class LandauTellerReactionRate
53     // Private data
55         scalar A_;
56         scalar beta_;
57         scalar Ta_;
58         scalar B_;
59         scalar C_;
61 public:
63     // Constructors
65         //- Construct from components
66         inline LandauTellerReactionRate
67         (
68             const scalar A,
69             const scalar beta,
70             const scalar Ta,
71             const scalar B,
72             const scalar C
73         );
75         //- Construct from Istream
76         inline LandauTellerReactionRate
77         (
78             const speciesTable& species,
79             Istream& is
80         );
83     // Member Functions
85         //- Return the type name
86         static word type()
87         {
88             return "LandauTeller";
89         }
91         inline scalar operator()
92         (
93             const scalar T,
94             const scalar p,
95             const scalarField& c
96         ) const;
99     // Ostream Operator
101         inline friend Ostream& operator<<
102         (
103             Ostream&,
104             const LandauTellerReactionRate&
105         );
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 } // End namespace Foam
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 #include "LandauTellerReactionRateI.H"
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 #endif
121 // ************************************************************************* //