MichaelsBolger.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2022-2023 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::relativeVelocityModels::MichaelsBolger
26 
27 Description
28  Michaels & Bolger relative velocity model
29 
30  Reference:
31  \verbatim
32  Michaels, A. S., & Bolger, J. C. (1962).
33  Settling rates and sediment volumes
34  of flocculated kaolin suspensions.
35  Industrial & Engineering Chemistry Fundamentals, 1(1), 24-33.
36  \endverbatim
37 
38 Usage
39  Example usage:
40  \verbatim
41  relativeVelocityModel MichaelsBolger;
42 
43  MichaelsBolgerCoeffs
44  {
45  a0 0; // Extended Michaels & Bolger coefficient,
46  a1 4.65; // Exponent
47  }
48  \endverbatim
49 
50 SourceFiles
51  MichaelsBolger.C
52 
53 \*---------------------------------------------------------------------------*/
54 
55 #ifndef MichaelsBolger_H
56 #define MichaelsBolger_H
57 
58 #include "relativeVelocityModel.H"
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
62 namespace Foam
63 {
64 namespace relativeVelocityModels
65 {
66 
67 /*---------------------------------------------------------------------------*\
68  Class MichaelsBolger Declaration
69 \*---------------------------------------------------------------------------*/
70 
71 class MichaelsBolger
72 :
74 {
75  // Private Data
76 
77  //- Extended Michaels & Bolger coefficient, defaults to 0
79 
80  //- Exponent, defaults to 4.65
82 
83  //- Drift velocity coefficient
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("MichaelsBolger");
91 
92 
93  // Constructors
94 
95  //- Construct from components
97  (
98  const dictionary& dict,
101  );
102 
103 
104  //- Destructor
105  ~MichaelsBolger();
106 
107 
108  // Member Functions
109 
110  //- Update the diffusion velocity
111  virtual void correct();
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace relativeVelocityModels
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Class to represent a mixture of two constant density phases.
Michaels & Bolger relative velocity model.
MichaelsBolger(const dictionary &dict, const incompressibleDriftFluxMixture &mixture, const uniformDimensionedVectorField &g)
Construct from components.
virtual void correct()
Update the diffusion velocity.
TypeName("MichaelsBolger")
Runtime type information.
Namespace for OpenFOAM.
dictionary dict