constantAlphaContactAngleFvPatchScalarField.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) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::constantAlphaContactAngleFvPatchScalarField
29
30Description
31 A constant alphaContactAngle scalar boundary condition.
32
33See also
34 Foam::alphaContactAngleTwoPhaseFvPatchScalarField
35 Foam::temperatureDependentAlphaContactAngleFvPatchScalarField
36
37SourceFiles
38 constantAlphaContactAngleFvPatchScalarField.C
39
40\*---------------------------------------------------------------------------*/
41
42#ifndef constantAlphaContactAngleFvPatchScalarField_H
43#define constantAlphaContactAngleFvPatchScalarField_H
44
46
47// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48
49namespace Foam
50{
51
52/*---------------------------------------------------------------------------*\
53 Class constantAlphaContactAngleFvPatch Declaration
54\*---------------------------------------------------------------------------*/
57:
59{
60 // Private data
61
62 //- Equilibrium contact angle
63 scalar theta0_;
64
65
66public:
67
68 //- Runtime type information
69 TypeName("constantAlphaContactAngle");
70
71
72 // Constructors
73
74 //- Construct from patch and internal field
76 (
77 const fvPatch&,
79 );
80
81 //- Construct from patch, internal field and dictionary
83 (
84 const fvPatch&,
86 const dictionary&
87 );
88
89 //- Construct by mapping given
90 // constantAlphaContactAngleFvPatchScalarField
91 // onto a new patch
93 (
95 const fvPatch&,
98 );
99
100 //- Construct as copy
102 (
104 );
105
106 //- Construct and return a clone
107 virtual tmp<fvPatchScalarField> clone() const
108 {
110 (
112 );
113 }
114
115 //- Construct as copy setting internal field reference
117 (
120 );
121
122 //- Construct and return a clone setting internal field reference
124 (
126 ) const
127 {
129 (
131 );
132 }
133
134
135 // Member functions
136
137 //- Return the equilibrium contact-angle
138 virtual tmp<scalarField> theta
139 (
140 const fvPatchVectorField& Up,
141 const fvsPatchVectorField& nHat
142 ) const;
143
144 //- Write
145 virtual void write(Ostream&) const;
146};
147
148
149// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150
151} // End namespace Foam
152
153// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154
155#endif
156
157// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Abstract base class for two-phase alphaContactAngle boundary conditions.
A constant alphaContactAngle scalar boundary condition.
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
virtual tmp< scalarField > theta(const fvPatchVectorField &Up, const fvsPatchVectorField &nHat) const
Return the equilibrium contact-angle.
TypeName("constantAlphaContactAngle")
Runtime type information.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73