diameterModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2013 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::diameterModel
26 
27 Description
28  Abstract base-class for dispersed-phase particle diameter models.
29 
30 SourceFiles
31  diameterModel.C
32  newDiameterModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef diameterModel_H
37 #define diameterModel_H
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 #include "dictionary.H"
42 #include "phaseModel.H"
43 #include "runTimeSelectionTables.H"
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class diameterModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class diameterModel
53 {
54 protected:
55 
56  // Protected data
57 
58  const dictionary& dict_;
59  const phaseModel& phase_;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("diameterModel");
66 
67 
68  // Declare runtime construction
69 
71  (
72  autoPtr,
74  dictionary,
75  (
76  const dictionary& dict,
77  const phaseModel& phase
78  ),
79  (dict, phase)
80  );
81 
82 
83  // Constructors
84 
86  (
87  const dictionary& dict,
88  const phaseModel& phase
89  );
90 
91 
92  //- Destructor
93  virtual ~diameterModel();
94 
95 
96  // Selectors
97 
99  (
100  const dictionary& dict,
101  const phaseModel& phase
102  );
103 
104 
105  // Member Functions
106 
107  //- Return the phase mean diameter field
108  virtual tmp<volScalarField> d() const = 0;
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
static autoPtr< diameterModel > New(const dictionary &dict, const phaseModel &phase)
const dictionary & dict_
Definition: diameterModel.H:57
Macros to ease declaration of run-time selection tables.
TypeName("diameterModel")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phase.H:52
dictionary dict
declareRunTimeSelectionTable(autoPtr, diameterModel, dictionary,( const dictionary &dict, const phaseModel &phase ),(dict, phase))
diameterModel(const dictionary &dict, const phaseModel &phase)
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
Abstract base-class for dispersed-phase particle diameter models.
Definition: diameterModel.H:51
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
virtual tmp< volScalarField > d() const =0
Return the phase mean diameter field.
virtual ~diameterModel()
Destructor.
const phaseModel & phase_
Definition: diameterModel.H:58