equilibrium.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) 2013-2021 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::TimeScaleModels::equilibrium
26 
27 Description
28  Equilibrium model for the time scale over which properties of a dispersed
29  phase tend towards the mean value.
30 
31  Reference:
32  \verbatim
33  "A model for collisional exchange in gas/liquid/solid fluidised beds"
34  P O'Rourke, P Zhao and D Snider
35  Chemical Engineering Science
36  Volume 64, Issue 8, Pages 1784-1797, April 2009
37  \endverbatim
38 
39 SourceFiles
40  equilibrium.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef equilibrium_H
45 #define equilibrium_H
46 
47 #include "TimeScaleModel.H"
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 namespace TimeScaleModels
54 {
55 
56 /*---------------------------------------------------------------------------*\
57  Class equilibrium Declaration
58 \*---------------------------------------------------------------------------*/
59 
60 class equilibrium
61 :
62  public TimeScaleModel
63 {
64 public:
65 
66  //- Runtime type information
67  TypeName("equilibrium");
68 
69 
70  //- Constructors
71 
72  //- Construct from components
73  equilibrium(const dictionary& dict);
74 
75  //- Construct a copy
76  equilibrium(const equilibrium& hc);
77 
78  //- Construct and return a clone
79  virtual autoPtr<TimeScaleModel> clone() const
80  {
82  (
83  new equilibrium(*this)
84  );
85  }
86 
87 
88  //- Destructor
89  virtual ~equilibrium();
90 
91 
92  //- Member Functions
93 
94  //- Time scale
96  (
98  const FieldField<Field, scalar>& r32,
99  const FieldField<Field, scalar>& uSqr,
101  ) const;
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace TimeScaleModels
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
dictionary dict
TypeName("equilibrium")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Equilibrium model for the time scale over which properties of a dispersed phase tend towards the mean...
Definition: equilibrium.H:59
equilibrium(const dictionary &dict)
Constructors.
Definition: equilibrium.C:50
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
Generic field type.
Definition: FieldField.H:51
virtual autoPtr< TimeScaleModel > clone() const
Construct and return a clone.
Definition: equilibrium.H:78
labelList f(nPoints)
Base class for time scale models.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
virtual ~equilibrium()
Destructor.
Definition: equilibrium.C:69
Namespace for OpenFOAM.
tmp< FieldField< Field, scalar > > oneByTau(const FieldField< Field, scalar > &alpha, const FieldField< Field, scalar > &r32, const FieldField< Field, scalar > &uSqr, const FieldField< Field, scalar > &f) const
Member Functions.
Definition: equilibrium.C:77