src/meshTools/searchableSurface/searchableSurfaces.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::searchableSurfaces
  27
  28 Description
  29     Container for searchableSurfaces.
  30
  31 SourceFiles
  32     searchableSurfaces.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef searchableSurfaces_H
  37 #define searchableSurfaces_H
  38
  39 #include "searchableSurface.H"
  40 #include "labelPair.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class searchableSurfaces Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class searchableSurfaces
  54 :
  55     public PtrList<searchableSurface>
  56 {
  57     // Private data
  58
  59         //- Surface names
  60         wordList names_;
  61
  62         //- Region names per surface
  63         List<wordList> regionNames_;
  64
  65         ////- From global region name to surface and region on surface
  66         //HashTable<labelPair> regionNames_;
  67
  68         //- Indices of all surfaces. Precalculated and stored.
  69         labelList allSurfaces_;
  70
  71
  72     // Private Member Functions
  73
  74         //- Disallow default bitwise copy construct
  75         searchableSurfaces(const searchableSurfaces&);
  76
  77         //- Disallow default bitwise assignment
  78         void operator=(const searchableSurfaces&);
  79
  80
  81 public:
  82
  83     ClassName("searchableSurfaces");
  84
  85     // Constructors
  86
  87         //- Construct with length specified. Fill later.
  88         explicit searchableSurfaces(const label);
  89
  90
  91         ////- Construct from list of dictionaries
  92         //searchableSurfaces(const IOobject&, const PtrList<dictionary>&);
  93
  94         //- Construct from dictionary
  95         searchableSurfaces(const IOobject&, const dictionary&);
  96
  97
  98     // Member Functions
  99
 100         const wordList& names() const
 101         {
 102             return names_;
 103         }
 104         wordList& names()
 105         {
 106             return names_;
 107         }
 108
 109         const List<wordList>& regionNames() const
 110         {
 111             return regionNames_;
 112         }
 113         List<wordList>& regionNames()
 114         {
 115             return regionNames_;
 116         }
 117
 118
 119         ////- If adding surfaces 'by hand'
 120         //HashTable<labelPair>& regionNames()
 121         //{
 122         //    return regionNames_;
 123         //}
 124         ////- Get surface and region for a name
 125         //const labelPair& surfaceRegion(const word& globalRegion) const
 126         //{
 127         //    return regionNames_[globalRegion];
 128         //}
 129
 130         //- Find index of surface. Return -1 if not found.
 131         label findSurfaceID(const word& name) const;
 132
 133
 134         // Multiple point queries.
 135
 136             //- Find any intersection. Return hit point information and
 137             //  surface number. If multiple surfaces hit the first surface
 138             //  is returned, not necessarily the nearest (to start).
 139             void findAnyIntersection
 140             (
 141                 const pointField& start,
 142                 const pointField& end,
 143                 labelList& surfaces,
 144                 List<pointIndexHit>&
 145             ) const;
 146
 147             //- Find all intersections in order from start to end. Returns for
 148             //  every hit the surface and the hit info.
 149             void findAllIntersections
 150             (
 151                 const pointField& start,
 152                 const pointField& end,
 153                 labelListList& surfaces,
 154                 List<List<pointIndexHit> >&
 155             ) const;
 156
 157             //- Find nearest. Return -1 (and a miss()) or surface and nearest
 158             //  point.
 159             void findNearest
 160             (
 161                 const pointField&,
 162                 const scalarField& nearestDistSqr,
 163                 labelList& surfaces,
 164                 List<pointIndexHit>&
 165             ) const;
 166
 167
 168         // Single point queries
 169
 170             //- Calculate point which is on a set of surfaces.
 171             pointIndexHit facesIntersection
 172             (
 173                 const scalar initialDistSqr,
 174                 const scalar convergenceDistSqr,
 175                 const point& start
 176             ) const;
 177
 178 };
 179
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 } // End namespace Foam
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //