src/vofDynamicMesh/CICSAM/CICSAM.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::CICSAM
  27
  28 Description
  29     linear/upwind CICSAM differencing scheme.
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     CICSAM.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef CICSAM_H
  40 #define CICSAM_H
  41
  42 #include "limitedSurfaceInterpolationScheme.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class CICSAM Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class CICSAM
  54 :
  55     public limitedSurfaceInterpolationScheme<scalar>
  56 {
  57     // Private data
  58
  59         //- Scheme factor
  60         const scalar k_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct
  66         CICSAM(const CICSAM&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const CICSAM&);
  70
  71
  72         //- Calculate individual limiter
  73         scalar limiter
  74         (
  75             const scalar cdWeight,
  76             const scalar faceFlux,
  77             const scalar& phiP,
  78             const scalar& phiN,
  79             const vector& gradcP,
  80             const vector& gradcN,
  81             const scalar Cof,
  82             const vector d
  83         ) const;
  84
  85         //- Calculate individual weight
  86         scalar weight
  87         (
  88             const scalar cdWeight,
  89             const scalar faceFlux,
  90             const scalar& phiP,
  91             const scalar& phiN,
  92             const vector& gradcP,
  93             const vector& gradcN,
  94             const scalar Cof,
  95             const vector d
  96         ) const;
  97
  98 public:
  99
 100     //- Runtime type information
 101     TypeName("CICSAM");
 102
 103
 104     // Constructors
 105
 106         //- Construct from mesh, faceFlux and blendingFactor
 107         CICSAM
 108         (
 109             const fvMesh& mesh,
 110             const surfaceScalarField& faceFlux,
 111             const scalar k
 112         )
 113         :
 114             limitedSurfaceInterpolationScheme<scalar>(mesh, faceFlux),
 115             k_(k)
 116         {}
 117
 118         //- Construct from mesh and Istream.
 119         //  The name of the flux field is read from the Istream and looked-up
 120         //  from the mesh objectRegistry
 121         CICSAM
 122         (
 123             const fvMesh& mesh,
 124             Istream& is
 125         )
 126         :
 127             limitedSurfaceInterpolationScheme<scalar>(mesh, is),
 128             k_(readScalar(is))
 129         {
 130             if (k_ < 0 || k_ > 1)
 131             {
 132                 FatalIOErrorIn("CICSAMWeight(Istream& is)", is)
 133                     << "coefficient = " << k_
 134                     << " should be >= 0 and <= 1"
 135                     << exit(FatalIOError);
 136             }
 137         }
 138
 139         //- Construct from mesh, faceFlux and Istream
 140         CICSAM
 141         (
 142             const fvMesh& mesh,
 143             const surfaceScalarField& faceFlux,
 144             Istream& is
 145         )
 146         :
 147             limitedSurfaceInterpolationScheme<scalar>(mesh, faceFlux),
 148             k_(readScalar(is))
 149         {
 150             if (k_ < 0 || k_ > 1)
 151             {
 152                 FatalIOErrorIn("CICSAMWeight(Istream& is)", is)
 153                     << "coefficient = " << k_
 154                     << " should be >= 0 and <= 1"
 155                     << exit(FatalIOError);
 156             }
 157         }
 158
 159
 160     // Member Functions
 161
 162         //- Return the interpolation limiter
 163         virtual tmp<surfaceScalarField> limiter
 164         (
 165             const volScalarField&
 166         ) const;
 167
 168         //- Return the interpolation weighting factors
 169         virtual tmp<surfaceScalarField> weights
 170         (
 171             const volScalarField&
 172         ) const;
 173 };
 174
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 } // End namespace Foam
 179
 180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 181
 182 #endif
 183
 184 // ************************************************************************* //