src/finiteVolume/finiteVolume/gradSchemes/extendedLeastSquaresGrad/extendedLeastSquaresVectors.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::extendedLeastSquaresVectors
  27
  28 Description
  29     Extended molecule least-squares gradient scheme vectors
  30
  31 SourceFiles
  32     extendedLeastSquaresVectors.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef extendedLeastSquaresVectors_H
  37 #define extendedLeastSquaresVectors_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 extendedLeastSquaresVectors Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class extendedLeastSquaresVectors
  54 :
  55     public MeshObject<fvMesh, extendedLeastSquaresVectors>
  56 {
  57     // Private data
  58
  59         //- Minimum determinant criterion to choose extra cells
  60         scalar minDet_;
  61
  62         //- Least-squares gradient vectors
  63         mutable surfaceVectorField* pVectorsPtr_;
  64         mutable surfaceVectorField* nVectorsPtr_;
  65
  66         mutable List<labelPair>* additionalCellsPtr_;
  67         mutable vectorField* additionalVectorsPtr_;
  68
  69
  70     // Private member functions
  71
  72         //- Construct Least-squares gradient vectors
  73         void makeLeastSquaresVectors() const;
  74
  75
  76 public:
  77
  78     // Declare name of the class and its debug switch
  79     TypeName("extendedLeastSquaresVectors");
  80
  81
  82     // Constructors
  83
  84         //- Construct given an fvMesh and the minimum determinant criterion
  85         extendedLeastSquaresVectors
  86         (
  87             const fvMesh&,
  88             const scalar minDet
  89         );
  90
  91
  92     // Destructor
  93
  94         virtual ~extendedLeastSquaresVectors();
  95
  96
  97     // Member functions
  98
  99         //- Return reference to owner least square vectors
 100         const surfaceVectorField& pVectors() const;
 101
 102         //- Return reference to neighbour least square vectors
 103         const surfaceVectorField& nVectors() const;
 104
 105
 106         //- Return reference to additional cells
 107         const List<labelPair>& additionalCells() const;
 108
 109         //- Return reference to additional least square vectors
 110         const vectorField& additionalVectors() const;
 111
 112
 113         //- Delete the least square vectors when the mesh moves
 114         virtual bool movePoints();
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //