distributionContactAngleForce.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) 2017 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::distributionContactAngleForce
26 
27 Description
28  PDF distribution based film contact angle force
29 
30 See also
31  Foam::regionModels::surfaceFilmModels::contactAngleForce
32  Foam::distributionModel
33 
34 SourceFiles
35  distributionContactAngleForce.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef distributionContactAngleForce_H
40 #define distributionContactAngleForce_H
41 
42 #include "contactAngleForce.H"
43 #include "distributionModel.H"
44 #include "cachedRandom.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace regionModels
51 {
52 namespace surfaceFilmModels
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class distributionContactAngleForce Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 :
61  public contactAngleForce
62 {
63  // Private Data
64 
65  //- Random number generator
66  cachedRandom rndGen_;
67 
68  //- Parcel size PDF model
69  const autoPtr<distributionModel> distribution_;
70 
71 
72  // Private member functions
73 
74  //- Disallow default bitwise copy construct
76 
77  //- Disallow default bitwise assignment
78  void operator=(const distributionContactAngleForce&);
79 
80 
81 protected:
82 
83  //- Return the contact angle field
84  virtual tmp<volScalarField> theta() const;
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("distributionContactAngle");
91 
92 
93  // Constructors
94 
95  //- Construct from surface film model
97  (
99  const dictionary& dict
100  );
101 
102 
103  //- Destructor
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace surfaceFilmModels
111 } // End namespace regionModels
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
const surfaceFilmModel & film() const
Return const access to the film surface film model.
virtual tmp< volScalarField > theta() const
Return the contact angle field.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Random number generator.
Definition: cachedRandom.H:63
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
Base-class for film contact angle force models.
TypeName("distributionContactAngle")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.