src/finiteVolume/finiteVolume/gradSchemes/leastSquaresGrad/leastSquaresVectors.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::leastSquaresVectors
  27
  28 Description
  29     Least-squares gradient scheme vectors
  30
  31 SourceFiles
  32     leastSquaresVectors.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef leastSquaresVectors_H
  37 #define leastSquaresVectors_H
  38
  39 #include "MeshObject.H"
  40 #include "fvMesh.H"
  41 #include "surfaceFieldsFwd.H"
  42 #include "labelPair.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                      Class leastSquaresVectors Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class leastSquaresVectors
  54 :
  55     public MeshObject<fvMesh, leastSquaresVectors>
  56 {
  57     // Private data
  58
  59         //- Least-squares gradient vectors
  60         mutable surfaceVectorField* pVectorsPtr_;
  61         mutable surfaceVectorField* nVectorsPtr_;
  62
  63
  64     // Private member functions
  65
  66         //- Construct Least-squares gradient vectors
  67         void makeLeastSquaresVectors() const;
  68
  69
  70 public:
  71
  72     // Declare name of the class and its debug switch
  73     TypeName("leastSquaresVectors");
  74
  75
  76     // Constructors
  77
  78         //- Construct given an fvMesh
  79         explicit leastSquaresVectors(const fvMesh&);
  80
  81
  82     // Destructor
  83
  84         virtual ~leastSquaresVectors();
  85
  86
  87     // Member functions
  88
  89         //- Return reference to owner least square vectors
  90         const surfaceVectorField& pVectors() const;
  91
  92         //- Return reference to neighbour least square vectors
  93         const surfaceVectorField& nVectors() const;
  94
  95
  96         //- Delete the least square vectors when the mesh moves
  97         virtual bool movePoints();
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //