All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
spherical.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) 2019-2020 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::shapeModels::spherical
26 
27 Description
28  Uniform spherical shape.
29 
30 SourceFiles
31  spherical.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef spherical_H
36 #define spherical_H
37 
38 #include "shapeModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace diameterModels
45 {
46 namespace shapeModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class spherical Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class spherical
54 :
55  public shapeModel
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("spherical");
61 
62 
63  // Constructors
64 
65  //- Construct from dictionary and sizeGroup
66  spherical
67  (
68  const dictionary& dict,
69  const sizeGroup& group
70  );
71 
72 
73  //- Destructor
74  virtual ~spherical();
75 
76 
77  // Member Functions
78 
79  //- Return representative surface area of the sizeGroup
80  virtual const tmp<volScalarField> a() const;
81 
82  //- Return representative diameter of the sizeGroup
83  virtual const tmp<volScalarField> d() const;
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace shapeModels
90 } // End namespace diameterModels
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
const char *const group
Group name for atomic constants.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual const tmp< volScalarField > a() const
Return representative surface area of the sizeGroup.
virtual const tmp< volScalarField > d() const
Return representative diameter of the sizeGroup.
TypeName("spherical")
Runtime type information.
This class represents a single sizeGroup belonging to a velocityGroup. The main property of a sizeGro...
Definition: sizeGroup.H:100
A class for managing temporary objects.
Definition: PtrList.H:53
spherical(const dictionary &dict, const sizeGroup &group)
Construct from dictionary and sizeGroup.
Namespace for OpenFOAM.