sinteringModel.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-2020 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::sinteringModel
26 
27 Description
28  Abstract base class for modeling sintering of primary particles in fractal
29  agglomerates.
30 
31 SourceFiles
32  sinteringModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef sinteringModel_H
37 #define sinteringModel_H
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 #include "volFields.H"
42 #include "dictionary.H"
43 #include "runTimeSelectionTables.H"
44 #include "fractal.H"
45 
46 namespace Foam
47 {
48 namespace diameterModels
49 {
50 namespace shapeModels
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class sinteringModel Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class sinteringModel
58 {
59 protected:
60 
61  // Protected Data
62 
63  //- Reference to fractal shapeModel class
64  const fractal& fractal_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("sinteringModel");
71 
72 
73  // Declare runtime construction
74 
76  (
77  autoPtr,
79  dictionary,
80  (
81  const dictionary& dict,
82  const fractal& fractalShape
83  ),
84  (dict, fractalShape)
85  );
86 
87 
88  // Constructors
89 
90  //- Construct from a dictionary and a phase pair
92  (
93  const dictionary& dict,
94  const fractal& fractalShape
95  );
96 
97 
98  //- Destructor
99  virtual ~sinteringModel();
100 
101 
102  // Selectors
103 
105  (
106  const dictionary& dict,
107  const fractal& fractalShape
108  );
109 
110 
111  // Member Functions
112 
113  //- Sintering source term
114  virtual tmp<fvScalarMatrix> R() const = 0;
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace shapeModels
121 } // End namespace diameterModels
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual tmp< fvScalarMatrix > R() const =0
Sintering source term.
static autoPtr< sinteringModel > New(const dictionary &dict, const fractal &fractalShape)
TypeName("sinteringModel")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, sinteringModel, dictionary,(const dictionary &dict, const fractal &fractalShape),(dict, fractalShape))
sinteringModel(const dictionary &dict, const fractal &fractalShape)
Construct from a dictionary and a phase pair.
Class for modeling fractal shapes (e.g. of aerosol agglomerates) based on a constant fractal dimensio...
Definition: fractal.H:102
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:53
const fractal & fractal_
Reference to fractal shapeModel class.
Namespace for OpenFOAM.