src/meshTools/searchableSurface/triSurfaceMesh.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::triSurfaceMesh
  27
  28 Description
  29     IOoject and searching on triSurface
  30
  31     Note: when constructing from dictionary has optional parameters:
  32         - scale     : scaling factor.
  33         - tolerance : relative tolerance for doing intersections
  34                       (see triangle::intersection)
  35
  36 SourceFiles
  37     triSurfaceMesh.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef triSurfaceMesh_H
  42 #define triSurfaceMesh_H
  43
  44 #include "treeBoundBox.H"
  45 #include "searchableSurface.H"
  46 #include "objectRegistry.H"
  47 #include "indexedOctree.H"
  48 #include "treeDataTriSurface.H"
  49 #include "treeDataEdge.H"
  50 #include "EdgeMap.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58                            Class triSurfaceMesh Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class triSurfaceMesh
  62 :
  63     public searchableSurface,
  64     public objectRegistry,      // so we can store fields
  65     public triSurface
  66 {
  67 private:
  68
  69     // Private member data
  70
  71         //- Optional tolerance to use in searches
  72         scalar tolerance_;
  73
  74         //- Search tree (triangles)
  75         mutable autoPtr<indexedOctree<treeDataTriSurface> > tree_;
  76
  77         //- Search tree for boundary edges.
  78         mutable autoPtr<indexedOctree<treeDataEdge> > edgeTree_;
  79
  80         //- Names of regions
  81         mutable wordList regions_;
  82
  83         //- Is surface closed
  84         mutable label surfaceClosed_;
  85
  86     // Private Member Functions
  87
  88         ////- Helper: find instance of files without header
  89         //static word findRawInstance
  90         //(
  91         //    const Time&,
  92         //    const fileName&,
  93         //    const word&
  94         //);
  95
  96         //- Check file existence
  97         static const fileName& checkFile
  98         (
  99             const fileName& fName,
 100             const fileName& objectName
 101         );
 102
 103         //- Helper function for isSurfaceClosed
 104         static bool addFaceToEdge
 105         (
 106             const edge&,
 107             EdgeMap<label>&
 108         );
 109
 110         //- Check whether surface is closed without calculating any permanent
 111         //  addressing.
 112         bool isSurfaceClosed() const;
 113
 114         //- Disallow default bitwise copy construct
 115         triSurfaceMesh(const triSurfaceMesh&);
 116
 117         //- Disallow default bitwise assignment
 118         void operator=(const triSurfaceMesh&);
 119
 120
 121 public:
 122
 123     //- Runtime type information
 124     TypeName("triSurfaceMesh");
 125
 126
 127     // Constructors
 128
 129         //- Construct from triSurface
 130         triSurfaceMesh(const IOobject&, const triSurface&);
 131
 132         //- Construct read.
 133         triSurfaceMesh(const IOobject& io);
 134
 135         //- Construct from IO and dictionary (used by searchableSurface).
 136         //  Dictionary may contain a 'scale' entry (eg, 0.001: mm -> m)
 137         triSurfaceMesh
 138         (
 139             const IOobject& io,
 140             const dictionary& dict
 141         );
 142
 143
 144     // Destructor
 145
 146         virtual ~triSurfaceMesh();
 147
 148         //- Clear storage
 149         void clearOut();
 150
 151
 152     // Member Functions
 153
 154         //- Move points
 155         virtual void movePoints(const pointField&);
 156
 157         //- Demand driven contruction of octree
 158         const indexedOctree<treeDataTriSurface>& tree() const;
 159
 160         //- Demand driven contruction of octree for boundary edges
 161         const indexedOctree<treeDataEdge>& edgeTree() const;
 162
 163
 164         // searchableSurface implementation
 165
 166             virtual const wordList& regions() const;
 167
 168             //- Whether supports volume type below. I.e. whether is closed.
 169             virtual bool hasVolumeType() const;
 170
 171             //- Range of local indices that can be returned.
 172             virtual label size() const
 173             {
 174                 return triSurface::size();
 175             }
 176
 177             virtual void findNearest
 178             (
 179                 const pointField& sample,
 180                 const scalarField& nearestDistSqr,
 181                 List<pointIndexHit>&
 182             ) const;
 183
 184             virtual void findLine
 185             (
 186                 const pointField& start,
 187                 const pointField& end,
 188                 List<pointIndexHit>&
 189             ) const;
 190
 191             virtual void findLineAny
 192             (
 193                 const pointField& start,
 194                 const pointField& end,
 195                 List<pointIndexHit>&
 196             ) const;
 197
 198             //- Get all intersections in order from start to end.
 199             virtual void findLineAll
 200             (
 201                 const pointField& start,
 202                 const pointField& end,
 203                 List<List<pointIndexHit> >&
 204             ) const;
 205
 206             //- From a set of points and indices get the region
 207             virtual void getRegion
 208             (
 209                 const List<pointIndexHit>&,
 210                 labelList& region
 211             ) const;
 212
 213             //- From a set of points and indices get the normal
 214             virtual void getNormal
 215             (
 216                 const List<pointIndexHit>&,
 217                 vectorField& normal
 218             ) const;
 219
 220             //- Determine type (inside/outside/mixed) for point. unknown if
 221             //  cannot be determined (e.g. non-manifold surface)
 222             virtual void getVolumeType
 223             (
 224                 const pointField&,
 225                 List<volumeType>&
 226             ) const;
 227
 228             //- Set bounds of surface. Bounds currently set as list of
 229             //  bounding boxes. The bounds are hints to the surface as for
 230             //  the range of queries it can expect. faceMap/pointMap can be
 231             //  set if the surface has done any redistribution.
 232             virtual void distribute
 233             (
 234                 const List<treeBoundBox>&,
 235                 const bool keepNonLocal,
 236                 autoPtr<mapDistribute>& faceMap,
 237                 autoPtr<mapDistribute>& pointMap
 238             )
 239             {}
 240
 241         // Other
 242
 243             //- Specific to triSurfaceMesh: from a set of hits (points and
 244             //  indices) get the specified field. Misses do not get set.
 245             virtual void getField
 246             (
 247                 const word& fieldName,
 248                 const List<pointIndexHit>&,
 249                 labelList& values
 250             ) const;
 251
 252
 253         // regIOobject implementation
 254
 255             bool writeData(Ostream&) const
 256             {
 257                 notImplemented("triSurfaceMesh::writeData(Ostream&) const");
 258                 return false;
 259             }
 260
 261             //- Write using given format, version and compression
 262             virtual bool writeObject
 263             (
 264                 IOstream::streamFormat fmt,
 265                 IOstream::versionNumber ver,
 266                 IOstream::compressionType cmp
 267             ) const;
 268
 269 };
 270
 271
 272 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 273
 274 } // End namespace Foam
 275
 276 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 277
 278 #endif
 279
 280 // ************************************************************************* //