src/finiteVolume/interpolation/surfaceInterpolation/schemes/skewCorrected/skewCorrectionVectors.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::skewCorrectionVectors
  27
  28 Description
  29     Skew-correction vectors for the skewness-corrected interpolation scheme
  30
  31 SourceFiles
  32     skewCorrectionVectors.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef skewCorrectionVectors_H
  37 #define skewCorrectionVectors_H
  38
  39 #include "MeshObject.H"
  40 #include "fvMesh.H"
  41 #include "surfaceFieldsFwd.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class fvMesh;
  49
  50 /*---------------------------------------------------------------------------*\
  51                     Class skewCorrectionVectors Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class skewCorrectionVectors
  55 :
  56     public MeshObject<fvMesh, skewCorrectionVectors>
  57 {
  58     // Private data
  59
  60         //- Is mesh skew
  61         mutable bool skew_;
  62
  63         //- Skew correction vectors
  64         mutable surfaceVectorField* skewCorrectionVectors_;
  65
  66         //- Construct skewness correction vectors
  67         void makeSkewCorrectionVectors() const;
  68
  69
  70 public:
  71
  72     TypeName("skewCorrectionVectors");
  73
  74
  75     // Constructors
  76
  77         explicit skewCorrectionVectors(const fvMesh& mesh);
  78
  79
  80     // Destructor
  81
  82         virtual ~skewCorrectionVectors();
  83
  84
  85     // Member functions
  86
  87         //- Return whether mesh is skew or not
  88         bool skew() const;
  89
  90         //- Return reference to skew vectors array
  91         const surfaceVectorField& operator()() const;
  92
  93         //- Delete the correction vectors when the mesh moves
  94         virtual bool movePoints();
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************************************************************* //