driftModel.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) 2017-2018 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::diameterModels::driftModel
28
29Description
30 Base class for drift models.
31
32SourceFiles
33 driftModel.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef driftModel_H
38#define driftModel_H
39
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46namespace diameterModels
47{
48
49/*---------------------------------------------------------------------------*\
50 Class driftModel Declaration
51\*---------------------------------------------------------------------------*/
53class driftModel
54{
55protected:
56
57 // Protected data
58
59 //- Reference to the populationBalanceModel
61
62
63public:
64
65 //- Runtime type information
66 TypeName("driftModel");
67
68
69 // Declare run-time constructor selection table
72 (
73 autoPtr,
76 (
78 const dictionary& dict
79 ),
80 (popBal, dict)
81 );
82
83
84 //- Class used for the read-construction of
85 // PtrLists of drift models
86 class iNew
87 {
88 const populationBalanceModel& popBal_;
89
90 public:
93 :
94 popBal_(popBal)
95 {}
98 {
99 word type(is);
100 dictionary dict(is);
101 return driftModel::New(type, popBal_, dict);
102 }
103 };
104
105
106 // Constructor
107
109 (
111 const dictionary& dict
112 );
115 {
117 return autoPtr<driftModel>(nullptr);
118 }
119
120
121 // Selector
122
124 (
125 const word& type,
127 const dictionary& dict
128 );
129
130
131 //- Destructor
132 virtual ~driftModel() = default;
133
134
135 // Member Functions
136
137 //- Return reference to the populationBalanceModel
138 const populationBalanceModel& popBal() const
139 {
140 return popBal_;
141 }
142
143 //- Correct diameter independent expressions
144 virtual void correct();
145
146 //- Add to driftRate
147 virtual void addToDriftRate
148 (
149 volScalarField& driftRate,
150 const label i
151 ) = 0;
152};
153
154
155// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156
157} // End namespace diameterModels
158} // End namespace Foam
159
160// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161
162#endif
163
164// ************************************************************************* //
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
static autoPtr< Time > New()
Construct (dummy) Time - no functionObjects or libraries.
Definition: Time.C:717
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
Class used for the read-construction of.
Definition: driftModel.H:86
iNew(const populationBalanceModel &popBal)
Definition: driftModel.H:91
autoPtr< driftModel > operator()(Istream &is) const
Definition: driftModel.H:96
Base class for drift models.
Definition: driftModel.H:53
const populationBalanceModel & popBal() const
Return reference to the populationBalanceModel.
Definition: driftModel.H:137
virtual void correct()
Correct diameter independent expressions.
Definition: driftModel.C:85
const populationBalanceModel & popBal_
Reference to the populationBalanceModel.
Definition: driftModel.H:59
declareRunTimeSelectionTable(autoPtr, driftModel, dictionary,(const populationBalanceModel &popBal, const dictionary &dict),(popBal, dict))
TypeName("driftModel")
Runtime type information.
virtual ~driftModel()=default
Destructor.
static autoPtr< driftModel > New(const word &type, const populationBalanceModel &popBal, const dictionary &dict)
Definition: driftModel.C:48
autoPtr< driftModel > clone() const
Definition: driftModel.H:113
virtual void addToDriftRate(volScalarField &driftRate, const label i)=0
Add to driftRate.
Class that solves the univariate population balance equation by means of a class method (also called ...
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:517
Namespace for OpenFOAM.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:598
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73