IntTools_Root Class Reference

The class is to describe the root of function of one variable for Edge/Edge and Edge/Surface algorithms. More...

#include <IntTools_Root.hxx>

Public Member Functions
	IntTools_Root ()
	Empty constructor.
	IntTools_Root (const double aRoot, const int aType)
	Initializes my by range of parameters and type of root.
void	SetRoot (const double aRoot)
	Sets the Root's value.
void	SetType (const int aType)
	Sets the Root's Type.
void	SetStateBefore (const TopAbs_State aState)
	Set the value of the state before the root (at t=Root-dt)
void	SetStateAfter (const TopAbs_State aState)
	Set the value of the state after the root (at t=Root-dt)
void	SetLayerHeight (const double aHeight)
	Not used in Edge/Edge algorithm.
void	SetInterval (const double t1, const double t2, const double f1, const double f2)
	Sets the interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2).
double	Root () const
	Returns the Root value.
int	Type () const
	Returns the type of the root =0 - Simple (was found by bisection method); =2 - Smart when f1=0, f2!=0 or vice versa (was found by Fibbonacci method); =1 - Pure (pure zero for all t [t1,t2]);.
TopAbs_State	StateBefore () const
	Returns the state before the root.
TopAbs_State	StateAfter () const
	Returns the state after the root.
double	LayerHeight () const
	Not used in Edge/Edge algorithm.
bool	IsValid () const
	Returns the validity flag for the root, True if myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_IN or myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_ON or myStateBefore==TopAbs_ON && myStateAfter==TopAbs_OUT or myStateBefore==TopAbs_IN && myStateAfter==TopAbs_OUT For other cases it returns False.
void	Interval (double &t1, double &t2, double &f1, double &f2) const
	Returns the values of interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2).

Detailed Description

The class is to describe the root of function of one variable for Edge/Edge and Edge/Surface algorithms.

Constructor & Destructor Documentation

IntTools_Root() [1/2]

IntTools_Root::IntTools_Root

(

)

Empty constructor.

IntTools_Root() [2/2]

IntTools_Root::IntTools_Root	(	const double	aRoot,
		const int	aType )

Initializes my by range of parameters and type of root.

Member Function Documentation

Interval()

void IntTools_Root::Interval	(	double &	t1,
		double &	t2,
		double &	f1,
		double &	f2 ) const

Returns the values of interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2).

IsValid()

bool IntTools_Root::IsValid

(

)

const

Returns the validity flag for the root, True if myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_IN or myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_ON or myStateBefore==TopAbs_ON && myStateAfter==TopAbs_OUT or myStateBefore==TopAbs_IN && myStateAfter==TopAbs_OUT For other cases it returns False.

LayerHeight()

double IntTools_Root::LayerHeight

(

)

const

Not used in Edge/Edge algorithm.

Root()

double IntTools_Root::Root

(

)

const

Returns the Root value.

SetInterval()

void IntTools_Root::SetInterval	(	const double	t1,
		const double	t2,
		const double	f1,
		const double	f2 )

Sets the interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2).

SetLayerHeight()

void IntTools_Root::SetLayerHeight

(

const double

aHeight

)

Not used in Edge/Edge algorithm.

SetRoot()

void IntTools_Root::SetRoot

(

const double

aRoot

)

Sets the Root's value.

SetStateAfter()

void IntTools_Root::SetStateAfter

(

const TopAbs_State

aState

)

Set the value of the state after the root (at t=Root-dt)

SetStateBefore()

void IntTools_Root::SetStateBefore

(

const TopAbs_State

aState

)

Set the value of the state before the root (at t=Root-dt)

SetType()

void IntTools_Root::SetType

(

const int

aType

)

Sets the Root's Type.

StateAfter()

TopAbs_State IntTools_Root::StateAfter

(

)

const

Returns the state after the root.

StateBefore()

TopAbs_State IntTools_Root::StateBefore

(

)

const

Returns the state before the root.

Type()

int IntTools_Root::Type

(

)

const

Returns the type of the root =0 - Simple (was found by bisection method); =2 - Smart when f1=0, f2!=0 or vice versa (was found by Fibbonacci method); =1 - Pure (pure zero for all t [t1,t2]);.

---

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

• IntTools_Root.hxx