src/meshTools/triSurface/triSurfaceSearch/triSurfaceSearch.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::triSurfaceSearch
  27
  28 Description
  29     Helper class to search on triSurface.
  30
  31 SourceFiles
  32     triSurfaceSearch.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef triSurfaceSearch_H
  37 #define triSurfaceSearch_H
  38
  39 #include "pointField.H"
  40 #include "boolList.H"
  41 #include "pointIndexHit.H"
  42 #include "indexedOctree.H"
  43 #include "treeDataTriSurface.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declaration of classes
  51 class triSurface;
  52 class treeDataTriSurface;
  53 template<class Type> class indexedOctree;
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class triSurfaceSearch Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class triSurfaceSearch
  60 {
  61     // Private data
  62
  63         //- Reference to surface to work on
  64         const triSurface& surface_;
  65
  66         //- Octree for searches
  67         autoPtr<indexedOctree<treeDataTriSurface> > treePtr_;
  68
  69
  70     // Private Member Functions
  71
  72
  73         //- Disallow default bitwise copy construct
  74         triSurfaceSearch(const triSurfaceSearch&);
  75
  76         //- Disallow default bitwise assignment
  77         void operator=(const triSurfaceSearch&);
  78
  79 public:
  80
  81     // Static data members
  82
  83         //- Point far away; used for illegal finds
  84         static const point greatPoint;
  85
  86
  87     // Constructors
  88
  89         //- Construct from surface. Holds reference to surface!
  90         triSurfaceSearch(const triSurface&);
  91
  92
  93
  94     // Member Functions
  95
  96         const indexedOctree<treeDataTriSurface>& tree() const
  97         {
  98             return treePtr_();
  99         }
 100
 101         const triSurface& surface() const
 102         {
 103             return surface_;
 104         }
 105
 106         //- Calculate for each searchPoint inside/outside status.
 107         boolList calcInside(const pointField& searchPoints) const;
 108
 109         //- Calculate index of nearest triangle (or -1) for each sample.
 110         //  Looks only in box of size 2*span around sample.
 111         labelList calcNearestTri
 112         (
 113             const pointField& samples,
 114             const vector& span
 115         ) const;
 116
 117         //- Calculate nearest points (to searchPoints) on surface.
 118         //  Looks only in box of size 2*span around sample. Returns greatPoint
 119         //  if not found.
 120         tmp<pointField> calcNearest
 121         (
 122             const pointField& samples,
 123             const vector& span
 124         ) const;
 125
 126         //- Calculate nearest point on surface for single searchPoint. Returns
 127         //  in pointIndexHit:
 128         //  - hit()      : whether nearest point found within bounding box
 129         //  - hitPoint() : coordinate of nearest point
 130         //  - index()    : surface triangle label
 131         pointIndexHit nearest(const point&, const vector& span) const;
 132 };
 133
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #endif
 142
 143 // ************************************************************************* //