contactAngleForce.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) 2011-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::regionModels::surfaceFilmModels::contactAngleForce
26 
27 Description
28  Base-class for film contact angle force models.
29 
30  The effect of the contact angle force can be ignored over a specified
31  distance from patches.
32 
33 SourceFiles
34  contactAngleForce.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef contactAngleForce_H
39 #define contactAngleForce_H
40 
41 #include "force.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace regionModels
48 {
49 namespace surfaceFilmModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class contactAngleForce Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public force
59 {
60  // Private Data
61 
62  //- Coefficient applied to the contact angle force
63  scalar Ccf_;
64 
65  //- Mask over which force is applied
66  volScalarField mask_;
67 
68 
69  // Private member functions
70 
71  //- Initialise
72  void initialise();
73 
74  //- Disallow default bitwise copy construct
76 
77  //- Disallow default bitwise assignment
78  void operator=(const contactAngleForce&);
79 
80 
81 protected:
82 
83  //- Return the contact angle field
84  virtual tmp<volScalarField> theta() const = 0;
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("contactAngle");
91 
92 
93  // Constructors
94 
95  //- Construct from surface film model
97  (
98  const word& typeName,
100  const dictionary& dict
101  );
102 
103 
104  //- Destructor
105  virtual ~contactAngleForce();
106 
107 
108  // Member Functions
109 
110  //- Correct
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace surfaceFilmModels
118 } // End namespace regionModels
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
virtual tmp< volScalarField > theta() const =0
Return the contact angle field.
TypeName("contactAngle")
Runtime type information.
Base class for film (stress-based) force models.
Definition: force.H:55
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
virtual tmp< fvVectorMatrix > correct(volVectorField &U)
Correct.
A class for handling words, derived from string.
Definition: word.H:59
Base-class for film contact angle force models.
U
Definition: pEqn.H:72
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.