/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2017 OpenFOAM Foundation
-------------------------------------------------------------------------------
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::searchableSurfaceWithGaps

Description
    searchableSurface using multiple slightly shifted underlying surfaces
    to make sure pierces don't go through gaps:
    - shift test vector with two small vectors (of size gap_) perpendicular
      to the original.
      Test with + and - this vector. Only if both register a hit is it seen
      as one.
    - extend the test vector slightly (with SMALL) to account for numerical
      inaccuracies.

    \verbatim
    sphere.stl
    {
        type triSurfaceMesh;
    }

    sphere
    {
        type    searchableSurfaceWithGaps;
        surface sphere.stl;      // Underlying surface
        gap     1e-3;            // Perturb distance
    }
    \endverbatim

    \heading Dictionary parameters
    \table
        Property    | Description                       | Required | Default
        type        | searchableSurfaceWithGaps         | selector |
        surface     | Name of the underlying surface    | yes   |
        gap         | Gap tolerance in meters           | yes   |
    \endtable

SourceFiles
    searchableSurfaceWithGaps.C

\*---------------------------------------------------------------------------*/

#ifndef searchableSurfaceWithGaps_H
#define searchableSurfaceWithGaps_H

#include "searchableSurface.H"
#include "UPtrList.H"
#include "Pair.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                 Class searchableSurfaceWithGaps Declaration
\*---------------------------------------------------------------------------*/

class searchableSurfaceWithGaps
:
    public searchableSurface
{
private:

    // Private Member Data

        //- Gap size in metre
        const scalar gap_;

        //- Underlying geometry (size 1)
        UPtrList<searchableSurface> subGeom_;


    // Private Member Functions

        Pair<vector> offsetVecs(const point&, const point&) const;

        void offsetVecs
        (
            const pointField& start,
            const pointField& end,
            pointField& offset0,
            pointField& offset1
        ) const;

        static label countMisses
        (
            const List<pointIndexHit>& info,
            labelList& missMap
        );

        static label countMisses
        (
            const List<pointIndexHit>& plusInfo,
            const List<pointIndexHit>& minInfo,
            labelList& missMap
        );


        //- No copy construct
        searchableSurfaceWithGaps(const searchableSurfaceWithGaps&) = delete;

        //- No copy assignment
        void operator=(const searchableSurfaceWithGaps&) = delete;


public:

    //- Runtime type information
    TypeName("searchableSurfaceWithGaps");


    // Constructors

        //- Construct from dictionary (used by searchableSurface)
        searchableSurfaceWithGaps
        (
            const IOobject& io,
            const dictionary& dict
        );

    //- Destructor
    virtual ~searchableSurfaceWithGaps() = default;


    // Member Functions

        //- The underlying searchableSurface
        const searchableSurface& surface() const
        {
            return subGeom_[0];
        }

        //- Name of regions
        virtual const wordList& regions() const
        {
            return surface().regions();
        }

        //- Whether supports volume type (below)
        virtual bool hasVolumeType() const
        {
            return surface().hasVolumeType();
        }

        //- What is type of points outside bounds
        virtual volumeType outsideVolumeType() const
        {
            return surface().outsideVolumeType();
        }

        //- Range of local indices that can be returned.
        virtual label size() const
        {
            return surface().size();
        }

        //- Get representative set of element coordinates
        //  Usually the element centres (should be of length size()).
        virtual tmp<pointField> coordinates() const
        {
            return surface().coordinates();
        }

        //- Get bounding spheres (centre and radius squared), one per element.
        //  Any point on element is guaranteed to be inside.
        virtual void boundingSpheres
        (
            pointField& centres,
            scalarField& radiusSqr
        ) const
        {
            surface().boundingSpheres(centres, radiusSqr);
        }

        //- Get the points that define the surface.
        virtual tmp<pointField> points() const
        {
            return surface().points();
        }

        //- Does any part of the surface overlap the supplied bound box?
        //  Note: use perturbed surface? Since uses boundbox of points and
        //        not actual intersection chosen to use unperturbed surface.
        virtual bool overlaps(const boundBox& bb) const
        {
            return surface().overlaps(bb);
        }


        // Multiple point queries.

            //- Find nearest on original surface. Note:does not use perturbation
            //  and hence might be inconsistent with intersections.
            virtual void findNearest
            (
                const pointField& sample,
                const scalarField& nearestDistSqr,
                List<pointIndexHit>& info
            ) const
            {
                surface().findNearest
                (
                    sample,
                    nearestDistSqr,
                    info
                );
            }

            virtual void findLine
            (
                const pointField& start,
                const pointField& end,
                List<pointIndexHit>&
            ) const;

            virtual void findLineAny
            (
                const pointField& start,
                const pointField& end,
                List<pointIndexHit>&
            ) const;

            //- Get all intersections in order from start to end.
            virtual void findLineAll
            (
                const pointField& start,
                const pointField& end,
                List<List<pointIndexHit>>&
            ) const;

            //- From a set of points and indices get the region
            virtual void getRegion
            (
                const List<pointIndexHit>& info,
                labelList& region
            ) const
            {
                surface().getRegion(info, region);
            }

            //- From a set of points and indices get the normal
            virtual void getNormal
            (
                const List<pointIndexHit>& info,
                vectorField& normal
            ) const
            {
                surface().getNormal(info, normal);
            }

            //- Determine type (inside/outside/mixed) for points.
            //  Unknown if cannot be determined (e.g. non-manifold surface)
            virtual void getVolumeType
            (
                const pointField& samples,
                List<volumeType>& info
            ) const
            {
                surface().getVolumeType(samples, info);
            }


        // Other

            //- Set bounds of surface. Bounds currently set as list of
            //  bounding boxes. The bounds are hints to the surface as for
            //  the range of queries it can expect. faceMap/pointMap can be
            //  set if the surface has done any redistribution.
            //virtual void distribute
            //(
            //    const List<treeBoundBox>& bbs,
            //    const bool keepNonLocal,
            //    autoPtr<mapDistribute>& faceMap,
            //    autoPtr<mapDistribute>& pointMap
            //)
            //{
            //    subGeom_[0].distribute(bbs, keepNonLocal, faceMap, pointMap);
            //}

            //- WIP. Store element-wise field.
            virtual void setField(const labelList& values)
            {
                subGeom_[0].setField(values);
            }

            //- WIP. From a set of hits (points and
            //  indices) get the specified field. Misses do not get set. Return
            //  empty field if not supported.
            virtual void getField
            (
                const List<pointIndexHit>& info,
                labelList& values
            ) const
            {
                surface().getField(info, values);
            }

        // regIOobject implementation

            bool writeData(Ostream& os) const
            {
                return surface().writeData(os);
            }

};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //
