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