OpenFOAM logo
Open Source CFD Toolkit

LindemannFallOffFunction.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     LindemannFallOffFunction
00027 
00028 Description
00029 
00030 SourceFiles
00031     LindemannFallOffFunctionI.H
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef LindemannFallOffFunction_H
00036 #define LindemannFallOffFunction_H
00037 
00038 #include "scalar.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 // * * * * * * * * Forward declaration of friend functions * * * * * * * * * //
00046 
00047 class LindemannFallOffFunction;
00048 Ostream& operator<<(Ostream&, const LindemannFallOffFunction&);
00049 
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class LindemannFallOffFunction Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class LindemannFallOffFunction
00056 {
00057 
00058 public:
00059 
00060     // Constructors
00061 
00062         //- Construct null
00063         inline LindemannFallOffFunction();
00064 
00065         //- Construct from Istream
00066         inline LindemannFallOffFunction(Istream&);
00067 
00068 
00069     // Member Functions
00070 
00071         //- Return the type name
00072         static word type()
00073         {
00074             return "Lindemann";
00075         }
00076 
00077         inline scalar operator()
00078         (
00079             const scalar T,
00080             const scalar Pr
00081         ) const;
00082 
00083 
00084     // Ostream Operator
00085 
00086         friend Ostream& operator<<(Ostream&, const LindemannFallOffFunction&);
00087 };
00088 
00089 
00090 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00091 
00092 } // End namespace Foam
00093 
00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00095 
00096 #include "LindemannFallOffFunctionI.H"
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 #endif
00101 
00102 // ************************************************************************* //
For further information go to www.openfoam.org