daughterSizeDistribution.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::daughterSizeDistribution
26 
27 Description
28  Base class for breakup models which provide a total breakup rate and a
29  separate daughter size distribution function.
30 
31 See also
32  Foam::populationBalanceModel
33 
34 SourceFiles
35  daughterSizeDistribution.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef daughterSizeDistribution_H
40 #define daughterSizeDistribution_H
41 
42 #include "breakupModel.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace populationBalance
49 {
50 namespace breakupModels
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class daughterSizeDistribution Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public breakupModel
60 {
61 protected:
62 
63  // Protected Data
64 
65  //- Daughter size distribution model
67 
68 
69 public:
70 
71  // Constructor
72 
74  (
76  const dictionary& dict
77  );
78 
79 
80  //- Destructor
82  {}
83 
84 
85  // Member Functions
86 
87  //- Return const-reference to daughter size distribution model
88  const daughterSizeDistributionModel& dsd() const
89  {
90  return dsdPtr_();
91  }
92 
93  //- Return the breakup rate for a group
94  virtual tmp<volScalarField::Internal> rate(const label i) const = 0;
95 
96  //- Pre-compute diameter independent expressions
97  virtual void precompute();
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace breakupModels
104 } // End namespace populationBalance
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
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...
Base class for breakup models which provide a total breakup rate and a separate daughter size distrib...
Definition: breakupModel.H:56
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...
virtual void precompute()
Pre-compute diameter independent expressions.
autoPtr< daughterSizeDistributionModel > dsdPtr_
Daughter size distribution model.
const daughterSizeDistributionModel & dsd() const
Return const-reference to daughter size distribution model.
daughterSizeDistribution(const populationBalanceModel &popBal, const dictionary &dict)
virtual tmp< volScalarField::Internal > rate(const label i) const =0
Return the breakup rate for a group.
Base class for daughter size distribution models. Currently only supports field-independent formulati...
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