PlaneIF Class Reference

#include <PlaneIF.H>

Inheritance diagram for PlaneIF:

[legend]

Collaboration diagram for PlaneIF:

[legend]

List of all members.

---

Detailed Description

This implicit function specifies a plane.

Public Member Functions
	PlaneIF (const RealVect &a_normal, const RealVect &a_point, const bool &a_inside)
	PlaneIF (const PlaneIF &a_inputIF)
	Copy constructor.
virtual	~PlaneIF ()
	Destructor.
virtual void	GetParams (RealVect &a_normal, RealVect &a_point, bool &a_inside) const
virtual void	SetParams (const RealVect &a_normal, const RealVect &a_point, const bool &a_inside)
virtual Real	value (const RealVect &a_point) const
virtual BaseIF *	newImplicitFunction () const
virtual bool	fastIntersection (const RealVect &a_low, const RealVect &a_high) const
virtual GeometryService::InOut	InsideOutside (const RealVect &a_low, const RealVect &a_high) const
Protected Attributes
RealVect	m_normal
RealVect	m_point
bool	m_inside
Private Member Functions
	PlaneIF ()
void	operator= (const PlaneIF &a_inputIF)

---

Constructor & Destructor Documentation

PlaneIF::PlaneIF	(	const RealVect &	a_normal,
		const RealVect &	a_point,
		const bool &	a_inside
	)

Constructor specifying plane normal (a_normal), a point on the plance (a_point), and whether the domain is the same side as the normal (a_inside).

PlaneIF::PlaneIF

(

const PlaneIF &

a_inputIF

)

Copy constructor.

virtual PlaneIF::~PlaneIF

(

)

[virtual]

Destructor.

PlaneIF::PlaneIF

(

)

[inline, private]

References MayDay::Error().

---

Member Function Documentation

virtual void PlaneIF::GetParams	(	RealVect &	a_normal,
		RealVect &	a_point,
		bool &	a_inside
	)			const [virtual]

Return the parameter information

virtual void PlaneIF::SetParams	(	const RealVect &	a_normal,
		const RealVect &	a_point,
		const bool &	a_inside
	)			[virtual]

Set the parameter information

virtual Real PlaneIF::value

(

const RealVect &

a_point

)

const [virtual]

Return the value of the function at a_point.

Implements BaseIF.

virtual BaseIF* PlaneIF::newImplicitFunction

(

)

const [virtual]

Return a newly allocated derived class. The responsibility for deleting the memory is left to the calling function.

Implements BaseIF.

virtual bool PlaneIF::fastIntersection	(	const RealVect &	a_low,
		const RealVect &	a_high
	)			const [inline, virtual]

Reimplemented from BaseIF.

virtual GeometryService::InOut PlaneIF::InsideOutside	(	const RealVect &	a_low,
		const RealVect &	a_high
	)			const [virtual]

Reimplemented from BaseIF.

void PlaneIF::operator=

(

const PlaneIF &

a_inputIF

)

[inline, private]

References MayDay::Error().

---

Member Data Documentation

RealVect PlaneIF::m_normal [protected]

RealVect PlaneIF::m_point [protected]

bool PlaneIF::m_inside [protected]

---

The documentation for this class was generated from the following file:

• PlaneIF.H