exponential.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 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::diameterModels::breakupModels::exponential
28 
29 Description
30  Exponential kernel. Used for verification and validation of the breakup
31  formulation implemented in the populationBalanceModel class.
32 
33 SourceFiles
34  exponential.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef exponential_H
39 #define exponential_H
40 
41 #include "breakupModel.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace diameterModels
48 {
49 namespace breakupModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class exponential Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class exponential
57 :
58  public breakupModel
59 {
60  // Private data
61 
62  //- Exponent
63  scalar exponent_;
64 
65  //- Coefficient
66  scalar C_;
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("exponential");
73 
74  // Constructor
75 
77  (
79  const dictionary& dict
80  );
81 
82 
83  //- Destructor
84  virtual ~exponential() = default;
85 
86 
87  // Member Functions
88 
89  //- Set total breakupRate
90  virtual void setBreakupRate
91  (
92  volScalarField& breakupRate,
93  const label i
94  );
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace breakupModels
101 } // End namespace diameterModels
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
Foam::diameterModels::breakupModels::exponential::TypeName
TypeName("exponential")
Runtime type information.
Foam::diameterModels::breakupModels::exponential::exponential
exponential(const populationBalanceModel &popBal, const dictionary &dict)
Definition: exponential.C:50
Foam::diameterModels::breakupModels::exponential::setBreakupRate
virtual void setBreakupRate(volScalarField &breakupRate, const label i)
Set total breakupRate.
Definition: exponential.C:64
Foam::diameterModels::breakupModels::exponential::~exponential
virtual ~exponential()=default
Destructor.
Foam::diameterModels::breakupModel::popBal
const populationBalanceModel & popBal() const
Return reference to the populationBalanceModel.
Definition: breakupModel.H:146
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::diameterModels::populationBalanceModel
Class that solves the univariate population balance equation by means of a class method (also called ...
Definition: populationBalanceModel.H:179
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
breakupModel.H
Foam::diameterModels::breakupModel
Base class for breakup models which give a total breakup rate and a separate daughter size distributi...
Definition: breakupModel.H:55
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::diameterModels::breakupModels::exponential
Exponential kernel. Used for verification and validation of the breakup formulation implemented in th...
Definition: exponential.H:55