All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-2022 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 "DemandDrivenMeshObject.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 :
54  <
55  fvMesh,
56  MoveableMeshObject,
57  leastSquaresVectors
58  >
59 {
60  // Private Data
61 
62  //- Least-squares gradient vectors
63  surfaceVectorField pVectors_;
64  surfaceVectorField nVectors_;
65 
66 
67  // Private Member Functions
68 
69  //- Construct Least-squares gradient vectors
70  void calcLeastSquaresVectors();
71 
72 
73 protected:
74 
75  friend class DemandDrivenMeshObject
76  <
77  fvMesh,
80  >;
81 
82  // Protected Constructors
83 
84  //- Construct given an fvMesh
85  explicit leastSquaresVectors(const fvMesh&);
86 
87 
88 public:
89 
90  // Declare name of the class and its debug switch
91  TypeName("leastSquaresVectors");
92 
93 
94  //- Destructor
95  virtual ~leastSquaresVectors();
96 
97 
98  // Member Functions
99 
100  //- Return reference to owner least square vectors
101  const surfaceVectorField& pVectors() const
102  {
103  return pVectors_;
104  }
105 
106  //- Return reference to neighbour least square vectors
107  const surfaceVectorField& nVectors() const
108  {
109  return nVectors_;
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 // ************************************************************************* //
Templated abstract base-class for demand-driven mesh objects used to automate their allocation to the...
Generic GeometricField class.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Least-squares gradient scheme vectors.
virtual bool movePoints()
Delete the least square vectors when the mesh moves.
virtual ~leastSquaresVectors()
Destructor.
leastSquaresVectors(const fvMesh &)
Construct given an fvMesh.
TypeName("leastSquaresVectors")
const surfaceVectorField & pVectors() const
Return reference to owner least square vectors.
const surfaceVectorField & nVectors() const
Return reference to neighbour least square vectors.
Namespace for OpenFOAM.
Foam::surfaceFields.