src/finiteVolume/fvMesh/fvMeshCutSurface/tetEdges/centreEdge.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::centreEdge
  27
  28 Description
  29     Implicit description of faceCentre to cellCentre edge
  30     (from tet decomposition).
  31
  32     Stores
  33       - face label
  34       - whether in owner or neighbour of face
  35
  36 SourceFiles
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef centreEdge_H
  41 #define centreEdge_H
  42
  43 #include "label.H"
  44 #include "primitiveMesh.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class centreEdge Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class centreEdge
  58 {
  59     // Private data
  60
  61         //- face label
  62         label faceLabel_;
  63
  64         //- is in owner or neighbour of face
  65         bool inOwner_;
  66
  67 public:
  68
  69     // Public classes
  70
  71         //- Hash function
  72         class centreEdgeHash
  73         {
  74
  75         public:
  76
  77             centreEdgeHash()
  78             {}
  79
  80             //- simple hashing function of labels
  81             label operator()(const centreEdge& ce, const label tableSize) const
  82             {
  83                 return (ce.faceLabel() + ce.inOwner()) % tableSize;
  84             }
  85         };
  86
  87
  88     // Constructors
  89
  90         //- Construct null
  91         inline centreEdge()
  92         :
  93             faceLabel_(-1),
  94             inOwner_(-1)
  95         {}
  96
  97         //- Construct from components
  98         inline centreEdge(const label faceLabel, const bool inOwner)
  99         :
 100             faceLabel_(faceLabel),
 101             inOwner_(inOwner)
 102         {}
 103
 104     // Member Functions
 105
 106         label faceLabel() const
 107         {
 108             return faceLabel_;
 109         }
 110
 111         bool inOwner() const
 112         {
 113             return inOwner_;
 114         }
 115
 116         template <class T>
 117         T interpolate
 118         (
 119             const primitiveMesh& mesh,
 120             const Field<T>& cellField,
 121             const Field<T>& faceField,
 122             const scalar weight
 123         ) const
 124         {
 125             label cellI;
 126             if (inOwner_)
 127             {
 128                 cellI = mesh.faceOwner()[faceLabel_];
 129             }
 130             else
 131             {
 132                 cellI = mesh.faceNeighbour()[faceLabel_];
 133             }
 134
 135             return
 136                 (1-weight)*faceField[faceLabel_]
 137               + weight*cellField[cellI];
 138         }
 139
 140         point coord(const primitiveMesh& mesh, const scalar weight) const
 141         {
 142             return interpolate
 143             (
 144                 mesh,
 145                 mesh.cellCentres(),
 146                 mesh.faceCentres(),
 147                 weight
 148             );
 149         }
 150
 151
 152     // Member Operators
 153
 154         bool operator==(const centreEdge& ce) const
 155         {
 156             return
 157                 (faceLabel() == ce.faceLabel())
 158              && (inOwner() == ce.inOwner());
 159         }
 160
 161
 162     // IOstream Operators
 163
 164         inline friend Ostream& operator<<(Ostream& os, const centreEdge& ce)
 165         {
 166             os  << token::BEGIN_LIST
 167                 << ce.faceLabel_ << token::SPACE
 168                 << ce.inOwner_
 169                 << token::END_LIST;
 170
 171             // Check state of Ostream
 172             os.check("Ostream& operator<<(Ostream&, const centreEdge&)");
 173
 174             return os;
 175         }
 176 };
 177
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 } // End namespace Foam
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 #endif
 186
 187 // ************************************************************************* //