equilibrium.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) 2013-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::TimeScaleModels::equilibrium
28
29Group
30 grpLagrangianIntermediateMPPICTimeScaleSubModels
31
32Description
33 Equlibrium model for the time scale over which properties of a dispersed
34 phase tend towards the mean value.
35
36 Reference:
37 \verbatim
38 "A model for collisional exchange in gas/liquid/solid fluidized beds"
39 P O'Rourke, P Zhao and D Snider
40 Chemical Engineering Science
41 Volume 64, Issue 8, Pages 1784-1797, April 2009
42 \endverbatim
43
44SourceFiles
45 equilibrium.C
46
47\*---------------------------------------------------------------------------*/
48
49#ifndef equilibrium_H
50#define equilibrium_H
51
52#include "TimeScaleModel.H"
53
54// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55
56namespace Foam
57{
58namespace TimeScaleModels
59{
60
61/*---------------------------------------------------------------------------*\
62 Class equilibrium Declaration
63\*---------------------------------------------------------------------------*/
65class equilibrium
66:
67 public TimeScaleModel
68{
69public:
70
71 //- Runtime type information
72 TypeName("equilibrium");
73
74
75 //- Constructors
76
77 //- Construct from components
79
80 //- Construct a copy
81 equilibrium(const equilibrium& hc);
82
83 //- Construct and return a clone
84 virtual autoPtr<TimeScaleModel> clone() const
85 {
87 (
88 new equilibrium(*this)
89 );
90 }
91
92
93 //- Destructor
94 virtual ~equilibrium();
95
96
97 //- Member Functions
98
99 //- Time scale
101 (
103 const FieldField<Field, scalar>& r32,
104 const FieldField<Field, scalar>& uSqr,
106 ) const;
107};
108
109
110// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111
112} // End namespace TimeScaleModels
113} // End namespace Foam
114
115// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116
117#endif
118
119// ************************************************************************* //
A field of fields is a PtrList of fields with reference counting.
Definition: FieldField.H:80
Base class for time scale models.
Equlibrium model for the time scale over which properties of a dispersed phase tend towards the mean ...
Definition: equilibrium.H:67
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:79
virtual autoPtr< TimeScaleModel > clone() const
Construct and return a clone.
Definition: equilibrium.H:83
virtual ~equilibrium()
Destructor.
Definition: equilibrium.C:71
TypeName("equilibrium")
Runtime type information.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
labelList f(nPoints)
volScalarField & alpha
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73