radialModel.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2018 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::kineticTheoryModels::radialModel
28 
29 SourceFiles
30  radialModel.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef radialModel_H
35 #define radialModel_H
36 
37 #include "dictionary.H"
38 #include "volFields.H"
39 #include "dimensionedTypes.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace kineticTheoryModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class radialModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class radialModel
54 {
55  // Private member functions
56 
57  //- Disallow default bitwise copy construct
58  radialModel(const radialModel&);
59 
60  //- Disallow default bitwise assignment
61  void operator=(const radialModel&);
62 
63 
64 protected:
65 
66  // Protected data
67 
68  const dictionary& dict_;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("radialModel");
75 
76  // Declare runtime constructor selection table
78  (
79  autoPtr,
81  dictionary,
82  (
83  const dictionary& dict
84  ),
85  (dict)
86  );
87 
88 
89  // Constructors
90 
91  //- Construct from components
92  radialModel(const dictionary& dict);
93 
94 
95  // Selectors
96 
98  (
99  const dictionary& dict
100  );
101 
102 
103  //- Destructor
104  virtual ~radialModel();
105 
106 
107  // Member Functions
108 
109  //- Radial distribution function
110  virtual tmp<volScalarField> g0
111  (
112  const volScalarField& alpha,
113  const dimensionedScalar& alphaMinFriction,
115  ) const = 0;
116 
117  //- Derivative of the radial distribution function
119  (
120  const volScalarField& alpha,
121  const dimensionedScalar& alphaMinFriction,
123  ) const = 0;
124 
125  virtual bool read()
126  {
127  return true;
128  }
129 };
130 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 } // End namespace kineticTheoryModels
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
volFields.H
Foam::tmp< volScalarField >
Foam::constant::atomic::alpha
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
Definition: readThermalProperties.H:212
Foam::kineticTheoryModels::radialModel::~radialModel
virtual ~radialModel()
Destructor.
Definition: radialModel.C:56
Foam::kineticTheoryModels::radialModel::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, radialModel, dictionary,(const dictionary &dict),(dict))
Foam::kineticTheoryModels::radialModel::TypeName
TypeName("radialModel")
Runtime type information.
Foam::kineticTheoryModels::radialModel::g0
virtual tmp< volScalarField > g0(const volScalarField &alpha, const dimensionedScalar &alphaMinFriction, const dimensionedScalar &alphaMax) const =0
Radial distribution function.
Foam::kineticTheoryModels::radialModel::read
virtual bool read()
Definition: radialModel.H:124
Foam::kineticTheoryModels::radialModel::New
static autoPtr< radialModel > New(const dictionary &dict)
Definition: newRadialModel.C:35
alphaMax
dimensionedScalar alphaMax("alphaMax", dimless/dimTime, laminarTransport)
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::kineticTheoryModels::radialModel
Definition: radialModel.H:52
Foam::kineticTheoryModels::radialModel::dict_
const dictionary & dict_
Definition: radialModel.H:67
Foam::kineticTheoryModels::radialModel::g0prime
virtual tmp< volScalarField > g0prime(const volScalarField &alpha, const dimensionedScalar &alphaMinFriction, const dimensionedScalar &alphaMax) const =0
Derivative of the radial distribution function.
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
dictionary.H
dimensionedTypes.H
Foam::GeometricField< scalar, fvPatchField, volMesh >