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