orthogonalSnGrad.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::orthogonalSnGrad
26 
27 Description
28  Simple central-difference snGrad scheme using the cell-centre to cell-centre
29  delta-coefficients.
30 
31 SourceFiles
32  orthogonalSnGrad.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef orthogonalSnGrad_H
37 #define orthogonalSnGrad_H
38 
39 #include "snGradScheme.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace fv
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class orthogonalSnGrad Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class Type>
56 class orthogonalSnGrad
57 :
58  public snGradScheme<Type>
59 {
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("orthogonal");
65 
66 
67  // Constructors
68 
69  //- Construct from mesh
71  :
72  snGradScheme<Type>(mesh)
73  {}
74 
75 
76  //- Construct from mesh and data stream
78  :
79  snGradScheme<Type>(mesh)
80  {}
81 
82 
83  //- Destructor
84  virtual ~orthogonalSnGrad();
85 
86 
87  // Member Functions
88 
89  //- Return the interpolation weighting factors for the given field
91  (
92  const VolField<Type>&
93  ) const
94  {
95  return this->mesh().deltaCoeffs();
96  }
97 
98  //- Return true if this scheme uses an explicit correction
99  virtual bool corrected() const
100  {
101  return false;
102  }
103 
104  //- Return the explicit correction to the orthogonalSnGrad
105  // for the given field
106  virtual tmp<SurfaceField<Type>>
107  correction(const VolField<Type>&) const;
108 
109 
110  // Member Operators
111 
112  //- Disallow default bitwise assignment
113  void operator=(const orthogonalSnGrad&) = delete;
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace fv
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #ifdef NoRepository
128  #include "orthogonalSnGrad.C"
129 #endif
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
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
Simple central-difference snGrad scheme using the cell-centre to cell-centre delta-coefficients.
virtual ~orthogonalSnGrad()
Destructor.
virtual bool corrected() const
Return true if this scheme uses an explicit correction.
virtual tmp< surfaceScalarField > deltaCoeffs(const VolField< Type > &) const
Return the interpolation weighting factors for the given field.
virtual tmp< SurfaceField< Type > > correction(const VolField< Type > &) const
Return the explicit correction to the orthogonalSnGrad.
orthogonalSnGrad(const fvMesh &mesh)
Construct from mesh.
TypeName("orthogonal")
Runtime type information.
void operator=(const orthogonalSnGrad &)=delete
Disallow default bitwise assignment.
Abstract base class for snGrad schemes.
Definition: snGradScheme.H:63
const fvMesh & mesh() const
Return mesh reference.
Definition: snGradScheme.H:117
const surfaceScalarField & deltaCoeffs() const
Return reference to cell-centre difference coefficients.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
Simple central-difference snGrad scheme without non-orthogonal correction.
labelList fv(nPoints)