OpenFOAM logo
Open Source CFD Toolkit

leastSquaresVectors.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     leastSquaresVectors
00027 
00028 Description
00029     Least-squares gradient scheme vectors
00030 
00031 SourceFiles
00032     leastSquaresVectors.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef leastSquaresVectors_H
00037 #define leastSquaresVectors_H
00038 
00039 #include "MeshObject.H"
00040 #include "surfaceFieldsFwd.H"
00041 #include "labelPair.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                      Class leastSquaresVectors Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class leastSquaresVectors
00053 :
00054     public MeshObject<leastSquaresVectors>
00055 {
00056     // Private data
00057 
00058         //- Least-squares gradient vectors
00059         mutable surfaceVectorField* pVectorsPtr_;
00060         mutable surfaceVectorField* nVectorsPtr_;
00061 
00062 
00063     // Private member functions
00064 
00065         //- Construct Least-squares gradient vectors
00066         void makeLeastSquaresVectors() const;
00067 
00068 
00069 public:
00070 
00071     // Declare name of the class and it's debug switch
00072     TypeName("leastSquaresVectors");
00073 
00074 
00075     // Constructors
00076 
00077         //- Construct given an fvMesh
00078         explicit leastSquaresVectors(const fvMesh&);
00079 
00080 
00081     // Destructor
00082 
00083         virtual ~leastSquaresVectors();
00084 
00085 
00086     // Member functions
00087 
00088         //- Return reference to owner least square vectors
00089         const surfaceVectorField& pVectors() const;
00090 
00091         //- Return reference to neighbour least square vectors
00092         const surfaceVectorField& nVectors() const;
00093 
00094 
00095         //- Delete the least square vectors when the mesh moves
00096         virtual bool movePoints();
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************************************************************* //
For further information go to www.openfoam.org