sphericalDiameter.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) 2011-2021 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::spherical
26 
27 Description
28  Base class for models which represent spherical diameter models, providing
29  a common implementation of surface area per unit volume
30 
31 SourceFiles
32  sphericalDiameter.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef sphericalDiameter_H
37 #define sphericalDiameter_H
38 
39 #include "diameterModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace diameterModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class spherical Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class spherical
53 :
54  public diameterModel
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("spherical");
60 
61 
62  // Constructors
63 
64  //- Construct from dictionary and phase
65  spherical
66  (
68  const phaseModel& phase
69  );
70 
71 
72  //- Destructor
73  virtual ~spherical();
74 
75 
76  // Member Functions
77 
78  //- Get the surface area per unit volume field
79  virtual tmp<volScalarField> a() const;
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace diameterModels
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual ~spherical()
Destructor.
spherical(const dictionary &diameterProperties, const phaseModel &phase)
Construct from dictionary and phase.
TypeName("spherical")
Runtime type information.
Abstract base-class for dispersed-phase particle diameter models.
Definition: diameterModel.H:51
virtual tmp< volScalarField > a() const
Get the surface area per unit volume field.
Base class for models which represent spherical diameter models, providing a common implementation of...
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phase.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
const dictionary & diameterProperties() const
Return the phase diameter properties dictionary.
Namespace for OpenFOAM.