octreeDataFaceList.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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::octreeDataFaceList

Description
    Holds data for octree to work on list of faces on a bMesh
    (= PrimitivePatch which holds faces, not references them)
    Same as octreeDataFace except for that.

SourceFiles
    octreeDataFaceList.C

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

#ifndef octreeDataFaceList_H
#define octreeDataFaceList_H

#include <meshTools/treeBoundBoxList.H>
#include <OpenFOAM/faceList.H>
#include <OpenFOAM/point.H>
#include <OpenFOAM/className.H>
#include "bMesh.H"

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

namespace Foam
{

// Forward declaration of classes
template<class Type> class octree;

/*---------------------------------------------------------------------------*\
                           Class octreeDataFaceList Declaration
\*---------------------------------------------------------------------------*/

class octreeDataFaceList
{
    // Static data

        //- tolerance on linear dimensions
        static scalar tol;


    // Static function

        static inline label nexti(label max, label i)
        {
            return (i + 1) % max;
        }            


    // Private data

        //- the mesh
        const bMesh& mesh_;

        //- labels (in mesh indexing) of faces
        labelList faceLabels_;

        //- bbs for all above faces
        treeBoundBoxList allBb_;


    // Private Member Functions

        //- Set allBb to tight fitting bounding box
        void calcBb();

public:

    // Declare name of the class and its debug switch
    ClassName("octreeDataFaceList");

    // Constructors

        //- Construct from all faces in bMesh.
        octreeDataFaceList(const bMesh& mesh);

        //- Construct from selected faces in bMesh.
        octreeDataFaceList(const bMesh& mesh, const labelList& faceLabels);

        //- Construct as copy
        octreeDataFaceList(const octreeDataFaceList&);


    // Destructor

        ~octreeDataFaceList();


    // Member Functions

        // Access

            const bMesh& mesh() const
            {
                return mesh_;
            }

            const labelList& faceLabels() const
            {
                return faceLabels_;
            }

            const treeBoundBoxList& allBb() const
            {
                return allBb_;
            }

            label size() const
            {
                return allBb_.size();
            }

        // Search

            //- Get type of sample
            label getSampleType
            (
                const octree<octreeDataFaceList>&,
                const point&
            ) const;

            //- Does (bb of) shape at index overlap bb
            bool overlaps
            (
                const label index,
                const treeBoundBox& sampleBb
            ) const;

            //- Does shape at index contain sample
            bool contains
            (
                const label index,
                const point& sample
            ) const;

            //- Segment (from start to end) intersection with shape
            //  at index. If intersects returns true and sets intersectionPoint
            bool intersects
            (
                const label index,
                const point& start,
                const point& end,
                point& intersectionPoint
            ) const;

            //- Sets newTightest to bounding box (and returns true) if
            //  nearer to sample than tightest bounding box. Otherwise
            //  returns false.
            bool findTightest
            (
                const label index,
                const point& sample,
                treeBoundBox& tightest
            ) const;

            //- Given index get unit normal and calculate (numerical) sign 
            //  of sample.
            //  Used to determine accuracy of calcNearest or inside/outside.
            scalar calcSign
            (
                const label index,
                const point& sample,
                vector& n
            ) const;

            //- Calculates nearest (to sample) point in shape.
            //  Returns point and mag(nearest - sample). Returns GREAT if
            //  sample does not project onto (triangle decomposition) of face.
            scalar calcNearest
            (
                const label index,
                const point& sample,
                point& nearest
            ) const;


        // Edit

        // Write

            //- Write shape at index
            void write(Ostream& os, const label index) const;
};


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

} // End namespace Foam

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


#endif

// ************************ vim: set sw=4 sts=4 et: ************************ //