SinclairJacksonRadial.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-2015 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::SinclairJackson
26 
27 Description
28 
29 SourceFiles
30  SinclairJacksonRadial.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef SinclairJackson_H
35 #define SinclairJackson_H
36 
37 #include "radialModel.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace kineticTheoryModels
44 {
45 namespace radialModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class SinclairJackson Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class SinclairJackson
53 :
54  public radialModel
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("SinclairJackson");
61 
62 
63  // Constructors
64 
65  //- Construct from components
66  SinclairJackson(const dictionary& dict);
67 
68 
69  //- Destructor
70  virtual ~SinclairJackson();
71 
72 
73  // Member Functions
74 
75  tmp<volScalarField> g0
76  (
77  const volScalarField& alpha,
78  const dimensionedScalar& alphaMinFriction,
80  ) const;
81 
82  tmp<volScalarField> g0prime
83  (
84  const volScalarField& alpha,
85  const dimensionedScalar& alphaMinFriction,
87  ) const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace radialModels
94 } // End namespace kineticTheoryModels
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
dictionary dict
TypeName("SinclairJackson")
Runtime type information.
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:52
tmp< volScalarField > g0(const volScalarField &alpha, const dimensionedScalar &alphaMinFriction, const dimensionedScalar &alphaMax) const
Radial distribution function.
tmp< volScalarField > g0prime(const volScalarField &alpha, const dimensionedScalar &alphaMinFriction, const dimensionedScalar &alphaMax) const
Derivative of the radial distribution function.
dimensionedScalar alphaMax(laminarTransport.lookup("alphaMax"))
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
SinclairJackson(const dictionary &dict)
Construct from components.
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
Namespace for OpenFOAM.