FreeFOAM The Cross-Platform CFD Toolkit
surfaceInterpolation.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::surfaceInterpolation
26 
27 Description
28  Cell to surface interpolation scheme. Included in fvMesh.
29 
30 SourceFiles
31  surfaceInterpolation.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef surfaceInterpolation_H
36 #define surfaceInterpolation_H
37 
38 #include <OpenFOAM/tmp.H>
39 #include <OpenFOAM/scalar.H>
40 #include <finiteVolume/fvSchemes.H>
44 #include <OpenFOAM/className.H>
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class surfaceInterpolation Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public fvSchemes,
58  public fvSolution
59 {
60  // Private data
61 
62  // Reference to fvMesh
63  const fvMesh& mesh_;
64 
65  // Demand-driven data
66 
67  //- Central-differencing weighting factors
68  mutable surfaceScalarField* weightingFactors_;
69 
70  //- Face-gradient difference factors
71  mutable surfaceScalarField* differenceFactors_;
72 
73  //- Is mesh orthogonal
74  mutable bool orthogonal_;
75 
76  //- Non-orthogonality correction vectors
77  mutable surfaceVectorField* correctionVectors_;
78 
79 
80  // Private member functions
81 
82  //- Construct central-differencing weighting factors
83  void makeWeights() const;
84 
85  //- Construct face-gradient difference factors
86  void makeDeltaCoeffs() const;
87 
88  //- Construct non-orthogonality correction vectors
89  void makeCorrectionVectors() const;
90 
91 
92 protected:
93 
94  // Protected member functions
95 
96  // Storage management
97 
98  //- Clear all geometry and addressing
99  void clearOut();
100 
101 
102 public:
103 
104  // Declare name of the class and its debug switch
105  ClassName("surfaceInterpolation");
106 
107 
108  // Constructors
109 
110  //- Construct given an fvMesh
111  explicit surfaceInterpolation(const fvMesh&);
112 
113 
114  // Destructor
115 
117 
118 
119  // Member functions
120 
121  //- Return reference to weighting factors array
122  const surfaceScalarField& weights() const;
123 
124  //- Return reference to difference factors array
125  const surfaceScalarField& deltaCoeffs() const;
126 
127  //- Return whether mesh is orthogonal or not
128  bool orthogonal() const;
129 
130  //- Return reference to non-orthogonality correction vectors array
131  const surfaceVectorField& correctionVectors() const;
132 
133  //- Do what is neccessary if the mesh has moved
134  bool movePoints();
135 };
136 
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 } // End namespace Foam
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #endif
145 
146 // ************************ vim: set sw=4 sts=4 et: ************************ //