plane.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_PLANE_H
#define LIBMESH_PLANE_H

// Local includes
#include "libmesh/surface.h"

// C++ includes

namespace libMesh
{


class Plane : public Surface
{
public:

  Plane ();

  Plane (const Point& p, const Point& n);

  Plane (const Point& p0, const Point& p1, const Point& p2);

  Plane (const Plane& other_plane);

  ~Plane ();

  void create_from_point_normal (const Point& p, const Point& n);

  void create_from_three_points (const Point& p0,
                                 const Point& p1,
                                 const Point& p2 );

  void xy_plane (const Real zpos=0.);

  void xz_plane (const Real ypos=0.);

  void yz_plane (const Real xpos=0.);

  bool above_surface (const Point& p) const;

  bool below_surface (const Point& p) const;

  bool on_surface (const Point& p) const;

  Point closest_point (const Point& p) const;

  Point unit_normal (const Point& p) const;

  const Point & get_planar_point() const;


private:


  const Point& normal () const;

  Point _point;
  Point _normal;

};



// ------------------------------------------------------------
// Plane class inline members
inline const Point & Plane::normal () const
{
  return _normal;
}

} // namespace libMesh

#endif // LIBMESH_PLANE_H