ComplementIF Class Reference

#include <ComplementIF.H>

Inheritance diagram for ComplementIF:

[legend]

Collaboration diagram for ComplementIF:

[legend]

List of all members.

---

Detailed Description

This implicit function is the negative of the implicit function with which it is constructed. This results in an implicit function whose interior is the complement of the interior of the given implicit function (minus the the surface).

Public Member Functions
	ComplementIF (const BaseIF &a_impFunc, const bool &a_complement=true)
	ComplementIF (const ComplementIF &a_inputIF, const bool &a_complement=true)
	Copy constructor with complement boolean (default = true).
virtual	~ComplementIF ()
	Destructor.
virtual void	GetParams (bool &a_complement) const
virtual void	SetParams (const bool &a_complement)
virtual Real	value (const RealVect &a_point) const
virtual Real	value (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual IndexTM< Real, GLOBALDIM >	grad (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual IndexTM< Real, GLOBALDIM >	normal (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual Vector< IndexTM< Real, GLOBALDIM > >	gradGrad (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual Vector< IndexTM< Real, GLOBALDIM > >	gradNormal (const IndexTM< Real, GLOBALDIM > &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
bool	m_complement
BaseIF *	m_impFunc
Private Member Functions
	ComplementIF ()
void	operator= (const ComplementIF &a_inputIF)

---

Constructor & Destructor Documentation

ComplementIF::ComplementIF	(	const BaseIF &	a_impFunc,
		const bool &	a_complement = true
	)

Constructor specifying the implicit function and whether to complement (default = true)

ComplementIF::ComplementIF	(	const ComplementIF &	a_inputIF,
		const bool &	a_complement = true
	)

Copy constructor with complement boolean (default = true).

virtual ComplementIF::~ComplementIF

(

)

[virtual]

Destructor.

ComplementIF::ComplementIF

(

)

[inline, private]

References MayDay::Error().

---

Member Function Documentation

virtual void ComplementIF::GetParams

(

bool &

a_complement

)

const [virtual]

Return the parameter information

virtual void ComplementIF::SetParams

(

const bool &

a_complement

)

[virtual]

Set the parameter information

virtual Real ComplementIF::value

(

const RealVect &

a_point

)

const [virtual]

Return the value of the function at a_point.

Implements BaseIF.

virtual Real ComplementIF::value

(

const IndexTM< Real, GLOBALDIM > &

a_point

)

const [virtual]

Return the value of the function at a_point (of type INdexTM).

Reimplemented from BaseIF.

virtual IndexTM<Real,GLOBALDIM> ComplementIF::grad

(

const IndexTM< Real, GLOBALDIM > &

a_point

)

const [virtual]

Return the gradient of the function at a_point.

Reimplemented from BaseIF.

virtual IndexTM<Real,GLOBALDIM> ComplementIF::normal

(

const IndexTM< Real, GLOBALDIM > &

a_point

)

const [virtual]

Return the normal of the function at a_point.

Reimplemented from BaseIF.

virtual Vector<IndexTM <Real,GLOBALDIM> > ComplementIF::gradGrad

(

const IndexTM< Real, GLOBALDIM > &

a_point

)

const [virtual]

Return the gradient of the gradient at a_point.

Reimplemented from BaseIF.

virtual Vector< IndexTM<Real,GLOBALDIM> > ComplementIF::gradNormal

(

const IndexTM< Real, GLOBALDIM > &

a_point

)

const [virtual]

Return the gradient of the normal of the function at a_point.

Reimplemented from BaseIF.

virtual BaseIF* ComplementIF::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 ComplementIF::fastIntersection	(	const RealVect &	a_low,
		const RealVect &	a_high
	)			const [inline, virtual]

Reimplemented from BaseIF.

References BaseIF::fastIntersection(), and m_impFunc.

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

Reimplemented from BaseIF.

void ComplementIF::operator=

(

const ComplementIF &

a_inputIF

)

[inline, private]

References MayDay::Error().

---

Member Data Documentation

bool ComplementIF::m_complement [protected]

BaseIF* ComplementIF::m_impFunc [protected]

Referenced by fastIntersection().

---

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

• ComplementIF.H