src/OpenFOAM/meshes/meshShapes/cellShape/cellShape.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::cellShape
  27
  28 Description
  29     An analytical geometric cellShape.
  30
  31     The optional collapse functionality changes the cellModel to the
  32     correct type after removing any duplicate points.
  33
  34 SourceFiles
  35     cellShapeI.H
  36     cellShape.C
  37     cellShapeIO.C
  38     cellShapeEqual.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef cellShape_H
  43 #define cellShape_H
  44
  45 #include "pointField.H"
  46 #include "labelList.H"
  47 #include "cellModel.H"
  48 #include "autoPtr.H"
  49 #include "InfoProxy.H"
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 namespace Foam
  54 {
  55
  56 // Forward declaration of classes
  57 class cell;
  58
  59 // Forward declaration of friend functions and operators
  60
  61 class cellShape;
  62 bool operator==(const cellShape&, const cellShape&);
  63 Istream& operator>>(Istream&, cellShape&);
  64 Ostream& operator<<(Ostream&, const cellShape&);
  65
  66
  67 /*---------------------------------------------------------------------------*\
  68                            Class cellShape Declaration
  69 \*---------------------------------------------------------------------------*/
  70
  71 class cellShape
  72 :
  73     public labelList
  74 {
  75     // Private data
  76
  77         //- Access to the cellShape's model
  78         const cellModel *m;
  79
  80
  81 public:
  82
  83     // Constructors
  84
  85         //- Construct null
  86         inline cellShape();
  87
  88         //- Construct from components
  89         inline cellShape
  90         (
  91             const cellModel&,
  92             const labelList&,
  93             const bool doCollapse = false
  94         );
  95
  96         //- Construct from Istream
  97         inline cellShape(Istream& is);
  98
  99         //- Clone
 100         inline autoPtr<cellShape> clone() const;
 101
 102
 103     // Member Functions
 104
 105         //- Return the points corresponding to this cellShape
 106         inline pointField points(const pointField& meshPoints) const;
 107
 108         //- Model reference
 109         inline const cellModel& model() const;
 110
 111         //- Mesh face labels of this cell (in order of model)
 112         inline labelList meshFaces(const faceList& allFaces, const cell&) const;
 113
 114         //- Mesh edge labels of this cell (in order of model)
 115         inline labelList meshEdges
 116         (
 117             const edgeList& allEdges,
 118             const labelList&
 119         ) const;
 120
 121         //- Faces of this cell
 122         inline faceList faces() const;
 123
 124         //- Collapsed faces of this cell
 125         inline faceList collapsedFaces() const;
 126
 127         //- Number of faces
 128         inline label nFaces() const;
 129
 130         //- Edges of this cellShape
 131         inline edgeList edges() const;
 132
 133         //- Number of edges
 134         inline label nEdges() const;
 135
 136         //- Number of points
 137         inline label nPoints() const;
 138
 139         //- Centroid of the cell
 140         inline point centre(const pointField&) const;
 141
 142         //- Return info proxy.
 143         //  Used to print token information to a stream
 144         Foam::InfoProxy<cellShape> info() const
 145         {
 146             return *this;
 147         }
 148
 149         //- Scalar magnitude
 150         inline scalar mag(const pointField&) const;
 151
 152         //- Collapse shape to correct one after removing duplicate vertices
 153         void collapse();
 154
 155
 156     // Friend Operators
 157
 158         friend bool operator==(const cellShape&, const cellShape&);
 159
 160
 161     // IOstream operators
 162
 163         friend Istream& operator>>(Istream&, cellShape&);
 164         friend Ostream& operator<<(Ostream&, const cellShape&);
 165 };
 166
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 } // End namespace Foam
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 #include "cellShapeI.H"
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 #endif
 179
 180 // ************************************************************************* //