OpenFOAM logo
Open Source CFD Toolkit

plane Class Reference

Inheritance diagram for plane:

Inheritance graph
[legend]
Collaboration diagram for plane:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 plane ()
 Construct null.
 plane (const point &basePoint, const vector &normalVector)
 Construct from normal vector and point in plane.
 plane (const point &point1, const point &point2, const point &point3)
 Construct from three points in plane.
 plane (const scalarList &C)
 Construct from coefficients for the.
 plane (const dictionary &planeDict)
 Construct from dictionary.
 plane (Istream &is)
 Construct from Istream. Assumes the base + normal notation.
const vectornormal () const
 Return plane normal.
const pointrefPoint () const
 Return or return plane base point.
scalarList planeCoeffs () const
 Return coefficients for the.
point nearestPoint (const point &p) const
 Return nearest point in the plane for the given point.
scalar distance (const point &p) const
 Return distance from the given point to the plane.
scalar normalIntersect (const point &pnt0, const vector &dir) const
 Return cut coefficient for plane and line defined by.
scalar normalIntersect (const ray &r) const
 Return cut coefficient for plane and ray.
template<class Point, class PointRef>
scalar lineIntersect (const line< Point, PointRef > &l) const
 Return the cutting point between the plane and.
ray planeIntersect (const plane &) const
 Return the cutting line between this plane and another.
point planePlaneIntersect (const plane &, const plane &) const
 Return the cutting point between this plane and two other planes.

Friends

Ostreamoperator<< (Ostream &, const plane &)
 Write plane properties.

Constructor & Destructor Documentation

plane  ) 
 

Construct null.

plane const point basePoint,
const vector normalVector
 

Construct from normal vector and point in plane.

plane const point point1,
const point point2,
const point point3
 

Construct from three points in plane.

plane const scalarList C  ) 
 

Construct from coefficients for the.

plane equation: ax + by + cz + d = 0

plane const dictionary planeDict  ) 
 

Construct from dictionary.

plane Istream is  ) 
 

Construct from Istream. Assumes the base + normal notation.


Member Function Documentation

scalar distance const point p  )  const
 

Return distance from the given point to the plane.

scalar lineIntersect const line< Point, PointRef > &  l  )  const [inline]
 

Return the cutting point between the plane and.

a line passing through the supplied points

Definition at line 177 of file plane.H.

point nearestPoint const point p  )  const
 

Return nearest point in the plane for the given point.

const vector& normal  )  const
 

Return plane normal.

scalar normalIntersect const ray r  )  const [inline]
 

Return cut coefficient for plane and ray.

Definition at line 167 of file plane.H.

References Foam::point.

scalar normalIntersect const point pnt0,
const vector dir
const
 

Return cut coefficient for plane and line defined by.

origin and direction

scalarList planeCoeffs  )  const
 

Return coefficients for the.

plane equation: ax + by + cz + d = 0

ray planeIntersect const plane  )  const
 

Return the cutting line between this plane and another.

Returned as direction vector and point line goes through.

point planePlaneIntersect const plane ,
const plane
const
 

Return the cutting point between this plane and two other planes.

const point& refPoint  )  const
 

Return or return plane base point.


Friends And Related Function Documentation

Ostream& operator<< Ostream ,
const plane
[friend]
 

Write plane properties.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org