treeDataFace.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2025 OpenFOAM Foundation
     \\/     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::treeDataFace
 
Description
    Encapsulation of data needed to search for faces.
 
SourceFiles
    treeDataFace.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef treeDataFace_H
#define treeDataFace_H
 
#include "face.H"
#include "indexedOctree.H"
#include "treeBoundBoxList.H"
#include "PackedBoolList.H"
#include "primitiveMesh.H"
#include "volumeType.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
//class primitiveMesh;
//template<class Type> class indexedOctree;
class polyPatch;
 
/*---------------------------------------------------------------------------*\
                        Class treeDataFace Declaration
\*---------------------------------------------------------------------------*/
 
class treeDataFace
{
    // Static data
 
        //- Tolerance on linear dimensions
        static scalar tolSqr;
 
 
    // Private Data
 
        //- Reference to the mesh
        const primitiveMesh& mesh_;
 
        //- Subset of faces to work on
        const labelList faceLabels_;
 
        //- Inverse of faceLabels. For every mesh whether face is in faceLabels.
        PackedBoolList isTreeFace_;
 
        //- Whether to precalculate and store face bounding box
        const bool cacheBb_;
 
        //- Face bounding boxes (valid only if cacheBb_)
        treeBoundBoxList bbs_;
 
 
    // Private Member Functions
 
        //- Calculate face bounding box
        treeBoundBox calcBb(const label celli) const;
 
        //- Initialise all member data
        void update();
 
public:
 
    class findNearestOp
    {
        const indexedOctree<treeDataFace>& tree_;
 
    public:
 
        findNearestOp(const indexedOctree<treeDataFace>& tree);
 
        void operator()
        (
            const labelUList& indices,
            const point& sample,
 
            scalar& nearestDistSqr,
            label& minIndex,
            point& nearestPoint
        ) const;
 
        void operator()
        (
            const labelUList& indices,
            const linePointRef& ln,
 
            treeBoundBox& tightest,
            label& minIndex,
            point& linePoint,
            point& nearestPoint
        ) const;
    };
 
 
    class findIntersectOp
    {
        const indexedOctree<treeDataFace>& tree_;
 
    public:
 
        findIntersectOp(const indexedOctree<treeDataFace>& tree);
 
        //- Calculate intersection of triangle with ray. Sets result
        //  accordingly
        bool operator()
        (
            const label index,
            const point& start,
            const point& end,
            point& intersectionPoint
        ) const;
    };
 
 
    // Declare name of the class and its debug switch
    ClassName("treeDataFace");
 
 
    // Constructors
 
        //- Construct from mesh and subset of faces.
        treeDataFace
        (
            const bool cacheBb,
            const primitiveMesh&,
            const labelUList&
        );
 
        //- Construct from mesh and subset of faces, transferring contents
        treeDataFace
        (
            const bool cacheBb,
            const primitiveMesh&,
            labelList&&
        );
 
        //- Construct from mesh. Uses all faces in mesh.
        treeDataFace(const bool cacheBb, const primitiveMesh&);
 
        //- Construct from mesh. Uses all faces in patch.
        treeDataFace(const bool cacheBb, const polyPatch&);
 
 
    // Member Functions
 
        // Access
 
            inline const labelList& faceLabels() const
            {
                return faceLabels_;
            }
 
            inline const primitiveMesh& mesh() const
            {
                return mesh_;
            }
 
            inline label size() const
            {
                return faceLabels_.size();
            }
 
            //- Get representative point cloud for all shapes inside
            //  (one point per shape)
            pointField shapePoints() const;
 
 
        // Search
 
            //- Get type (inside,outside,mixed,unknown) of point w.r.t. surface.
            //  Only makes sense for closed surfaces.
            volumeType getVolumeType
            (
                const indexedOctree<treeDataFace>&,
                const point&
            ) const;
 
            //- Does (bb of) shape at index overlap bb
            bool overlaps
            (
                const label index,
                const treeBoundBox& sampleBb
            ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 
#endif
 
// ************************************************************************* //