src/edgeMesh/edgeMesh.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::edgeMesh
  27
  28 Description
  29     points connected by edges.
  30
  31 SourceFiles
  32     edgeMeshI.H
  33     edgeMesh.C
  34     edgeMeshIO.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef edgeMesh_H
  39 #define edgeMesh_H
  40
  41 #include "pointField.H"
  42 #include "edgeList.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class edgeMesh Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class edgeMesh
  54 {
  55     // Private data
  56
  57         //- Vertices of the edges
  58         pointField points_;
  59
  60         //- The edges defining the boundary
  61         edgeList edges_;
  62
  63         //- From point to edges
  64         mutable autoPtr<labelListList> pointEdgesPtr_;
  65
  66     // Private Member Functions
  67
  68         //- Calculate point-edge addressing (inverse of edges)
  69         void calcPointEdges() const;
  70
  71 public:
  72
  73     // Constructors
  74
  75         //- Construct from components
  76         edgeMesh(const pointField&, const edgeList&);
  77
  78         //- Construct from file
  79         edgeMesh(const fileName&);
  80
  81         //- Construct from Istream
  82         edgeMesh(Istream&);
  83
  84         //- Construct as copy
  85         edgeMesh(const edgeMesh&);
  86
  87
  88
  89     // Member Functions
  90
  91         inline const pointField& points() const;
  92
  93         inline const edgeList& edges() const;
  94
  95         inline const labelListList& pointEdges() const;
  96
  97         //- Find connected regions. Set region number per edge.
  98         //  Returns number of regions.
  99         label regions(labelList& edgeRegion) const;
 100
 101         //- Merge common points (points within mergeDist)
 102         void mergePoints(const scalar mergeDist);
 103
 104     // Member Operators
 105
 106         inline void operator=(const edgeMesh&);
 107
 108     // Ostream Operator
 109
 110         friend Ostream& operator<<(Ostream&, const edgeMesh&);
 111         friend Istream& operator>>(Istream&, edgeMesh&);
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace Foam
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 #include "edgeMeshI.H"
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //