dynamicAlphaContactAngleFvPatchScalarField.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) 2011-2013 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::dynamicAlphaContactAngleFvPatchScalarField
26 
27 Description
28  A dynamic alphaContactAngle scalar boundary condition
29  (alphaContactAngleFvPatchScalarField)
30 
31 SourceFiles
32  dynamicAlphaContactAngleFvPatchScalarField.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef dynamicAlphaContactAngleFvPatchScalarField_H
37 #define dynamicAlphaContactAngleFvPatchScalarField_H
38 
39 #include "alphaContactAngleFvPatchScalarField.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class dynamicAlphaContactAngleFvPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
53 {
54  // Private data
55 
56  //- Equilibrium contact angle
57  scalar theta0_;
58 
59  //- Dynamic contact angle velocity scale
60  scalar uTheta_;
61 
62  //- Limiting advancing contact angle
63  scalar thetaA_;
64 
65  //- Limiting receeding contact angle
66  scalar thetaR_;
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("dynamicAlphaContactAngle");
73 
74 
75  // Constructors
76 
77  //- Construct from patch and internal field
79  (
80  const fvPatch&,
82  );
83 
84  //- Construct from patch, internal field and dictionary
86  (
87  const fvPatch&,
89  const dictionary&
90  );
91 
92  //- Construct by mapping given
93  // dynamicAlphaContactAngleFvPatchScalarField
94  // onto a new patch
96  (
98  const fvPatch&,
100  const fvPatchFieldMapper&
101  );
102 
103  //- Construct as copy
105  (
107  );
108 
109  //- Construct and return a clone
110  virtual tmp<fvPatchScalarField> clone() const
111  {
113  (
115  );
116  }
117 
118  //- Construct as copy setting internal field reference
120  (
123  );
124 
125  //- Construct and return a clone setting internal field reference
127  (
129  ) const
130  {
132  (
134  );
135  }
136 
137 
138  // Member functions
139 
140  //- Evaluate and return dynamic contact-angle
141  virtual tmp<scalarField> theta
142  (
143  const fvPatchVectorField& Up,
144  const fvsPatchVectorField& nHat
145  ) const;
146 
147  //- Write
148  virtual void write(Ostream&) const;
149 };
150 
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 } // End namespace Foam
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 #endif
159 
160 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
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:66
A dynamic alphaContactAngle scalar boundary condition (alphaContactAngleFvPatchScalarField) ...
Foam::fvPatchFieldMapper.
dynamicAlphaContactAngleFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("dynamicAlphaContactAngle")
Runtime type information.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Abstract base class for alphaContactAngle boundary conditions.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual tmp< scalarField > theta(const fvPatchVectorField &Up, const fvsPatchVectorField &nHat) const
Evaluate and return dynamic contact-angle.
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.