temperatureDependentAlphaContactAngleFvPatchScalarField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2015-2018 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 alphaContactAngle scalar boundary condition.
29 
30  The contact angle is evaluated from the specified Foam::Function1 for the
31  temperature field looked-up from the mesh database the name of which
32  may optionally be provided.
33 
34 Usage
35  \table
36  Property | Description | Required | Default value
37  T | Temperature field name | no | T
38  theta0 | Contact angle function | yes |
39  \endtable
40 
41  Example of the boundary condition specification:
42  \verbatim
43  <patchName>
44  {
45  type temperatureDependentAlphaContactAngle;
46  theta0 constant 60;
47  }
48  \endverbatim
49 
50 See also
51  Foam::alphaContactAngleFvPatchScalarField
52  Foam::constantAlphaContactAngleFvPatchScalarField
53  Foam::Function1
54 
55 SourceFiles
56  temperatureDependentAlphaContactAngleFvPatchScalarField.C
57 
58 \*---------------------------------------------------------------------------*/
59 
60 #ifndef temperatureDependentAlphaContactAngleFvPatchScalarField_H
61 #define temperatureDependentAlphaContactAngleFvPatchScalarField_H
62 
63 #include "alphaContactAngleFvPatchScalarField.H"
64 #include "Function1.H"
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 namespace Foam
69 {
70 
71 /*---------------------------------------------------------------------------*\
72  Class temperatureDependentAlphaContactAngleFvPatch Declaration
73 \*---------------------------------------------------------------------------*/
74 
75 class temperatureDependentAlphaContactAngleFvPatchScalarField
76 :
77  public alphaContactAngleFvPatchScalarField
78 {
79  // Private data
80 
81  //- Name of temperature field, default = "T"
82  word TName_;
83 
84  //- Equilibrium contact angle function
85  autoPtr<Function1<scalar>> theta0_;
86 
87 
88 public:
89 
90  //- Runtime type information
91  TypeName("temperatureDependentAlphaContactAngle");
92 
93 
94  // Constructors
95 
96  //- Construct from patch and internal field
98  (
99  const fvPatch&,
101  );
102 
103  //- Construct from patch, internal field and dictionary
105  (
106  const fvPatch&,
108  const dictionary&
109  );
110 
111  //- Construct by mapping given
112  // temperatureDependentAlphaContactAngleFvPatchScalarField
113  // onto a new patch
115  (
117  const fvPatch&,
119  const fvPatchFieldMapper&
120  );
121 
122  //- Construct as copy
124  (
126  );
127 
128  //- Construct and return a clone
129  virtual tmp<fvPatchScalarField> clone() const
130  {
132  (
134  (
135  *this
136  )
137  );
138  }
139 
140  //- Construct as copy setting internal field reference
142  (
145  );
146 
147  //- Construct and return a clone setting internal field reference
149  (
151  ) const
152  {
154  (
156  (
157  *this,
158  iF
159  )
160  );
161  }
162 
164  // Member functions
165 
166  //- Return the equilibrium contact-angle
167  virtual tmp<scalarField> theta
168  (
169  const fvPatchVectorField& Up,
170  const fvsPatchVectorField& nHat
171  ) const;
172 
173  //- Write
174  virtual void write(Ostream&) const;
175 };
176 
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 } // End namespace Foam
181 
182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183 
184 #endif
185 
186 // ************************************************************************* //
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
virtual tmp< scalarField > theta(const fvPatchVectorField &Up, const fvsPatchVectorField &nHat) const
Return the equilibrium contact-angle.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
TypeName("temperatureDependentAlphaContactAngle")
Runtime type information.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
A class for managing temporary objects.
Definition: PtrList.H:53
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.