LindemannFallOffFunction.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 | Copyright (C) 2011 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
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.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::LindemannFallOffFunction
26 
27 Description
28  Lindemann fall-off function
29 
30 SourceFiles
31  LindemannFallOffFunctionI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef LindemannFallOffFunction_H
36 #define LindemannFallOffFunction_H
37 
38 #include "scalar.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of friend functions and operators
46 
47 class LindemannFallOffFunction;
48 Ostream& operator<<(Ostream&, const LindemannFallOffFunction&);
49 
50 
51 /*---------------------------------------------------------------------------*\
52  Class LindemannFallOffFunction Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57 
58 public:
59 
60  // Constructors
61 
62  //- Construct null
63  inline LindemannFallOffFunction();
64 
65  //- Construct from Istream
67 
68  //- Construct from dictionary
70 
71 
72  // Member Functions
73 
74  //- Return the type name
75  static word type()
76  {
77  return "Lindemann";
78  }
79 
80  inline scalar operator()
81  (
82  const scalar T,
83  const scalar Pr
84  ) const;
85 
86  //- Write to stream
87  inline void write(Ostream& os) const;
88 
89 
90  // Ostream Operator
91 
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
dimensionedScalar Pr("Pr", dimless, laminarTransport)
Lindemann fall-off function.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
void write(Ostream &os) const
Write to stream.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A class for handling words, derived from string.
Definition: word.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Ostream & operator<<(Ostream &, const edgeMesh &)
Definition: edgeMeshIO.C:133
Namespace for OpenFOAM.
dictionary dict
friend Ostream & operator<<(Ostream &, const LindemannFallOffFunction &)
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static word type()
Return the type name.