leastSquaresGrad.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::fv::leastSquaresGrad
26 
27 Description
28  Second-order gradient scheme using least-squares.
29 
30 SourceFiles
31  leastSquaresGrad.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef leastSquaresGrad_H
36 #define leastSquaresGrad_H
37 
38 #include "gradScheme.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace fv
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class leastSquaresGrad Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class Type>
55 class leastSquaresGrad
56 :
57  public fv::gradScheme<Type>
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("leastSquares");
63 
64 
65  // Constructors
66 
67  //- Construct from mesh
69  :
70  gradScheme<Type>(mesh)
71  {}
72 
73  //- Construct from Istream
75  :
76  gradScheme<Type>(mesh)
77  {}
78 
79  //- Disallow default bitwise copy construction
80  leastSquaresGrad(const leastSquaresGrad&) = delete;
81 
82 
83  // Member Functions
84 
85  //- Return the gradient of the given field to the gradScheme::grad
86  // for optional caching
88  calcGrad
89  (
90  const VolField<Type>& vsf,
91  const word& name
92  ) const;
93 
94 
95  // Member Operators
96 
97  //- Disallow default bitwise assignment
98  void operator=(const leastSquaresGrad&) = delete;
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace fv
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #ifdef NoRepository
113  #include "leastSquaresGrad.C"
114 #endif
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
Generic GeometricField class.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Abstract base class for gradient schemes.
Definition: gradScheme.H:63
const fvMesh & mesh() const
Return mesh reference.
Definition: gradScheme.H:116
Second-order gradient scheme using least-squares.
TypeName("leastSquares")
Runtime type information.
void operator=(const leastSquaresGrad &)=delete
Disallow default bitwise assignment.
leastSquaresGrad(const fvMesh &mesh)
Construct from mesh.
virtual tmp< VolField< typename outerProduct< vector, Type >::type > > calcGrad(const VolField< Type > &vsf, const word &name) const
Return the gradient of the given field to the gradScheme::grad.
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
labelList fv(nPoints)