triSurfaceSearch.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2016 OpenFOAM Foundation
    Copyright (C) 2017-2022 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::triSurfaceSearch
 
Description
    Helper class to search on triSurface.
 
SourceFiles
    triSurfaceSearch.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef triSurfaceSearch_H
#define triSurfaceSearch_H
 
#include "pointField.H"
#include "boolList.H"
#include "pointIndexHit.H"
#include "indexedOctree.H"
#include "treeDataTriSurface.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
class triSurface;
 
/*---------------------------------------------------------------------------*\
                      Class triSurfaceSearch Declaration
\*---------------------------------------------------------------------------*/
 
class triSurfaceSearch
{
    // Private data
 
        //- Reference to surface to work on
        const triSurface& surface_;
 
        //- Optional tolerance to use in searches
        scalar tolerance_;
 
        //- Optional max tree depth of octree
        label maxTreeDepth_;
 
        //- Octree for searches
        mutable autoPtr<indexedOctree<treeDataTriSurface>> treePtr_;
 
 
    // Private Member Functions
 
        //- Check whether the current hit on the surface which lies on lineVec
        //  is unique.
        //  point : return 1 unique hit
        //  edge  : return 1 hit if in the cone of the edge faces
        //        : return 2 hits if outside or on the cone.
        bool checkUniqueHit
        (
            const pointIndexHit& currHit,
            const UList<pointIndexHit>& hits,
            const vector& lineVec
        ) const;
 
        //- No copy construct
        triSurfaceSearch(const triSurfaceSearch&) = delete;
 
        //- No copy assignment
        void operator=(const triSurfaceSearch&) = delete;
 
 
public:
 
    // Constructors
 
        //- Construct from surface. Holds reference to surface!
        explicit triSurfaceSearch(const triSurface& surface);
 
        //- Construct from surface and dictionary.
        triSurfaceSearch(const triSurface& surface, const dictionary& dict);
 
        //- Construct from components.
        //  A invalid (negative) tolerance uses the default tolerance.
        triSurfaceSearch
        (
            const triSurface& surface,
            const scalar tolerance,
            const label maxTreeDepth = 10
        );
 
 
    //- Destructor
    ~triSurfaceSearch();
 
        //- Clear storage
        void clearOut();
 
 
    // Member Functions
 
        //- Demand driven construction of the octree
        const indexedOctree<treeDataTriSurface>& tree() const;
 
        //- Flip orientation (if cached on octree)
        void flip();
 
        //- Return reference to the surface.
        const triSurface& surface() const
        {
            return surface_;
        }
 
        //- Return tolerance to use in searches
        scalar tolerance() const
        {
            return tolerance_;
        }
 
        //- Return max tree depth of octree
        label maxTreeDepth() const
        {
            return maxTreeDepth_;
        }
 
        //- Calculate for each searchPoint inside/outside status.
        boolList calcInside(const pointField& searchPoints) const;
 
        void findNearest
        (
            const pointField& samples,
            const scalarField& nearestDistSqr,
            List<pointIndexHit>& info
        ) const;
 
        //- Calculate nearest point on surface for single searchPoint. Returns
        //  in pointIndexHit:
        //  - hit()      : whether nearest point found within bounding box
        //  - point()    : coordinate of nearest point
        //  - index()    : surface triangle label
        pointIndexHit nearest(const point& pt, const vector& span) const;
 
        void findLine
        (
            const pointField& start,
            const pointField& end,
            List<pointIndexHit>& info
        ) const;
 
        void findLineAny
        (
            const pointField& start,
            const pointField& end,
            List<pointIndexHit>& info
        ) const;
 
        //- Calculate all intersections from start to end
        void findLineAll
        (
            const pointField& start,
            const pointField& end,
            List<List<pointIndexHit>>& info
        ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //