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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::dynamicAlphaContactAngleFvPatchScalarField
  27
  28 Description
  29     A dynamic alphaContactAngle scalar boundary condition
  30     (alphaContactAngleFvPatchScalarField)
  31
  32 SourceFiles
  33     dynamicAlphaContactAngleFvPatchScalarField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef dynamicAlphaContactAngleFvPatchScalarField_H
  38 #define dynamicAlphaContactAngleFvPatchScalarField_H
  39
  40 #include "alphaContactAngleFvPatchScalarField.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class dynamicAlphaContactAngleFvPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class dynamicAlphaContactAngleFvPatchScalarField
  52 :
  53     public alphaContactAngleFvPatchScalarField
  54 {
  55     // Private data
  56
  57         //- Equilibrium contact angle
  58         scalar theta0_;
  59
  60         //- Dynamic contact angle velocity scale
  61         scalar uTheta_;
  62
  63         //- Limiting advancing contact angle
  64         scalar thetaA_;
  65
  66         //- Limiting receeding contact angle
  67         scalar thetaR_;
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("dynamicAlphaContactAngle");
  74
  75
  76     // Constructors
  77
  78         //- Construct from patch and internal field
  79         dynamicAlphaContactAngleFvPatchScalarField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<scalar, volMesh>&
  83         );
  84
  85         //- Construct from patch, internal field and dictionary
  86         dynamicAlphaContactAngleFvPatchScalarField
  87         (
  88             const fvPatch&,
  89             const DimensionedField<scalar, volMesh>&,
  90             const dictionary&
  91         );
  92
  93         //- Construct by mapping given
  94         //  dynamicAlphaContactAngleFvPatchScalarField
  95         //  onto a new patch
  96         dynamicAlphaContactAngleFvPatchScalarField
  97         (
  98             const dynamicAlphaContactAngleFvPatchScalarField&,
  99             const fvPatch&,
 100             const DimensionedField<scalar, volMesh>&,
 101             const fvPatchFieldMapper&
 102         );
 103
 104         //- Construct as copy
 105         dynamicAlphaContactAngleFvPatchScalarField
 106         (
 107             const dynamicAlphaContactAngleFvPatchScalarField&
 108         );
 109
 110         //- Construct and return a clone
 111         virtual tmp<fvPatchScalarField> clone() const
 112         {
 113             return tmp<fvPatchScalarField>
 114             (
 115                 new dynamicAlphaContactAngleFvPatchScalarField(*this)
 116             );
 117         }
 118
 119         //- Construct as copy setting internal field reference
 120         dynamicAlphaContactAngleFvPatchScalarField
 121         (
 122             const dynamicAlphaContactAngleFvPatchScalarField&,
 123             const DimensionedField<scalar, volMesh>&
 124         );
 125
 126         //- Construct and return a clone setting internal field reference
 127         virtual tmp<fvPatchScalarField> clone
 128         (
 129             const DimensionedField<scalar, volMesh>& iF
 130         ) const
 131         {
 132             return tmp<fvPatchScalarField>
 133             (
 134                 new dynamicAlphaContactAngleFvPatchScalarField(*this, iF)
 135             );
 136         }
 137
 138
 139     // Member functions
 140
 141         //- Evaluate and return dynamic contact-angle
 142         virtual tmp<scalarField> theta
 143         (
 144             const fvPatchVectorField& Up,
 145             const fvsPatchVectorField& nHat
 146         ) const;
 147
 148         //- Write
 149         virtual void write(Ostream&) const;
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //