All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
constantDrift.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) 2017-2020 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::diameterModels::driftModels::constantDrift
26 
27 SourceFiles
28  constant.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef constantDrift_H
33 #define constantDrift_H
34 
35 #include "driftModel.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 namespace diameterModels
42 {
43 namespace driftModels
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class constantDrift Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class constantDrift
51 :
52  public driftModel
53 {
54  // Private Data
55 
56  //- Drift rate
57  dimensionedScalar rate_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("constant");
64 
65  // Constructor
66 
68  (
70  const dictionary& dict
71  );
72 
73 
74  //- Destructor
75  virtual ~constantDrift()
76  {}
77 
78 
79  // Member Functions
80 
81  //- Add to driftRate
82  virtual void addToDriftRate
83  (
84  volScalarField& driftRate,
85  const label i
86  );
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace driftModels
93 } // End namespace diameterModels
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
const dictionary & dict() const
Return reference to model dictionary.
Definition: driftModel.H:145
Base class for drift models.
Definition: driftModel.H:50
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
TypeName("constant")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Class that solves the univariate population balance equation by means of a class method (also called ...
virtual void addToDriftRate(volScalarField &driftRate, const label i)
Add to driftRate.
const populationBalanceModel & popBal() const
Return reference to the populationBalanceModel.
Definition: driftModel.H:139
constantDrift(const populationBalanceModel &popBal, const dictionary &dict)
Namespace for OpenFOAM.