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