src/meshTools/searchableSurface/searchableSurfaceCollection.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::searchableSurfaceCollection
  26
  27 Description
  28     Set of transformed searchableSurfaces. Does not do boolean operations.
  29     So when meshing might find parts 'inside'.
  30
  31 SourceFiles
  32     searchableSurfaceCollection.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef searchableSurfaceCollection_H
  37 #define searchableSurfaceCollection_H
  38
  39 #include "searchableSurface.H"
  40 #include "treeBoundBox.H"
  41 #include "coordinateSystem.H"
  42 #include "UPtrList.H"
  43 #include "Switch.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declaration of classes
  51
  52 /*---------------------------------------------------------------------------*\
  53                  Class searchableSurfaceCollection Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class searchableSurfaceCollection
  57 :
  58     public searchableSurface
  59 {
  60 private:
  61
  62     // Private Member Data
  63
  64         // Per instance data
  65
  66             //- instance name
  67             wordList instance_;
  68
  69             //- scaling vector
  70             vectorField scale_;
  71
  72             //- transformation
  73             PtrList<coordinateSystem> transform_;
  74
  75             UPtrList<searchableSurface> subGeom_;
  76
  77             Switch mergeSubRegions_;
  78
  79             //- offsets for indices coming from different surfaces
  80             //  (sized with size() of each surface)
  81             labelList indexOffset_;
  82
  83         //- Region names
  84         mutable wordList regions_;
  85         //- From individual regions to collection regions
  86         mutable labelList regionOffset_;
  87
  88
  89     // Private Member Functions
  90
  91         //- Find point nearest to sample. Updates minDistSqr. Sets nearestInfo
  92         //  and surface index
  93         void findNearest
  94         (
  95             const pointField& samples,
  96             scalarField& minDistSqr,
  97             List<pointIndexHit>& nearestInfo,
  98             labelList& nearestSurf
  99         ) const;
 100
 101         //- Sort hits into per-surface bins. Misses are rejected.
 102         //  Maintains map back to position
 103         void sortHits
 104         (
 105             const List<pointIndexHit>& info,
 106             List<List<pointIndexHit> >& surfInfo,
 107             labelListList& infoMap
 108         ) const;
 109
 110
 111         //- Disallow default bitwise copy construct
 112         searchableSurfaceCollection(const searchableSurfaceCollection&);
 113
 114         //- Disallow default bitwise assignment
 115         void operator=(const searchableSurfaceCollection&);
 116
 117
 118 public:
 119
 120     //- Runtime type information
 121     TypeName("searchableSurfaceCollection");
 122
 123
 124     // Constructors
 125
 126         //- Construct from dictionary (used by searchableSurface)
 127         searchableSurfaceCollection
 128         (
 129             const IOobject& io,
 130             const dictionary& dict
 131         );
 132
 133     //- Destructor
 134     virtual ~searchableSurfaceCollection();
 135
 136
 137     // Member Functions
 138
 139         //- scaling vector per subsurface
 140         const vectorField& scale() const
 141         {
 142             return scale_;
 143         }
 144
 145         //- scaling vector per subsurface
 146         vectorField& scale()
 147         {
 148             return scale_;
 149         }
 150
 151         //- coordinate system per subsurface
 152         const PtrList<coordinateSystem>& transform() const
 153         {
 154             return transform_;
 155         }
 156
 157         //- coordinate system per subsurface
 158         PtrList<coordinateSystem>& transform()
 159         {
 160             return transform_;
 161         }
 162
 163
 164         virtual const wordList& regions() const;
 165
 166         //- Whether supports volume type below
 167         virtual bool hasVolumeType() const
 168         {
 169             return false;
 170         }
 171
 172         //- Range of local indices that can be returned.
 173         virtual label size() const;
 174
 175         //- Get representative set of element coordinates
 176         //  Usually the element centres (should be of length size()).
 177         virtual pointField coordinates() const;
 178
 179
 180         // Multiple point queries.
 181
 182             virtual void findNearest
 183             (
 184                 const pointField& sample,
 185                 const scalarField& nearestDistSqr,
 186                 List<pointIndexHit>&
 187             ) const;
 188
 189             virtual void findLine
 190             (
 191                 const pointField& start,
 192                 const pointField& end,
 193                 List<pointIndexHit>&
 194             ) const;
 195
 196             virtual void findLineAny
 197             (
 198                 const pointField& start,
 199                 const pointField& end,
 200                 List<pointIndexHit>&
 201             ) const;
 202
 203             //- Get all intersections in order from start to end.
 204             virtual void findLineAll
 205             (
 206                 const pointField& start,
 207                 const pointField& end,
 208                 List<List<pointIndexHit> >&
 209             ) const;
 210
 211             //- From a set of points and indices get the region
 212             virtual void getRegion
 213             (
 214                 const List<pointIndexHit>&,
 215                 labelList& region
 216             ) const;
 217
 218             //- From a set of points and indices get the normal
 219             virtual void getNormal
 220             (
 221                 const List<pointIndexHit>&,
 222                 vectorField& normal
 223             ) const;
 224
 225             //- Determine type (inside/outside/mixed) for point. unknown if
 226             //  cannot be determined (e.g. non-manifold surface)
 227             virtual void getVolumeType
 228             (
 229                 const pointField&,
 230                 List<volumeType>&
 231             ) const;
 232
 233         // Other
 234
 235             //- Set bounds of surface. Bounds currently set as list of
 236             //  bounding boxes. The bounds are hints to the surface as for
 237             //  the range of queries it can expect. faceMap/pointMap can be
 238             //  set if the surface has done any redistribution.
 239             virtual void distribute
 240             (
 241                 const List<treeBoundBox>&,
 242                 const bool keepNonLocal,
 243                 autoPtr<mapDistribute>& faceMap,
 244                 autoPtr<mapDistribute>& pointMap
 245             );
 246
 247             //- WIP. Store element-wise field.
 248             virtual void setField(const labelList& values);
 249
 250             //- WIP. From a set of hits (points and
 251             //  indices) get the specified field. Misses do not get set. Return
 252             //  empty field if not supported.
 253             virtual void getField(const List<pointIndexHit>&, labelList&) const;
 254
 255         // regIOobject implementation
 256
 257             bool writeData(Ostream&) const
 258             {
 259                 notImplemented
 260                 (
 261                     "searchableSurfaceCollection::writeData(Ostream&) const"
 262                 );
 263                 return false;
 264             }
 265
 266 };
 267
 268
 269 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 270
 271 } // End namespace Foam
 272
 273 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 274
 275 #endif
 276
 277 // ************************************************************************* //