OpenFOAM-6/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.H

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2018 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/>.

Application
    surfaceFeatureExtract

Description
    Utility functions for surfaceFeatureExtract

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

#include "surfaceFeatures.H"
#include "extendedFeatureEdgeMesh.H"
#include "triSurfaceFields.H"
#include "plane.H"
#include "triadField.H"

namespace Foam
{
    extern const scalar internalAngleTolerance;
    extern const scalar internalToleranceCosAngle;

    extern const scalar externalAngleTolerance;
    extern const scalar externalToleranceCosAngle;

    point randomPointInPlane(const plane& p);

    triadField calcVertexCoordSys
    (
        const triSurface& surf,
        const vectorField& pointNormals
    );

    triSurfacePointScalarField calcCurvature
    (
        const word& name,
        const Time& runTime,
        const triSurface& surf,
        const vectorField& pointNormals,
        const triadField& pointCoordSys
    );

    bool edgesConnected(const edge& e1, const edge& e2);

    scalar calcProximityOfFeaturePoints
    (
        const List<pointIndexHit>& hitList,
        const scalar defaultCellSize
    );

    scalar calcProximityOfFeatureEdges
    (
        const extendedFeatureEdgeMesh& efem,
        const List<pointIndexHit>& hitList,
        const scalar defaultCellSize
    );

    void dumpBox(const treeBoundBox& bb, const fileName& fName);

    //- Deletes all edges inside/outside bounding box from set.
    void deleteBox
    (
        const triSurface& surf,
        const treeBoundBox& bb,
        const bool removeInside,
        List<surfaceFeatures::edgeStatus>& edgeStat
    );

    bool onLine(const point& p, const linePointRef& line);

    //- Deletes all edges inside/outside bounding box from set.
    void deleteEdges
    (
        const triSurface& surf,
        const plane& cutPlane,
        List<surfaceFeatures::edgeStatus>& edgeStat
    );

    void processHit
    (
        scalar& internalCloseness,
        scalar& externalCloseness,
        const label fi,
        const triSurface& surf,
        const point& start,
        const point& p,
        const point& end,
        const vector& normal,
        const vectorField& normals,
        const List<pointIndexHit>& hitInfo
    );

    void drawHitProblem
    (
        const label fi,
        const triSurface& surf,
        const point& start,
        const point& p,
        const point& end,
        const List<pointIndexHit>& hitInfo
    );

    //- Unmark non-manifold edges if individual triangles are not features
    void unmarkBaffles
    (
        const triSurface& surf,
        const scalar includedAngle,
        List<surfaceFeatures::edgeStatus>& edgeStat
    );

    //- Divide into multiple normal bins
    //  - return REGION if != 2 normals
    //  - return REGION if 2 normals that make feature angle
    //  - otherwise return NONE and set normals,bins
    surfaceFeatures::edgeStatus checkFlatRegionEdge
    (
        const triSurface& surf,
        const scalar tol,
        const scalar includedAngle,
        const label edgeI
    );

    void extractCloseness
    (
        const fileName &sFeatFileName,
        const Time& runTime,
        const triSurface &surf,
        const bool writeVTK
    );

    void extractPointCloseness
    (
        const fileName &sFeatFileName,
        const Time& runTime,
        const triSurface &surf,
        const bool writeVTK
    );

    void writeStats(const extendedFeatureEdgeMesh& fem, Ostream& os);
}


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