gravitationalContactAngle.C
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) 2023-2024 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 \*---------------------------------------------------------------------------*/
25 
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34 namespace contactAngleModels
35 {
38 }
39 }
40 
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
45 :
46  theta0_(dict.lookup<scalar>("theta0", unitDegrees)),
47  gTheta_(dict.lookup<scalar>("gTheta", dimAcceleration)),
48  thetaAdv_(dict.lookup<scalar>("thetaAdv", unitDegrees)),
49  thetaRec_(dict.lookup<scalar>("thetaRec", unitDegrees))
50 {}
51 
52 
53 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
54 
56 {}
57 
58 
59 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
60 
63 (
64  const fvPatchVectorField& Up,
65  const vectorField& nHat
66 ) const
67 {
70 
71  const scalarField uCoeff(tanh((nHat & g.value())/gTheta_));
72 
73  return cos
74  (
75  theta0_
76  + (thetaRec_ - theta0_)*max(uCoeff, scalar(0))
77  - (thetaAdv_ - theta0_)*min(uCoeff, scalar(0))
78  );
79 }
80 
81 
83 {
84  writeEntry(os, "theta0", unitDegrees, theta0_);
85  writeEntry(os, "gTheta", dimAcceleration, gTheta_);
86  writeEntry(os, "thetaAdv", unitDegrees, thetaAdv_);
87  writeEntry(os, "thetaRec", unitDegrees, thetaRec_);
88 }
89 
90 
91 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
Type & value()
Return a reference to the value.
Abstract base-class for contact-angle models which return the cosine contact angle field.
Gravitational acceleration based contact angle model.
virtual void write(Ostream &os) const
Write data in dictionary format.
virtual tmp< scalarField > cosTheta(const fvPatchVectorField &Up, const vectorField &nHat) const
Cosine of the contact angle.
gravitational(const dictionary &dict)
Construct from dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:88
const objectRegistry & db() const
Return local objectRegistry.
Definition: fvPatchField.C:143
const Type & lookupObject(const word &name) const
Lookup and return the object of the given Type and name.
A class for managing temporary objects.
Definition: tmp.H:55
addToRunTimeSelectionTable(contactAngleModel, constant, dictionary)
defineTypeNameAndDebug(constant, 0)
Namespace for OpenFOAM.
dimensionedScalar tanh(const dimensionedScalar &ds)
const dimensionSet dimAcceleration
layerAndWeight min(const layerAndWeight &a, const layerAndWeight &b)
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
layerAndWeight max(const layerAndWeight &a, const layerAndWeight &b)
dimensionedScalar cos(const dimensionedScalar &ds)
const unitConversion unitDegrees
dictionary dict