src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/constantAlphaContactAngle/constantAlphaContactAngleFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2010 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
  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::constantAlphaContactAngleFvPatchScalarField
  26
  27 Description
  28     A constant alphaContactAngle scalar boundary condition
  29     (alphaContactAngleFvPatchScalarField)
  30
  31 SourceFiles
  32     constantAlphaContactAngleFvPatchScalarField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef constantAlphaContactAngleFvPatchScalarField_H
  37 #define constantAlphaContactAngleFvPatchScalarField_H
  38
  39 #include "alphaContactAngleFvPatchScalarField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class constantAlphaContactAngleFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class constantAlphaContactAngleFvPatchScalarField
  51 :
  52     public alphaContactAngleFvPatchScalarField
  53 {
  54     // Private data
  55
  56         //- Equilibrium contact angle
  57         scalar theta0_;
  58
  59
  60 public:
  61
  62     //- Runtime type information
  63     TypeName("constantAlphaContactAngle");
  64
  65
  66     // Constructors
  67
  68         //- Construct from patch and internal field
  69         constantAlphaContactAngleFvPatchScalarField
  70         (
  71             const fvPatch&,
  72             const DimensionedField<scalar, volMesh>&
  73         );
  74
  75         //- Construct from patch, internal field and dictionary
  76         constantAlphaContactAngleFvPatchScalarField
  77         (
  78             const fvPatch&,
  79             const DimensionedField<scalar, volMesh>&,
  80             const dictionary&
  81         );
  82
  83         //- Construct by mapping given
  84         //  constantAlphaContactAngleFvPatchScalarField
  85         //  onto a new patch
  86         constantAlphaContactAngleFvPatchScalarField
  87         (
  88             const constantAlphaContactAngleFvPatchScalarField&,
  89             const fvPatch&,
  90             const DimensionedField<scalar, volMesh>&,
  91             const fvPatchFieldMapper&
  92         );
  93
  94         //- Construct as copy
  95         constantAlphaContactAngleFvPatchScalarField
  96         (
  97             const constantAlphaContactAngleFvPatchScalarField&
  98         );
  99
 100         //- Construct and return a clone
 101         virtual tmp<fvPatchScalarField> clone() const
 102         {
 103             return tmp<fvPatchScalarField>
 104             (
 105                 new constantAlphaContactAngleFvPatchScalarField(*this)
 106             );
 107         }
 108
 109         //- Construct as copy setting internal field reference
 110         constantAlphaContactAngleFvPatchScalarField
 111         (
 112             const constantAlphaContactAngleFvPatchScalarField&,
 113             const DimensionedField<scalar, volMesh>&
 114         );
 115
 116         //- Construct and return a clone setting internal field reference
 117         virtual tmp<fvPatchScalarField> clone
 118         (
 119             const DimensionedField<scalar, volMesh>& iF
 120         ) const
 121         {
 122             return tmp<fvPatchScalarField>
 123             (
 124                 new constantAlphaContactAngleFvPatchScalarField(*this, iF)
 125             );
 126         }
 127
 128
 129     // Member functions
 130
 131         //- Return the equilibrium contact-angle
 132         virtual tmp<scalarField> theta
 133         (
 134             const fvPatchVectorField& Up,
 135             const fvsPatchVectorField& nHat
 136         ) const;
 137
 138         //- Write
 139         virtual void write(Ostream&) const;
 140 };
 141
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 } // End namespace Foam
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #endif
 150
 151 // ************************************************************************* //