skewCorrectionVectors.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::skewCorrectionVectors
26 
27 Description
28  Skew-correction vectors for the skewness-corrected interpolation scheme
29 
30 SourceFiles
31  skewCorrectionVectors.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef skewCorrectionVectors_H
36 #define skewCorrectionVectors_H
37 
38 #include "MeshObject.H"
39 #include "fvMesh.H"
40 #include "surfaceFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class fvMesh;
48 
49 /*---------------------------------------------------------------------------*\
50  Class skewCorrectionVectors Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public MeshObject<fvMesh, MoveableMeshObject, skewCorrectionVectors>
56 {
57  // Private Data
58 
59  //- Is mesh skew
60  bool skew_;
61 
62  //- Skew correction vectors
63  surfaceVectorField skewCorrectionVectors_;
64 
65  //- Calculate skewness correction vectors
66  void calcSkewCorrectionVectors();
67 
68 
69 public:
70 
71  TypeName("skewCorrectionVectors");
72 
73 
74  // Constructors
75 
76  explicit skewCorrectionVectors(const fvMesh& mesh);
77 
78 
79  //- Destructor
80  virtual ~skewCorrectionVectors();
81 
82 
83  // Member Functions
84 
85  //- Return whether mesh is skew or not
86  bool skew() const
87  {
88  return skew_;
89  }
90 
91  //- Return reference to skew vectors array
92  const surfaceVectorField& operator()() const
93  {
94  return skewCorrectionVectors_;
95  }
96 
97  //- Update the correction vectors when the mesh moves
98  virtual bool movePoints();
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
Foam::surfaceFields.
skewCorrectionVectors(const fvMesh &mesh)
const surfaceVectorField & operator()() const
Return reference to skew vectors array.
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:86
TypeName("skewCorrectionVectors")
virtual bool movePoints()
Update the correction vectors when the mesh moves.
Skew-correction vectors for the skewness-corrected interpolation scheme.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
bool skew() const
Return whether mesh is skew or not.
virtual ~skewCorrectionVectors()
Destructor.
Namespace for OpenFOAM.