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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2018 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::diameterModels::constant
28
29Description
30 Constant dispersed-phase particle diameter model.
31
32SourceFiles
33 constant.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef constantDiameter_H
38#define constantDiameter_H
39
40#include "diameterModel.H"
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46namespace diameterModels
47{
48
49/*---------------------------------------------------------------------------*\
50 Class constant Declaration
51\*---------------------------------------------------------------------------*/
53class constant
54:
55 public diameterModel
56{
57 // Private Data
58
59 //- The constant diameter of the phase
61
62
63public:
64
65 //- Runtime type information
66 TypeName("constant");
67
68
69 // Constructors
70
71 //- Construct from components
73 (
75 const phaseModel& phase
76 );
77
78
79 //- Destructor
80 virtual ~constant();
81
82
83 // Member Functions
84
85 //- Return the diameter as a field
86 virtual tmp<volScalarField> d() const;
87
88 //- Read diameterProperties dictionary
89 virtual bool read(const dictionary& diameterProperties);
90};
91
92
93// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94
95} // End namespace diameterModels
96} // End namespace Foam
97
98// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99
100#endif
101
102// ************************************************************************* //
Abstract base-class for dispersed-phase particle diameter models.
Definition: diameterModel.H:54
const dictionary & diameterProperties() const
Return the phase diameter properties dictionary.
Constant dispersed-phase particle diameter model.
virtual bool read(const dictionary &diameterProperties)
Read diameterProperties dictionary.
virtual tmp< volScalarField > d() const
Return the diameter as a field.
TypeName("constant")
Runtime type information.
virtual ~constant()
Destructor.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:61
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phase.H:57
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73