noDiameter.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) 2022-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::noDiameter
26 
27 Description
28  Diameter model for purely continuous phases.
29 
30 SourceFiles
31  noDiameter.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noDiameter_H
36 #define noDiameter_H
37 
38 #include "diameterModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace diameterModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class noDiameter Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class noDiameter
52 :
53  public diameterModel
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60 
61  // Constructors
62 
63  //- Construct from dictionary and phase
65  (
67  const phaseModel& phase
68  );
69 
70 
71  //- Destructor
72  virtual ~noDiameter();
73 
74 
75  // Member Functions
76 
77  //- Get the diameter field
78  virtual tmp<volScalarField> d() const;
79 
80  //- Return the surface area per unit volume
81  virtual tmp<volScalarField> Av() const;
82 };
83 
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 } // End namespace diameterModels
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
Abstract base-class for dispersed-phase particle diameter models.
Definition: diameterModel.H:52
const phaseModel & phase() const
Return the phase.
const dictionary & diameterProperties() const
Return the phase diameter properties dictionary.
Diameter model for purely continuous phases.
Definition: noDiameter.H:53
TypeName("none")
Runtime type information.
virtual tmp< volScalarField > d() const
Get the diameter field.
Definition: noDiameter.C:62
noDiameter(const dictionary &diameterProperties, const phaseModel &phase)
Construct from dictionary and phase.
Definition: noDiameter.C:44
virtual tmp< volScalarField > Av() const
Return the surface area per unit volume.
Definition: noDiameter.C:74
virtual ~noDiameter()
Destructor.
Definition: noDiameter.C:55
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.