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