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-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::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 Usage
44  \table
45  Property | Description | Required | Default value
46  Df | Fractal dimension | yes |
47  alphaC | Scaling prefactor | yes |
48  \endtable
49 
50 See also
51  Foam::diameterModels::shapeModel
52 
53 SourceFiles
54  fractal.C
55 
56 \*---------------------------------------------------------------------------*/
57 
58 #ifndef fractal_H
59 #define fractal_H
60 
61 #include "SecondaryPropertyModel.H"
62 #include "shapeModel.H"
63 
64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 
66 namespace Foam
67 {
68 namespace diameterModels
69 {
70 namespace shapeModels
71 {
72 
73 /*---------------------------------------------------------------------------*\
74  Class fractal Declaration
75 \*---------------------------------------------------------------------------*/
76 
77 class fractal
78 :
79  public SecondaryPropertyModel<shapeModel>
80 {
81 private:
82 
83  // Private Data
84 
85  //- Ratio of surface area to volume
86  volScalarField kappa_;
87 
88  //- Fractal dimension
90 
91  //- Scaling prefactor
92  dimensionedScalar alphaC_;
93 
94  //- Collisional diameter
95  volScalarField dColl_;
96 
97  //- Explicit source
99 
100 
101  // Private Member Functions
102 
103  //- Compute and return the collisional diameter
104  tmp<volScalarField> dColl() const;
105 
106 
107 public:
108 
109  //- Runtime type information
110  TypeName("fractal");
111 
112 
113  // Constructors
114 
115  //- Construct from dictionaries and sizeGroup
116  fractal
117  (
118  const dictionary& dict,
119  const sizeGroup& group,
120  const dictionary& groupDict
121  );
122 
123  //- Disallow default bitwise copy construction
124  fractal(const fractal&) = delete;
125 
126 
127  //- Destructor
128  virtual ~fractal();
129 
130 
131  // Member Functions
132 
133  // Access
134 
135  //- Return the fractal dimension
136  inline const dimensionedScalar& Df() const
137  {
138  return Df_;
139  }
140 
141  //- Return the scaling prefactor
142  inline const dimensionedScalar& alphaC() const
143  {
144  return alphaC_;
145  }
146 
147  //- Return reference to secondary property field
148  virtual const volScalarField& fld() const;
149 
150  //- Access to secondary property source
151  virtual volScalarField::Internal& src();
152 
153  //- Return representative surface area of the sizeGroup
154  virtual const tmp<volScalarField> a() const;
155 
156  //- Return representative diameter of the sizeGroup
157  virtual const tmp<volScalarField> d() const;
158 
159 
160  // Edit
161 
162  //- Correct the collisional diameter
163  virtual void correct();
164 
165 
166  // Member Operators
167 
168  //- Disallow default bitwise assignment
169  void operator=(const fractal&) = delete;
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace shapeModels
176 } // End namespace diameterModels
177 } // End namespace Foam
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 #endif
182 
183 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Generic GeometricField class.
const sizeGroup & group() const
Return reference to size group.
Definition: shapeModel.C:94
Class for modelling the shape of particle aggregates using the concept of fractal geometry....
Definition: fractal.H:94
TypeName("fractal")
Runtime type information.
const dimensionedScalar & alphaC() const
Return the scaling prefactor.
Definition: fractal.H:156
virtual void correct()
Correct the collisional diameter.
Definition: fractal.C:152
fractal(const dictionary &dict, const sizeGroup &group, const dictionary &groupDict)
Construct from dictionaries and sizeGroup.
Definition: fractal.C:78
const dimensionedScalar & Df() const
Return the fractal dimension.
Definition: fractal.H:150
void operator=(const fractal &)=delete
Disallow default bitwise assignment.
virtual const tmp< volScalarField > a() const
Return representative surface area of the sizeGroup.
Definition: fractal.C:238
virtual volScalarField::Internal & src()
Access to secondary property source.
Definition: fractal.C:146
virtual const volScalarField & fld() const
Return reference to secondary property field.
Definition: fractal.C:139
virtual const tmp< volScalarField > d() const
Return representative diameter of the sizeGroup.
Definition: fractal.C:245
Single size class fraction field representing a fixed particle volume as defined by the user through ...
Definition: sizeGroup.H:96
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
VolField< scalar > volScalarField
Definition: volFieldsFwd.H:62
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
dictionary dict