constantDiameter.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-2015 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::constant
26 
27 Description
28  Constant dispersed-phase particle diameter model.
29 
30 SourceFiles
31  constant.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef constant_H
36 #define constant_H
37 
38 #include "diameterModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace diameterModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class constant Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class constant
52 :
53  public diameterModel
54 {
55  // Private data
56 
57  //- The constant diameter of the phase
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("constant");
65 
66 
67  // Constructors
68 
69  //- Construct from components
70  constant
71  (
72  const dictionary& diameterProperties,
73  const phaseModel& phase
74  );
75 
76 
77  //- Destructor
78  virtual ~constant();
79 
80 
81  // Member Functions
82 
83  //- Return the diameter as a field
84  virtual tmp<volScalarField> d() const;
85 
86  //- Read diameterProperties dictionary
87  virtual bool read(const dictionary& diameterProperties);
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace diameterModels
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
const phaseModel & phase() const
Return the phase.
TypeName("constant")
Runtime type information.
virtual ~constant()
Destructor.
Namespace for OpenFOAM.
virtual bool read(const dictionary &diameterProperties)
Read diameterProperties dictionary.
const dictionary & diameterProperties() const
Return the phase diameter properties dictionary.
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
tmp< volScalarField > d() const
Return the phase mean diameter field.
constant(const dictionary &dict, const phaseModel &phase)
Construct from components.