nonEquilibrium.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-2018 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::nonEquilibrium
26 
27 Description
28  Non-Equlibrium model for the time scale over which properties of a
29  dispersed phase tend towards the mean value.
30 
31  Reference:
32  \verbatim
33  "An improved collision damping time for MP-PIC calculations of dense
34  particle flows with applications to polydisperse sedimenting beds and
35  colliding particle jets"
36  P O'Rourke and D Snider
37  Chemical Engineering Science
38  Volume 65, Issue 22, Pages 6014-6028, November 2010
39  \endverbatim
40 
41 SourceFiles
42  nonEquilibrium.C
43 
44 \*---------------------------------------------------------------------------*/
45 
46 #ifndef nonEquilibrium_H
47 #define nonEquilibrium_H
48 
49 #include "TimeScaleModel.H"
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 namespace Foam
54 {
55 namespace TimeScaleModels
56 {
57 
58 /*---------------------------------------------------------------------------*\
59  Class nonEquilibrium Declaration
60 \*---------------------------------------------------------------------------*/
61 
62 class nonEquilibrium
63 :
64  public TimeScaleModel
65 {
66 public:
67 
68  //- Runtime type information
69  TypeName("nonEquilibrium");
70 
71 
72  //- Constructors
73 
74  //- Construct from components
76 
77  //- Construct a copy
78  nonEquilibrium(const nonEquilibrium& hc);
79 
80  //- Construct and return a clone
81  virtual autoPtr<TimeScaleModel> clone() const
82  {
84  (
85  new nonEquilibrium(*this)
86  );
87  }
88 
89 
90  //- Destructor
91  virtual ~nonEquilibrium();
92 
93 
94  //- Member Functions
95 
96  //- Time scale
98  (
100  const FieldField<Field, scalar>& r32,
101  const FieldField<Field, scalar>& uSqr,
103  ) const;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace TimeScaleModels
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
dictionary dict
virtual ~nonEquilibrium()
Destructor.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
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.
TypeName("nonEquilibrium")
Runtime type information.
Generic field type.
Definition: FieldField.H:51
Non-Equlibrium model for the time scale over which properties of a dispersed phase tend towards the m...
nonEquilibrium(const dictionary &dict)
Constructors.
labelList f(nPoints)
virtual autoPtr< TimeScaleModel > clone() const
Construct and return a clone.
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
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.