temperatureDependentAlphaContactAngleFvPatchScalarField.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-2016 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::temperatureDependentAlphaContactAngleFvPatchScalarField
26 
27 Description
28  Temperature-dependent constant alphaContactAngle scalar boundary condition.
29 
30 Usage
31  \table
32  Property | Description | Required | Default value
33  T | Temperature field name | no | T
34  theta0 | Contact angle data | yes |
35  \endtable
36 
37  Example of the boundary condition specification:
38  \verbatim
39  <patchName>
40  {
41  type temperatureDependentAlphaContactAngle;
42  theta0 constant 60;
43  }
44  \endverbatim
45 
46 See also
47  Foam::alphaContactAngleFvPatchScalarField
48  Foam::constantAlphaContactAngleFvPatchScalarField
49 
50 SourceFiles
51  temperatureDependentAlphaContactAngleFvPatchScalarField.C
52 
53 \*---------------------------------------------------------------------------*/
54 
55 #ifndef temperatureDependentAlphaContactAngleFvPatchScalarField_H
56 #define temperatureDependentAlphaContactAngleFvPatchScalarField_H
57 
58 #include "alphaContactAngleFvPatchScalarField.H"
59 #include "Function1.H"
60 
61 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 
63 namespace Foam
64 {
65 
66 /*---------------------------------------------------------------------------*\
67  Class temperatureDependentAlphaContactAngleFvPatch Declaration
68 \*---------------------------------------------------------------------------*/
69 
70 class temperatureDependentAlphaContactAngleFvPatchScalarField
71 :
72  public alphaContactAngleFvPatchScalarField
73 {
74  // Private data
75 
76  //- Name of temperature field, default = "T"
77  word TName_;
78 
79  //- Equilibrium contact angle table
80  autoPtr<Function1<scalar>> theta0_;
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("temperatureDependentAlphaContactAngle");
87 
88 
89  // Constructors
90 
91  //- Construct from patch and internal field
93  (
94  const fvPatch&,
96  );
97 
98  //- Construct from patch, internal field and dictionary
100  (
101  const fvPatch&,
103  const dictionary&
104  );
105 
106  //- Construct by mapping given
107  // temperatureDependentAlphaContactAngleFvPatchScalarField
108  // onto a new patch
110  (
112  const fvPatch&,
114  const fvPatchFieldMapper&
115  );
116 
117  //- Construct as copy
119  (
121  );
122 
123  //- Construct and return a clone
124  virtual tmp<fvPatchScalarField> clone() const
125  {
127  (
129  (
130  *this
131  )
132  );
133  }
134 
135  //- Construct as copy setting internal field reference
137  (
140  );
141 
142  //- Construct and return a clone setting internal field reference
144  (
146  ) const
147  {
149  (
151  (
152  *this,
153  iF
154  )
155  );
156  }
157 
159  // Member functions
160 
161  //- Return the equilibrium contact-angle
162  virtual tmp<scalarField> theta
163  (
164  const fvPatchVectorField& Up,
165  const fvsPatchVectorField& nHat
166  ) const;
167 
168  //- Write
169  virtual void write(Ostream&) const;
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #endif
180 
181 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
temperatureDependentAlphaContactAngleFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Temperature-dependent constant alphaContactAngle scalar boundary condition.
virtual tmp< scalarField > theta(const fvPatchVectorField &Up, const fvsPatchVectorField &nHat) const
Return the equilibrium contact-angle.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
TypeName("temperatureDependentAlphaContactAngle")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:54
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:65
Namespace for OpenFOAM.