src/transportModels/interfaceProperties/alphaContactAngle/dynamicAlphaContactAngle/dynamicAlphaContactAngleFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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
  50 class dynamicAlphaContactAngleFvPatchScalarField
  51 :
  52     public alphaContactAngleFvPatchScalarField
  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
  78         dynamicAlphaContactAngleFvPatchScalarField
  79         (
  80             const fvPatch&,
  81             const DimensionedField<scalar, volMesh>&
  82         );
  83
  84         //- Construct from patch, internal field and dictionary
  85         dynamicAlphaContactAngleFvPatchScalarField
  86         (
  87             const fvPatch&,
  88             const DimensionedField<scalar, volMesh>&,
  89             const dictionary&
  90         );
  91
  92         //- Construct by mapping given
  93         //  dynamicAlphaContactAngleFvPatchScalarField
  94         //  onto a new patch
  95         dynamicAlphaContactAngleFvPatchScalarField
  96         (
  97             const dynamicAlphaContactAngleFvPatchScalarField&,
  98             const fvPatch&,
  99             const DimensionedField<scalar, volMesh>&,
 100             const fvPatchFieldMapper&
 101         );
 102
 103         //- Construct as copy
 104         dynamicAlphaContactAngleFvPatchScalarField
 105         (
 106             const dynamicAlphaContactAngleFvPatchScalarField&
 107         );
 108
 109         //- Construct and return a clone
 110         virtual tmp<fvPatchScalarField> clone() const
 111         {
 112             return tmp<fvPatchScalarField>
 113             (
 114                 new dynamicAlphaContactAngleFvPatchScalarField(*this)
 115             );
 116         }
 117
 118         //- Construct as copy setting internal field reference
 119         dynamicAlphaContactAngleFvPatchScalarField
 120         (
 121             const dynamicAlphaContactAngleFvPatchScalarField&,
 122             const DimensionedField<scalar, volMesh>&
 123         );
 124
 125         //- Construct and return a clone setting internal field reference
 126         virtual tmp<fvPatchScalarField> clone
 127         (
 128             const DimensionedField<scalar, volMesh>& iF
 129         ) const
 130         {
 131             return tmp<fvPatchScalarField>
 132             (
 133                 new dynamicAlphaContactAngleFvPatchScalarField(*this, iF)
 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 // ************************************************************************* //