FreeFOAM The Cross-Platform CFD Toolkit
extendedLeastSquaresVectors.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::extendedLeastSquaresVectors
26 
27 Description
28  Extended molecule least-squares gradient scheme vectors
29 
30 SourceFiles
31  extendedLeastSquaresVectors.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef extendedLeastSquaresVectors_H
36 #define extendedLeastSquaresVectors_H
37 
38 #include <OpenFOAM/MeshObject.H>
39 #include <finiteVolume/fvMesh.H>
41 #include <OpenFOAM/labelPair.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class extendedLeastSquaresVectors Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public MeshObject<fvMesh, extendedLeastSquaresVectors>
55 {
56  // Private data
57 
58  //- Minimum determinant criterion to choose extra cells
59  scalar minDet_;
60 
61  //- Least-squares gradient vectors
62  mutable surfaceVectorField* pVectorsPtr_;
63  mutable surfaceVectorField* nVectorsPtr_;
64 
65  mutable List<labelPair>* additionalCellsPtr_;
66  mutable vectorField* additionalVectorsPtr_;
67 
68 
69  // Private member functions
70 
71  //- Construct Least-squares gradient vectors
72  void makeLeastSquaresVectors() const;
73 
74 
75 public:
76 
77  // Declare name of the class and its debug switch
78  TypeName("extendedLeastSquaresVectors");
79 
80 
81  // Constructors
82 
83  //- Construct given an fvMesh and the minimum determinant criterion
85  (
86  const fvMesh&,
87  const scalar minDet
88  );
89 
90 
91  // Destructor
92 
94 
95 
96  // Member functions
97 
98  //- Return reference to owner least square vectors
99  const surfaceVectorField& pVectors() const;
100 
101  //- Return reference to neighbour least square vectors
102  const surfaceVectorField& nVectors() const;
103 
104 
105  //- Return reference to additional cells
106  const List<labelPair>& additionalCells() const;
107 
108  //- Return reference to additional least square vectors
109  const vectorField& additionalVectors() const;
110 
111 
112  //- Delete the least square vectors when the mesh moves
113  virtual bool movePoints();
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************ vim: set sw=4 sts=4 et: ************************ //