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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2015-2018 OpenFOAM Foundation
9  Copyright (C) 2022 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::surfaceTensionModels::constantSurfaceTensionCoefficient
29 
30 Description
31  Constant value surface tension model.
32 
33 SourceFiles
34  constantSurfaceTensionCoefficient.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef constantSurfaceTensionCoefficient_H
39 #define constantSurfaceTensionCoefficient_H
40 
41 #include "surfaceTensionModel.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace reactingMultiphaseEuler
48 {
49 namespace surfaceTensionModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class constantSurfaceTensionCoefficient Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public surfaceTensionModel
59 {
60  // Private data
61 
62  //- Constant surface tension value
63  const dimensionedScalar sigma_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("constant");
70 
71 
72  // Constructors
73 
74  //- Construct from a dictionary and a phase pair
76  (
77  const dictionary& dict,
78  const phasePair& pair,
79  const bool registerObject
80  );
81 
82 
83  //- Destructor
85 
86 
87  // Member Functions
88 
89  //- Aspect ratio
90  virtual tmp<volScalarField> sigma() const;
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace surfaceTensionModels
97 } // End namespace reactingMultiphaseEuler
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
constantSurfaceTensionCoefficient(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
bool registerObject() const noexcept
Should objects created with this IOobject be registered?
A class for managing temporary objects.
Definition: HashPtrTable.H:50
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:49
Namespace for OpenFOAM.