constantSurfaceTensionCoefficient.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 | Copyright (C) 2015 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::constantSurfaceTensionCoefficient
26 
27 Description
28  Constant value surface tension model.
29 
30 SourceFiles
31  constantSurfaceTensionCoefficient.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef constantSurfaceTensionCoefficient_H
36 #define constantSurfaceTensionCoefficient_H
37 
38 #include "surfaceTensionModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace surfaceTensionModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class constantSurfaceTensionCoefficient Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public surfaceTensionModel
54 {
55  // Private data
56 
57  //- Constant surface tension value
58  const dimensionedScalar sigma_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("constant");
65 
66 
67  // Constructors
68 
69  //- Construct from a dictionary and a phase pair
71  (
72  const dictionary& dict,
73  const phasePair& pair,
74  const bool registerObject
75  );
76 
77 
78  //- Destructor
80 
81 
82  // Member Functions
83 
84  //- Aspect ratio
85  virtual tmp<volScalarField> sigma() const;
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace surfaceTensionModels
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:290
Namespace for OpenFOAM.
dictionary dict
constantSurfaceTensionCoefficient(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
virtual tmp< volScalarField > sigma() const
Aspect ratio.
A class for managing temporary objects.
Definition: PtrList.H:118