src/finiteArea/interpolation/edgeInterpolation/edgeInterpolation.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     edgeInterpolation
  26
  27 Description
  28     Cell to edge interpolation scheme. Included in faMesh.
  29
  30 SourceFiles
  31     edgeInterpolation.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef edgeInterpolation_H
  36 #define edgeInterpolation_H
  37
  38 #include "tmp.H"
  39 #include "scalar.H"
  40 #include "faSchemes.H"
  41 #include "faSolution.H"
  42 #include "areaFieldsFwd.H"
  43 #include "edgeFieldsFwd.H"
  44 #include "className.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 class polyMesh;
  52
  53 /*---------------------------------------------------------------------------*\
  54                         Class edgeInterpolation Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class edgeInterpolation
  58 {
  59     // Private data
  60
  61         // Reference to faMesh
  62         const faMesh& faMesh_;
  63
  64         //- Discretisation schemes
  65         faSchemes schemesDict_;
  66
  67         //- Solver settings
  68         faSolution solutionDict_;
  69
  70
  71         // Demand-driven data
  72
  73             //- Geodesic distance between centroides of neighbour finite areas
  74             mutable edgeScalarField* lPN_;
  75
  76             //- Cenral-differencing weighting factors
  77             mutable edgeScalarField* weightingFactors_;
  78
  79             //- Face-gradient difference factors
  80             mutable edgeScalarField* differenceFactors_;
  81
  82             //- Is mesh orthogonal
  83             mutable bool orthogonal_;
  84
  85             //- Non-orthogonality correction vectors
  86             mutable edgeVectorField* correctionVectors_;
  87
  88             //- Is mesh skew
  89             mutable bool skew_;
  90
  91             //- Skew correction vectors
  92             mutable edgeVectorField* skewCorrectionVectors_;
  93
  94
  95     // Private member functions
  96
  97         //- Construct geodesic distance between P and N
  98         void makeLPN() const;
  99
 100         //- Construct central-differencing weighting factors
 101         void makeWeights() const;
 102
 103         //- Construct face-gradient difference factors
 104         void makeDeltaCoeffs() const;
 105
 106         //- Construct non-orthogonality correction vectors
 107         void makeCorrectionVectors() const;
 108
 109         //- Construct skewness correction vectors
 110         void makeSkewCorrectionVectors() const;
 111
 112 //         //- Construct Least-squares gradient vectors
 113 //         void makeLeastSquareVectors() const;
 114
 115
 116 protected:
 117
 118     // Protected member functions
 119
 120         // Storage management
 121
 122             //- Clear all geometry and addressing
 123             void clearOut();
 124
 125
 126 public:
 127
 128     // Declare name of the class and it's debug switch
 129     ClassName("edgeInterpolation");
 130
 131
 132     // Constructors
 133
 134         //- Construct given an faMesh
 135         edgeInterpolation(const faMesh&);
 136
 137
 138     // Destructor
 139
 140         ~edgeInterpolation();
 141
 142
 143     // Member functions
 144
 145         //- Return mesh reference
 146         const faMesh& mesh() const
 147         {
 148             return faMesh_;
 149         }
 150
 151         //- Return schemes
 152         const faSchemes& schemesDict() const
 153         {
 154             return schemesDict_;
 155         }
 156
 157         //- Return access to schemes
 158         faSchemes& schemesDict()
 159         {
 160             return schemesDict_;
 161         }
 162
 163         //- Return solver settings
 164         const faSolution& solutionDict() const
 165         {
 166             return solutionDict_;
 167         }
 168
 169         //- Return access to solver settings
 170         faSolution& solutionDict()
 171         {
 172             return solutionDict_;
 173         }
 174
 175         //- Return reference to PN geodesic distance
 176         const edgeScalarField& lPN() const;
 177
 178         //- Return reference to weighting factors array
 179         const edgeScalarField& weights() const;
 180
 181         //- Return reference to difference factors array
 182         const edgeScalarField& deltaCoeffs() const;
 183
 184         //- Return whether mesh is orthogonal or not
 185         bool orthogonal() const;
 186
 187         //- Return reference to non-orthogonality correction vectors array
 188         const edgeVectorField& correctionVectors() const;
 189
 190         //- Return whether mesh is skew or not
 191         bool skew() const;
 192
 193         //- Return reference to skew vectors array
 194         const edgeVectorField& skewCorrectionVectors() const;
 195
 196
 197         //- Do what is neccessary if the mesh has moved
 198         bool movePoints() const;
 199 };
 200
 201
 202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 203
 204 } // End namespace Foam
 205
 206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 207
 208 #endif
 209
 210 // ************************************************************************* //