src/transportModels/interfaceProperties/gammaContactAngle/timeVaryingGammaContactAngle/timeVaryingGammaContactAngleFvPatchScalarField.H

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