triSurfaceMesh.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-2017 OpenFOAM Foundation
    Copyright (C) 2015-2018 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::triSurfaceMesh
 
Description
    IOoject and searching on triSurface
 
    Note: when constructing from dictionary has the following parameters:
        - scale     : scaling factor.
        - tolerance : relative tolerance for doing intersections
                      (see triangle::intersection)
        - minQuality: discard triangles with low quality when getting normal
 
    \heading Dictionary parameters
    \table
        Property    | Description                       | Required | Default
        type        | triSurfaceMesh                    | selector |
        file        | File name to locate the surface   | no    |
        scale       | Scaling factor                    | no    | 0
        minQuality  | Quality criterion                 | no    | -1
    \endtable
 
SourceFiles
    triSurfaceMesh.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef triSurfaceMesh_H
#define triSurfaceMesh_H
 
#include "searchableSurface.H"
#include "treeBoundBox.H"
#include "objectRegistry.H"
#include "indexedOctree.H"
#include "treeDataTriSurface.H"
#include "treeDataPrimitivePatch.H"
#include "treeDataEdge.H"
#include "edgeHashes.H"
#include "triSurface.H"
#include "triSurfaceRegionSearch.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                           Class triSurfaceMesh Declaration
\*---------------------------------------------------------------------------*/
 
class triSurfaceMesh
:
    public searchableSurface,
    public objectRegistry,      // so we can store fields
    public triSurface,
    public triSurfaceRegionSearch
{
protected:
 
    // Private member data
 
        //- Supplied fileName override
        fileName fName_;
 
        //- Optional min triangle quality. Triangles below this get
        //  ignored for normal calculation
        scalar minQuality_;
 
        //- Search tree for boundary edges.
        mutable autoPtr<indexedOctree<treeDataEdge>> edgeTree_;
 
        //- Names of regions
        mutable wordList regions_;
 
        //- Is surface closed
        mutable label surfaceClosed_;
 
        //- If surface is closed, what is type of outside points
        mutable volumeType outsideVolType_;
 
 
    // Private Member Functions
 
        //- Return fileName to load IOobject from
        static fileName checkFile(const IOobject& io, const bool isGlobal);
 
        //- Return fileName. If fileName is relative gets treated local to
        //  IOobject
        static fileName relativeFilePath
        (
            const IOobject&,
            const fileName&,
            const bool isGlobal
        );
 
        //- Return fileName to load IOobject from. Optional override of fileName
        static fileName checkFile
        (
            const IOobject&,
            const dictionary&,
            const bool isGlobal
        );
 
        //- Helper function for isSurfaceClosed
        static bool addFaceToEdge
        (
            const edge&,
            EdgeMap<label>&
        );
 
        //- Check whether surface is closed without calculating any permanent
        //  addressing.
        bool isSurfaceClosed() const;
 
        //- Steps to next intersection. Adds smallVec and starts tracking
        //  from there.
        static void getNextIntersections
        (
            const indexedOctree<treeDataTriSurface>& octree,
            const point& start,
            const point& end,
            const vector& smallVec,
            DynamicList<pointIndexHit>& hits
        );
 
        //- No copy construct
        triSurfaceMesh(const triSurfaceMesh&) = delete;
 
        //- No copy assignment
        void operator=(const triSurfaceMesh&) = delete;
 
 
public:
 
    //- Runtime type information
    TypeName("triSurfaceMesh");
 
    //- Return the mesh sub-directory name (usually "triSurface")
    static word meshSubDir;
 
 
    // Constructors
 
        //- Construct from triSurface
        triSurfaceMesh(const IOobject&, const triSurface&);
 
        //- Construct read
        triSurfaceMesh(const IOobject& io);
 
        //- Construct from IO and dictionary (used by searchableSurface).
        //  Dictionary may contain a 'scale' entry (eg, 0.001: mm -> m)
        triSurfaceMesh
        (
            const IOobject& io,
            const dictionary& dict
        );
 
 
        // Special constructors for use by distributedTriSurface. File search
        // method supplied:
 
            enum readAction
            {
                localOnly,      // load from (processor-)local file only
                localOrGlobal,  // load from (processor-)local or global file
                masterOnly      // as localOrGlobal but only load on master
            };
 
            triSurfaceMesh(const IOobject& io, const readAction r);
 
            triSurfaceMesh
            (
                const IOobject& io,
                const dictionary& dict,
                const readAction r
            );
 
 
    //- Destructor
    virtual ~triSurfaceMesh();
 
 
        //- Clear storage
        void clearOut();
 
 
    // Member Functions
 
        //- Move points
        virtual void movePoints(const pointField&);
 
        //- Demand driven construction of octree for boundary edges
        const indexedOctree<treeDataEdge>& edgeTree() const;
 
 
        // searchableSurface implementation
 
            //- Names of regions
            virtual const wordList& regions() const;
 
            //- Whether supports volume type (below) - i.e. whether is closed.
            virtual bool hasVolumeType() const;
 
            //- If surface is closed, what is type of points outside bounds
            virtual volumeType outsideVolumeType() const;
 
            //- Range of local indices that can be returned.
            virtual label size() const
            {
                return triSurface::size();
            }
 
            //- Get representative set of element coordinates
            //  Usually the element centres (should be of length size()).
            virtual tmp<pointField> coordinates() const;
 
            //- Get bounding spheres (centre and radius squared). Any point
            //  on surface is guaranteed to be inside.
            virtual void boundingSpheres
            (
                pointField& centres,
                scalarField& radiusSqr
            ) const;
 
            //- Get the points that define the surface.
            virtual tmp<pointField> points() const;
 
            // Does any part of the surface overlap the supplied bound box?
            virtual bool overlaps(const boundBox& bb) const;
 
            virtual void findNearest
            (
                const pointField& sample,
                const scalarField& nearestDistSqr,
                List<pointIndexHit>&
            ) const;
 
            virtual void findNearest
            (
                const pointField& sample,
                const scalarField& nearestDistSqr,
                const labelList& regionIndices,
                List<pointIndexHit>&
            ) const;
 
            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>&,
                labelList& region
            ) const;
 
            //- From a set of points and indices get the normal
            virtual void getNormal
            (
                const List<pointIndexHit>&,
                vectorField& normal
            ) const;
 
            //- Determine type (inside/outside/mixed) for point.
            //  Unknown if cannot be determined (e.g. non-manifold surface)
            virtual void getVolumeType
            (
                const pointField& points,
                List<volumeType>& volType
            ) const;
 
 
        // Other
 
            //- WIP. Store element-wise field.
            virtual void setField(const labelList& values);
 
            //- WIP. From a set of hits (points and
            //  indices) get the specified field. Misses do not get set.
            virtual void getField(const List<pointIndexHit>&, labelList&) const;
 
 
        // regIOobject implementation
 
            bool writeData(Ostream&) const
            {
                NotImplemented;
                return false;
            }
 
            //- Write using given format, version and compression
            virtual bool writeObject
            (
                IOstream::streamFormat fmt,
                IOstream::versionNumber ver,
                IOstream::compressionType cmp,
                const bool valid
            ) const;
 
            //- Is object global
            virtual bool global() const
            {
                return true;
            }
 
            //- Return complete path + object name if the file exists
            //  either in the case/processor or case otherwise null
            virtual fileName filePath() const
            {
                return searchableSurface::globalFilePath(type());
            }
};
 
 
//- Template function for obtaining global status
template<>
inline bool typeGlobal<triSurfaceMesh>()
{
    return true;
}
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //