liquidPropertiesSurfaceTension.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) 2017 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::surfaceTensionModels::liquidProperties
28
29Description
30 Temperature-dependent surface tension model in which the surface tension
31 function provided by the phase Foam::liquidProperties class is used.
32
33Usage
34 \table
35 Property | Description | Required | Default value
36 phase | Phase name | yes |
37 \endtable
38
39 Example of the surface tension specification:
40 \verbatim
41 sigma
42 {
43 type liquidProperties;
44 phase water;
45 }
46 \endverbatim
47
48See also
49 Foam::surfaceTensionModel
50
51SourceFiles
52 liquidPropertiesSurfaceTension.C
53
54\*---------------------------------------------------------------------------*/
55
56#ifndef liquidPropertiesSurfaceTension_H
57#define liquidPropertiesSurfaceTension_H
58
59#include "surfaceTensionModel.H"
60
61// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62
63namespace Foam
64{
65
66namespace surfaceTensionModels
67{
68
69/*---------------------------------------------------------------------------*\
70 Class liquidProperties Declaration
71\*---------------------------------------------------------------------------*/
72
73class liquidProperties
74:
75 public surfaceTensionModel
76{
77 // Private data
78
79 //- Name of the liquid phase
80 word phaseName_;
81
83public:
84
85 //- Runtime type information
86 TypeName("liquidProperties");
87
88
89 // Constructors
90
91 //- Construct from dictionary and mesh
93 (
94 const dictionary& dict,
95 const fvMesh& mesh
96 );
97
98
99 //- Destructor
100 virtual ~liquidProperties() = default;
102
103 // Member Functions
104
105 //- Surface tension coefficient
106 virtual tmp<volScalarField> sigma() const;
107
108 //- Update surface tension coefficient from given dictionary
109 virtual bool readDict(const dictionary& dict);
110
111 //- Write in dictionary format
112 virtual bool writeData(Ostream& os) const;
113};
114
116// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117
118} // End namespace surfaceTensionModels
119} // End namespace Foam
120
121// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122
123#endif
124
125// ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Temperature-dependent surface tension model in which the surface tension function provided by the pha...
liquidProperties(const dictionary &dict, const fvMesh &mesh)
Construct from dictionary and mesh.
virtual ~liquidProperties()=default
Destructor.
virtual bool writeData(Ostream &os) const
Write in dictionary format.
virtual bool readDict(const dictionary &dict)
Update surface tension coefficient from given dictionary.
virtual tmp< volScalarField > sigma() const
Surface tension coefficient.
TypeName("liquidProperties")
Runtime type information.
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
dynamicFvMesh & mesh
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73