All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
exponential.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::breakupModels::exponential
26 
27 Description
28  Exponential kernel.
29 
30 SourceFiles
31  exponential.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef exponential_H
36 #define exponential_H
37 
38 #include "breakupModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace diameterModels
45 {
46 namespace breakupModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class exponential Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class exponential
54 :
55  public breakupModel
56 {
57  // Private Data
58 
59  //- Exponent
60  scalar exponent_;
61 
62  //- Coefficient
63  scalar C_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("exponential");
70 
71  // Constructor
72 
74  (
76  const dictionary& dict
77  );
78 
79 
80  //- Destructor
81  virtual ~exponential()
82  {}
83 
84 
85  // Member Functions
86 
87  //- Set total breakupRate
88  virtual void setBreakupRate
89  (
90  volScalarField& breakupRate,
91  const label i
92  );
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace breakupModels
99 } // End namespace diameterModels
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
exponential(const populationBalanceModel &popBal, const dictionary &dict)
dictionary dict
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
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 ...
Base class for breakup models which give a total breakup rate and a separate daughter size distributi...
Definition: breakupModel.H:52
const populationBalanceModel & popBal() const
Return reference to the populationBalanceModel.
Definition: breakupModel.H:144
TypeName("exponential")
Runtime type information.
virtual void setBreakupRate(volScalarField &breakupRate, const label i)
Set total breakupRate.
Namespace for OpenFOAM.