geomCellLooper.H 5.7 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           | www.openfoam.com
6
     \\/     M anipulation  |
OpenFOAM bot's avatar
OpenFOAM bot committed
7
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8
    Copyright (C) 2011-2016 OpenFOAM Foundation
9
    Copyright (C) 2020 OpenCFD Ltd.
10 11 12 13
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

14 15 16 17
    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.
18 19 20 21 22 23 24

    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
25
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
26 27 28 29 30 31 32 33 34 35 36

Class
    Foam::geomCellLooper

Description
    Implementation of cellLooper. Does pure geometric cut through cell.

    Handles all cell shapes in the same way: cut edges with plane through
    cell centre and normal in direction of provided direction. Snaps cuts
    close to edge endpoints (close = snapTol * minEdgeLen) to vertices.

37
    Currently determines cuts through edges (and edge endpoints close to plane)
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
    in random order and then sorts them acc. to angle. Could be converted to
    use walk but problem is that face can be cut multiple times (since does
    not need to be convex). Another problem is that edges parallel to plane
    might not be cut. So these are handled by looking at the distance from
    edge endpoints to the plane.

SourceFiles
    geomCellLooper.C

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

#ifndef geomCellLooper_H
#define geomCellLooper_H

#include "cellLooper.H"
#include "typeInfo.H"

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

namespace Foam
{

60
// Forward Declarations
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
class plane;

/*---------------------------------------------------------------------------*\
                           Class geomCellLooper Declaration
\*---------------------------------------------------------------------------*/

class geomCellLooper
:
    public cellLooper
{
    // Static

        //- Tolerance for point equal test. Fraction of edge length.
        static const scalar pointEqualTol_;

        //- Tolerance for cut through edges to get snapped to edge end point.
        //  Fraction of length of minimum connected edge length.
        static scalar snapTol_;


    // Private Member Functions

        //- Min length of attached edges
        scalar minEdgeLen(const label vertI) const;

        //- Return true and set weight if edge is cut
        bool cutEdge
        (
            const plane& cutPlane,
            const label edgeI,
            scalar& weight
        ) const;

        //- Snaps cut through edge by cut through vertex (if weight closer than
        //  tol to 0 or 1). Returns vertex label snapped to or -1.
        label snapToVert
        (
            const scalar tol,
            const label edgeI,
            const scalar weight
        ) const;

        //- Gets two (random) vectors perpendicular to n and each other to be
        //  used as base.
        void getBase
        (
            const vector& n,
            vector& e0,
            vector& e1
        ) const;

        //- Return true if the cut edge at loop[index] is inbetween the cuts
        //  through the edge end points.
        bool edgeEndsCut(const labelList&, const label index) const;


117 118
        //- No copy construct
        geomCellLooper(const geomCellLooper&) = delete;
119

120 121
        //- No copy assignment
        void operator=(const geomCellLooper&) = delete;
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144


public:

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


    // Static Functions

        static scalar snapTol()
        {
            return snapTol_;
        }

        static void setSnapTol(const scalar tol)
        {
            snapTol_ = tol;
        }


    // Constructors

145 146
        //- Construct from mesh
        explicit geomCellLooper(const polyMesh& mesh);
147 148


149
    //- Destructor
150
    virtual ~geomCellLooper() = default;
151 152 153 154


    // Member Functions

155
        //- Create cut along circumference of celli. Gets current mesh cuts.
156 157 158 159 160 161
        //  Cut along circumference is expressed as loop of cuts plus weights
        //  for cuts along edges (only valid for edge cuts).
        //  Return true if successful cut.
        virtual bool cut
        (
            const vector& refDir,
162
            const label celli,
163 164 165 166 167 168 169 170 171 172 173 174 175
            const boolList& vertIsCut,
            const boolList& edgeIsCut,
            const scalarField& edgeWeight,

            labelList& loop,
            scalarField& loopWeights
        ) const;

        //- Same but now also base point of cut provided (instead of always
        //  cell centre)
        virtual bool cut
        (
            const plane& cutPlane,
176
            const label celli,
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
            const boolList& vertIsCut,
            const boolList& edgeIsCut,
            const scalarField& edgeWeight,

            labelList& loop,
            scalarField& loopWeights
        ) const;
};


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

} // End namespace Foam

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

#endif

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