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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2013 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::skewCorrectionVectors
28 
29 Description
30  Skew-correction vectors for the skewness-corrected interpolation scheme
31 
32 SourceFiles
33  skewCorrectionVectors.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef skewCorrectionVectors_H
38 #define skewCorrectionVectors_H
39 
40 #include "MeshObject.H"
41 #include "fvMesh.H"
42 #include "surfaceFields.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class fvMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class skewCorrectionVectors Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public MeshObject<fvMesh, MoveableMeshObject, skewCorrectionVectors>
58 {
59  // Private data
60 
61  //- Is mesh skew
62  bool skew_;
63 
64  //- Skew correction vectors
65  surfaceVectorField skewCorrectionVectors_;
66 
67  //- Calculate skewness correction vectors
68  void calcSkewCorrectionVectors();
69 
70 
71 public:
72 
73  TypeName("skewCorrectionVectors");
74 
75 
76  // Constructors
77 
78  explicit skewCorrectionVectors(const fvMesh& mesh);
79 
80 
81  //- Destructor
82  virtual ~skewCorrectionVectors();
83 
84 
85  // Member functions
86 
87  //- Return whether mesh is skew or not
88  bool skew() const
89  {
90  return skew_;
91  }
92 
93  //- Return reference to skew vectors array
94  const surfaceVectorField& operator()() const
95  {
96  return skewCorrectionVectors_;
97  }
98 
99  //- Update the correction vectors when the mesh moves
100  virtual bool movePoints();
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
Foam::skewCorrectionVectors::skew
bool skew() const
Return whether mesh is skew or not.
Definition: skewCorrectionVectors.H:87
Foam::skewCorrectionVectors::~skewCorrectionVectors
virtual ~skewCorrectionVectors()
Destructor.
Definition: skewCorrectionVectors.C:65
Foam::skewCorrectionVectors::operator()
const surfaceVectorField & operator()() const
Return reference to skew vectors array.
Definition: skewCorrectionVectors.H:93
surfaceFields.H
Foam::surfaceFields.
Foam::skewCorrectionVectors::skewCorrectionVectors
skewCorrectionVectors(const fvMesh &mesh)
Definition: skewCorrectionVectors.C:42
Foam::MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >::mesh
const fvMesh & mesh() const
Definition: MeshObject.H:122
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
fvMesh.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::skewCorrectionVectors
Skew-correction vectors for the skewness-corrected interpolation scheme.
Definition: skewCorrectionVectors.H:54
Foam::skewCorrectionVectors::movePoints
virtual bool movePoints()
Update the correction vectors when the mesh moves.
Definition: skewCorrectionVectors.C:153
Foam::skewCorrectionVectors::TypeName
TypeName("skewCorrectionVectors")
MeshObject.H
Foam::MeshObject
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:88
Foam::GeometricField< vector, fvsPatchField, surfaceMesh >