plane.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-2026 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::plane
 
Description
    Geometric class that creates a 2D plane and can return the intersection
    point between a line and the plane.
 
SourceFiles
    plane.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef plane_H
#define plane_H
 
#include "point.H"
#include "scalarList.H"
#include "dictionary.H"
#include "NamedEnum.H"
#include "line.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of friend functions and operators
 
class plane;
bool operator==(const plane&, const plane&);
bool operator!=(const plane&, const plane&);
Ostream& operator<<(Ostream&, const plane&);
 
 
/*---------------------------------------------------------------------------*\
                            Class plane Declaration
\*---------------------------------------------------------------------------*/
 
class plane
{
    // Private Types
 
        //- Ways in which the plane can be specified
        enum class specification
        {
            planeEquation,
            embeddedPoints,
            pointAndNormal
        };
 
        //- Names of the ways in which the plane can be specified
        static const NamedEnum<specification, 3> specificationNames_;
 
 
public:
 
    // Public Types
 
        //- A direction and a reference point
        class ray
        {
            point refPoint_;
 
            vector dir_;
 
        public:
 
            ray(const point& refPoint, const vector& dir)
            :
                refPoint_(refPoint),
                dir_(dir)
            {}
 
            const point& refPoint() const
            {
                return refPoint_;
            }
 
            const vector& dir() const
            {
                return dir_;
            }
        };
 
 
private:
 
    // Private Data
 
        //- Normal
        vector normal_;
 
        //- Reference point
        point point_;
 
 
    // Private Member Functions
 
        //- Calculates basePoint and normal vector given plane coefficients
        void calcPntAndVec
        (
            const scalar C1,
            const scalar C2,
            const scalar C3,
            const scalar C4
        );
 
        //- Calculates basePoint and normal vector given three points
        void calcPntAndVec
        (
            const point& point1,
            const point& point2,
            const point& point3
        );
 
 
public:
 
    // Constructors
 
        //- Construct from normal vector through the origin
        explicit plane(const vector& normalVector);
 
        //- Construct from normal vector and point in plane
        plane(const point& basePoint, const vector& normalVector);
 
        //- Construct from three points in plane
        plane
        (
            const point& point1,
            const point& point2,
            const point& point3
        );
 
        //- Construct from coefficients for the plane equation,
        //  ax + by + cz + d = 0
        explicit plane
        (
            const scalar a,
            const scalar b,
            const scalar c,
            const scalar d
        );
 
        //- Construct from dictionary
        explicit plane(const dictionary& planeDict);
 
        //- Construct from Istream
        explicit plane(Istream& is);
 
 
    // Member Functions
 
        //- Return whether or not this plane is valid
        inline bool valid() const
        {
            return normal_ != vector::zero && point_ != point::max;
        }
 
        //- Return the plane normal
        inline const vector& normal() const
        {
            return normal_;
        }
 
        //- Return the plane base point
        inline const point& refPoint() const
        {
            return point_;
        }
 
        //- Return coefficients for the plane equation, ax + by + cz + d = 0
        FixedList<scalar, 4> planeCoeffs() const;
 
        //- Return a point on the plane
        point aPoint() const;
 
        //- Return nearest point in the plane for the given point
        point nearestPoint(const point& p) const;
 
        //- Return distance from the given point to the plane
        scalar distance(const point& p) const;
 
        //- Return signed distance from the given point to the plane
        scalar signedDistance(const point& p) const;
 
        //- Return cut coefficient for plane and line defined by
        //  origin and direction
        scalar normalIntersect(const point& pnt0, const vector& dir) const;
 
        //- Return cut coefficient for plane and ray
        inline scalar normalIntersect(const ray& r) const
        {
            return normalIntersect(r.refPoint(), r.dir());
        }
 
        //- Return the cutting point between the plane and
        // a line passing through the supplied points
        template<class Point, class PointRef>
        inline scalar lineIntersect(const line<Point, PointRef>& l) const
        {
            return normalIntersect(l.start(), l.vec());
        }
 
        //- Return the cutting line between this plane and another.
        //  Returned as direction vector and point line goes through.
        ray planeIntersect(const plane&) const;
 
        //- Return the cutting point between this plane and two other planes
        point planePlaneIntersect(const plane&, const plane&) const;
 
        //- Mirror the supplied point in the plane. Return the mirrored point.
        point mirror(const point& p) const;
 
        //- Write to dictionary
        void writeDict(Ostream&) const;
 
 
    // friend Operators
 
        friend bool operator==(const plane&, const plane&);
        friend bool operator!=(const plane&, const plane&);
 
 
    // IOstream Operators
 
        //- Write plane properties
        friend Ostream& operator<<(Ostream&, const plane&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //