src/OpenFOAM/meshes/meshShapes/face/faceI.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 \*---------------------------------------------------------------------------*/
  26
  27 namespace Foam
  28 {
  29
  30 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  31
  32 // Edge to the right of face vertex i
  33 inline label face::right(const label i) const
  34 {
  35     return i;
  36 }
  37
  38
  39 // Edge to the left of face vertex i
  40 inline label face::left(const label i) const
  41 {
  42     return i == 0 ? size() - 1 : (i - 1);
  43 }
  44
  45
  46 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  47
  48 // Construct NULL
  49 inline face::face()
  50 {}
  51
  52
  53 // Construct given size
  54 inline face::face(label s)
  55 :
  56     labelList(s, -1)
  57 {}
  58
  59
  60 // Construct from components
  61 inline face::face(const labelList& l)
  62 :
  63     labelList(l)
  64 {}
  65
  66
  67 // Construct from Istream
  68 inline face::face(Istream& is)
  69 {
  70     is >> *this;
  71 }
  72
  73
  74 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  75
  76 inline pointField face::points(const pointField& meshPoints) const
  77 {
  78     // There are as many points as there labels for them
  79     pointField p(size());
  80
  81     // For each point in list, set it to the point in 'pnts' addressed
  82     // by 'labs'
  83     forAll(p, i)
  84     {
  85         p[i] = meshPoints[operator[](i)];
  86     }
  87
  88     // Return list
  89     return p;
  90 }
  91
  92
  93 inline scalar face::mag(const pointField& p) const
  94 {
  95     return ::Foam::mag(normal(p));
  96 }
  97
  98
  99 inline label face::nEdges() const
 100 {
 101     // for a closed polygon a number of edges is the same as number of points
 102     return size();
 103 }
 104
 105
 106 inline edge face::faceEdge(const label n) const
 107 {
 108     return edge(operator[](n), operator[](fcIndex(n)));
 109 }
 110
 111
 112 // Next vertex on face
 113 inline label face::nextLabel(const label i) const
 114 {
 115     return operator[](fcIndex(i));
 116 }
 117
 118
 119 // Previous vertex on face
 120 inline label face::prevLabel(const label i) const
 121 {
 122     return operator[](rcIndex(i));
 123 }
 124
 125
 126 // * * * * * * * * * * * * * * * Friend Operators  * * * * * * * * * * * * * //
 127
 128 inline bool operator==(const face& a, const face& b)
 129 {
 130     return face::compare(a,b) != 0;
 131 }
 132
 133
 134 inline bool operator!=(const face& a, const face& b)
 135 {
 136     return face::compare(a,b) == 0;
 137 }
 138
 139
 140 // * * * * * * * * * * * * * * * IOstream Operators  * * * * * * * * * * * * //
 141
 142 inline Istream& operator>>(Istream& is, face& f)
 143 {
 144     if (is.version() == IOstream::originalVersion)
 145     {
 146         // Read starting (
 147         is.readBegin("face");
 148
 149         // Read the 'name' token for the face
 150         token t(is);
 151
 152         // Read labels
 153         is >> static_cast<labelList&>(f);
 154
 155         // Read end)
 156         is.readEnd("face");
 157     }
 158     else
 159     {
 160         is >> static_cast<labelList&>(f);
 161     }
 162
 163     // Check state of Ostream
 164     is.check("Istream& operator>>(Istream&, face&)");
 165
 166     return is;
 167 }
 168
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // ************************************************************************* //