perturbedTemperatureDependentContactAngleForce.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::regionModels::surfaceFilmModels::
28  perturbedTemperatureDependentContactAngleForce
29 
30 Description
31  Temperature dependent contact angle force with a stochastic perturbation
32 
33  The contact angle in degrees is specified as a Foam::Function1 type, to
34  enable the use of, e.g. constant, polynomial, table values and the
35  stochastic perturbation obtained from a
36  Foam::distributionModels::distributionModel
37 
38 See also
39  Foam::regionModels::surfaceFilmModels::contactAngleForce
40  Foam::regionModels::surfaceFilmModels::temperatureDependentContactAngleForce
41  Foam::regionModels::surfaceFilmModels::distributionContactAngleForce
42  Foam::Function1Types
43  Foam::distributionModel
44 
45 SourceFiles
46  perturbedTemperatureDependentContactAngleForce.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef perturbedTemperatureDependentContactAngleForce_H
51 #define perturbedTemperatureDependentContactAngleForce_H
52 
53 #include "contactAngleForce.H"
54 #include "Function1.H"
55 #include "distributionModel.H"
56 #include "Random.H"
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 namespace Foam
61 {
62 namespace regionModels
63 {
64 namespace surfaceFilmModels
65 {
66 
67 /*---------------------------------------------------------------------------*\
68  Class perturbedTemperatureDependentContactAngleForce Declaration
69 \*---------------------------------------------------------------------------*/
70 
72 :
73  public contactAngleForce
74 {
75  // Private Data
76 
77  //- Contact angle function
78  autoPtr<Function1<scalar>> thetaPtr_;
79 
80  //- Random number generator
81  Random rndGen_;
82 
83  //- Parcel size PDF model
84  const autoPtr<distributionModel> distribution_;
85 
86 
87  // Private member functions
88 
89  //- No copy construct
91  (
93  ) = delete;
94 
95  //- No copy assignment
96  void operator=
97  (
99  ) = delete;
100 
101 
102 protected:
103 
104  //- Return the contact angle field
105  virtual tmp<volScalarField> theta() const;
106 
107 
108 public:
109 
110  //- Runtime type information
111  TypeName("perturbedTemperatureDependentContactAngle");
112 
113 
114  // Constructors
115 
116  //- Construct from surface film model
118  (
120  const dictionary& dict
121  );
122 
123 
124  //- Destructor
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace surfaceFilmModels
132 } // End namespace regionModels
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************************************************************* //
Foam::Random
Random number generator.
Definition: Random.H:59
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::regionModels::surfaceFilmModels::contactAngleForce
Base-class for film contact angle force models.
Definition: contactAngleForce.H:57
Function1.H
Foam::regionModels::surfaceFilmModels::perturbedTemperatureDependentContactAngleForce
Temperature dependent contact angle force with a stochastic perturbation.
Definition: perturbedTemperatureDependentContactAngleForce.H:69
Foam::regionModels::surfaceFilmModels::filmSubModelBase::film
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
Definition: filmSubModelBaseI.H:39
Foam::regionModels::surfaceFilmModels::perturbedTemperatureDependentContactAngleForce::~perturbedTemperatureDependentContactAngleForce
virtual ~perturbedTemperatureDependentContactAngleForce()
Destructor.
Definition: perturbedTemperatureDependentContactAngleForce.C:77
Foam::regionModels::surfaceFilmModels::perturbedTemperatureDependentContactAngleForce::theta
virtual tmp< volScalarField > theta() const
Return the contact angle field.
Definition: perturbedTemperatureDependentContactAngleForce.C:84
Foam::regionModels::surfaceFilmModels::surfaceFilmRegionModel
Base class for surface film models.
Definition: surfaceFilmRegionModel.H:55
Foam::subModelBase::dict
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:113
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Random.H
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::regionModels::surfaceFilmModels::perturbedTemperatureDependentContactAngleForce::TypeName
TypeName("perturbedTemperatureDependentContactAngle")
Runtime type information.
distributionModel.H