fractal.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) 2019-2023 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::shapeModels::fractal
26 
27 Description
28  Class for modelling the shape of particle aggregates using the concept of
29  fractal geometry. Returns a collisional diameter
30 
31  \f[
32  d_{c_i} =
33  \frac{6}{\kappa_i}
34  \left(
35  \frac{v_i \kappa_i^3}{36 \pi \alpha_c}
36  \right)^{1/D_{f_i}}\,,
37  \f]
38 
39  computed from a constant fractal dimension \f$D_{f_i}\f$ and a
40  field-dependent surface area to volume ratio \f$\kappa_i\f$, assuming that
41  the primary particles in an aggregate have the same size.
42 
43  The effect of sintering, i.e. the coalescence of primary particles
44  resulting in a loss of surface area, is taken into account by a separate
45  source term in the transport equation for \f$\kappa_i\f$.
46 
47 Usage
48  \table
49  Property | Description | Required | Default value
50  kappa | Initial and boundary condition value\\
51  | yes |
52  Df | Fractal dimension | yes |
53  alphaC | Scaling prefactor | yes |
54  \endtable
55 
56 See also
57  Foam::diameterModels::shapeModel
58 
59 SourceFiles
60  fractal.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef fractal_H
65 #define fractal_H
66 
67 #include "SecondaryPropertyModel.H"
68 #include "shapeModel.H"
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 namespace diameterModels
75 {
76 namespace shapeModels
77 {
78 
79 class sinteringModel;
80 
81 /*---------------------------------------------------------------------------*\
82  Class fractal Declaration
83 \*---------------------------------------------------------------------------*/
84 
85 class fractal
86 :
87  public SecondaryPropertyModel<shapeModel>
88 {
89 public:
90 
91  // Public Data types
92 
93  //- Surface growth type enumeration
95  {
99  };
100 
101  //- Surface growth type names
102  static const NamedEnum<surfaceGrowthTypes, 3> sgTypeNames_;
103 
104 
105 private:
106 
107  // Private Data
108 
109  //- Ratio of surface area to volume
110  volScalarField kappa_;
111 
112  //- Fractal dimension
113  dimensionedScalar Df_;
114 
115  //- Scaling prefactor
116  dimensionedScalar alphaC_;
117 
118  //- Collisional diameter
119  volScalarField dColl_;
120 
121  //- Explicit source
122  volScalarField Su_;
123 
124  //- Sintering model
125  autoPtr<sinteringModel> sinteringModel_;
126 
127 
128  // Private Member Functions
129 
130  tmp<volScalarField> dColl() const;
131 
132 
133 public:
134 
135  //- Runtime type information
136  TypeName("fractal");
137 
138 
139  // Constructors
140 
141  //- Construct from dictionary and sizeGroup
142  fractal
143  (
144  const dictionary& dict,
145  const sizeGroup& group
146  );
147 
148  //- Disallow default bitwise copy construction
149  fractal(const fractal&) = delete;
150 
151 
152  //- Destructor
153  virtual ~fractal();
154 
155 
156  // Member Functions
157 
158  // Access
159 
160  //- Return reference to secondary property field
161  virtual const volScalarField& fld() const;
162 
163  //- Access to secondary property source
164  virtual volScalarField& src();
165 
166  //- Return representative surface area of the sizeGroup
167  virtual const tmp<volScalarField> a() const;
168 
169  //- Return representative diameter of the sizeGroup
170  virtual const tmp<volScalarField> d() const
171  {
172  return dColl_;
173  }
174 
175  // Edit
176 
177  //- Correct the collisional diameter
178  virtual void correct();
179 
180  //- Add drift contribution to secondary property source
181  virtual void addDrift
182  (
183  const volScalarField& Su,
184  const sizeGroup& fu,
185  const driftModel& model
186  );
187 
188 
189  // Member Operators
190 
191  //- Disallow default bitwise assignment
192  void operator=(const fractal&) = delete;
193 };
194 
195 
196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
197 
198 } // End namespace shapeModels
199 } // End namespace diameterModels
200 } // End namespace Foam
201 
202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
203 
204 #endif
205 
206 // ************************************************************************* //
Generic GeometricField class.
word group() const
Return group (extension part of name)
Definition: IOobject.C:324
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Base class for drift models.
Definition: driftModel.H:54
Class for modelling the shape of particle aggregates using the concept of fractal geometry....
Definition: fractal.H:106
TypeName("fractal")
Runtime type information.
virtual void correct()
Correct the collisional diameter.
Definition: fractal.C:188
void operator=(const fractal &)=delete
Disallow default bitwise assignment.
surfaceGrowthTypes
Surface growth type enumeration.
Definition: fractal.H:113
virtual const tmp< volScalarField > a() const
Return representative surface area of the sizeGroup.
Definition: fractal.C:246
virtual const tmp< volScalarField > d() const
Return representative diameter of the sizeGroup.
Definition: fractal.H:188
virtual void addDrift(const volScalarField &Su, const sizeGroup &fu, const driftModel &model)
Add drift contribution to secondary property source.
Definition: fractal.C:253
virtual const volScalarField & fld() const
Return reference to secondary property field.
Definition: fractal.C:152
static const NamedEnum< surfaceGrowthTypes, 3 > sgTypeNames_
Surface growth type names.
Definition: fractal.H:120
virtual volScalarField & src()
Access to secondary property source.
Definition: fractal.C:159
fractal(const dictionary &dict, const sizeGroup &group)
Construct from dictionary and sizeGroup.
Definition: fractal.C:69
Single size class fraction field representing a fixed particle volume as defined by the user through ...
Definition: sizeGroup.H:102
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
A class for managing temporary objects.
Definition: tmp.H:55
tmp< VolField< Type > > Su(const VolField< Type > &su, const VolField< Type > &vf)
Definition: fvcSup.C:44
Namespace for OpenFOAM.
dictionary dict