FreeFOAM The Cross-Platform CFD Toolkit
skewCorrectionVectors.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) 1991-2010 OpenCFD Ltd.
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 <OpenFOAM/MeshObject.H>
39 #include <finiteVolume/fvMesh.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, skewCorrectionVectors>
56 {
57  // Private data
58 
59  //- Is mesh skew
60  mutable bool skew_;
61 
62  //- Skew correction vectors
63  mutable surfaceVectorField* skewCorrectionVectors_;
64 
65  //- Construct skewness correction vectors
66  void makeSkewCorrectionVectors() const;
67 
68 
69 public:
70 
71  TypeName("skewCorrectionVectors");
72 
73 
74  // Constructors
75 
76  explicit skewCorrectionVectors(const fvMesh& mesh);
77 
78 
79  // Destructor
80 
81  virtual ~skewCorrectionVectors();
82 
83 
84  // Member functions
85 
86  //- Return whether mesh is skew or not
87  bool skew() const;
88 
89  //- Return reference to skew vectors array
90  const surfaceVectorField& operator()() const;
91 
92  //- Delete the correction vectors when the mesh moves
93  virtual bool movePoints();
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************ vim: set sw=4 sts=4 et: ************************ //