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-2025 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::populationBalance::breakupModels::exponential
26 
27 Description
28  Exponential breakup model
29 
30 SourceFiles
31  exponential.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef exponential_H
36 #define exponential_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace populationBalance
45 {
46 namespace breakupModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class exponential Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class exponential
54 :
56 {
57  // Private Data
58 
59  //- Exponent
60  dimensionedScalar exponent_;
61 
62  //- Coefficient
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("exponential");
70 
71 
72  // Constructor
73 
75  (
77  const dictionary& dict
78  );
79 
80 
81  //- Destructor
82  virtual ~exponential()
83  {}
84 
85 
86  // Member Functions
87 
88  //- Return the breakup rate for a group
89  virtual tmp<volScalarField::Internal> rate(const label i) const;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace breakupModels
96 } // End namespace populationBalance
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Model for tracking the evolution of a dispersed phase size distribution due to coalescence (synonymou...
const populationBalanceModel & popBal() const
Return reference to the populationBalanceModel.
Definition: breakupModel.H:112
Base class for breakup models which provide a total breakup rate and a separate daughter size distrib...
TypeName("exponential")
Runtime type information.
virtual tmp< volScalarField::Internal > rate(const label i) const
Return the breakup rate for a group.
Definition: exponential.C:62
exponential(const populationBalanceModel &popBal, const dictionary &dict)
Definition: exponential.C:48
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
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
dictionary dict