leastSquaresVectors.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
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::leastSquaresVectors
26 
27 Description
28  Least-squares gradient scheme vectors
29 
30 SourceFiles
31  leastSquaresVectors.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef leastSquaresVectors_H
36 #define leastSquaresVectors_H
37 
38 #include "MeshObject.H"
39 #include "fvMesh.H"
40 #include "surfaceFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class leastSquaresVectors Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public MeshObject<fvMesh, MoveableMeshObject, leastSquaresVectors>
54 {
55  // Private Data
56 
57  //- Least-squares gradient vectors
58  surfaceVectorField pVectors_;
59  surfaceVectorField nVectors_;
60 
61 
62  // Private Member Functions
63 
64  //- Construct Least-squares gradient vectors
65  void calcLeastSquaresVectors();
66 
67 
68 public:
69 
70  // Declare name of the class and its debug switch
71  TypeName("leastSquaresVectors");
72 
73 
74  // Constructors
75 
76  //- Construct given an fvMesh
77  explicit leastSquaresVectors(const fvMesh&);
78 
79 
80  //- Destructor
81  virtual ~leastSquaresVectors();
82 
83 
84  // Member Functions
85 
86  //- Return reference to owner least square vectors
87  const surfaceVectorField& pVectors() const
88  {
89  return pVectors_;
90  }
91 
92  //- Return reference to neighbour least square vectors
93  const surfaceVectorField& nVectors() const
94  {
95  return nVectors_;
96  }
97 
98  //- Delete the least square vectors when the mesh moves
99  virtual bool movePoints();
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
Foam::surfaceFields.
const surfaceVectorField & pVectors() const
Return reference to owner least square vectors.
leastSquaresVectors(const fvMesh &)
Construct given an fvMesh.
Least-squares gradient scheme vectors.
virtual bool movePoints()
Delete the least square vectors when the mesh moves.
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:85
const surfaceVectorField & nVectors() const
Return reference to neighbour least square vectors.
TypeName("leastSquaresVectors")
virtual ~leastSquaresVectors()
Destructor.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Namespace for OpenFOAM.