All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
daughterSizeDistributionModel.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-2021 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::daughterSizeDistributionModel
26 
27 Description
28  Base class for daughter size distribution models. Calculates and stores
29  the contribution to a sizeGroup i due to breakup in a larger sizeGroup k.
30 
31 SourceFiles
32  daughterSizeDistributionModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef daughterSizeDistributionModel_H
37 #define daughterSizeDistributionModel_H
38 
39 #include "dictionary.H"
40 #include "dimensionedScalar.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace diameterModels
47 {
48 
49 class breakupModel;
50 
51 /*---------------------------------------------------------------------------*\
52  Class daughterSizeDistributionModel Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57 protected:
58 
59  // Protected Data
60 
61  //- Reference to the breakupModel
62  const breakupModel& breakup_;
63 
64  //- Contribution to sizeGroup i due to breakup in sizeGroup k
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("daughterSizeDistributionModel");
72 
73 
74  // Declare runtime construction
75 
77  (
78  autoPtr,
80  dictionary,
81  (
82  const breakupModel& breakup,
83  const dictionary& dict
84  ),
85  (breakup, dict)
86  );
87 
88 
89  // Constructor
90 
92  (
93  const breakupModel& breakup,
94  const dictionary& dict
95  );
96 
97 
98  //- Destructor
100 
101 
102  // Selectors
103 
105  (
106  const breakupModel& breakup,
107  const dictionary& dict
108  );
109 
110 
111  // Member Functions
112 
113  //- Return contribution to sizeGroup i due to breakup in sizeGroup k
114  const dimensionedScalar& nik(const label i, const label k) const;
115 
116  //- Precompute field independent expressions
117  void precompute();
118 
119  //- Calculate contribution to sizeGroup i due to breakup in sizeGroup k
120  virtual dimensionedScalar calcNik
121  (
122  const label i,
123  const label k
124  ) const = 0;
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace diameterModels
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
TypeName("daughterSizeDistributionModel")
Runtime type information.
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
void precompute()
Precompute field independent expressions.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
PtrList< PtrList< dimensionedScalar > > nik_
Contribution to sizeGroup i due to breakup in sizeGroup k.
declareRunTimeSelectionTable(autoPtr, daughterSizeDistributionModel, dictionary,(const breakupModel &breakup, const dictionary &dict),(breakup, dict))
label k
Boltzmann constant.
Base class for breakup models which give a total breakup rate and a separate daughter size distributi...
Definition: breakupModel.H:52
Base class for daughter size distribution models. Calculates and stores the contribution to a sizeGro...
daughterSizeDistributionModel(const breakupModel &breakup, const dictionary &dict)
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
static autoPtr< daughterSizeDistributionModel > New(const breakupModel &breakup, const dictionary &dict)
virtual dimensionedScalar calcNik(const label i, const label k) const =0
Calculate contribution to sizeGroup i due to breakup in sizeGroup k.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
const breakupModel & breakup_
Reference to the breakupModel.
const dimensionedScalar & nik(const label i, const label k) const
Return contribution to sizeGroup i due to breakup in sizeGroup k.
Namespace for OpenFOAM.