Foam::vectorTools Namespace Reference

Collection of functions for testing relationships between two vectors. More...

Functions
template<typename T >
bool	areParallel (const Vector< T > &a, const Vector< T > &b, const T &tolerance=SMALL)
	Test if a and b are parallel: a^b = 0. More...
template<typename T >
bool	areOrthogonal (const Vector< T > &a, const Vector< T > &b, const T &tolerance=SMALL)
	Test if a and b are orthogonal: a.b = 0. More...
template<typename T >
bool	areAcute (const Vector< T > &a, const Vector< T > &b)
	Test if angle between a and b is acute: a.b > 0. More...
template<typename T >
bool	areObtuse (const Vector< T > &a, const Vector< T > &b)
	Test if angle between a and b is obtuse: a.b < 0. More...
template<typename T >
T	cosPhi (const Vector< T > &a, const Vector< T > &b, const T &tolerance=SMALL)
	Calculate angle between a and b in radians. More...
template<typename T >
T	radAngleBetween (const Vector< T > &a, const Vector< T > &b, const T &tolerance=SMALL)
	Calculate angle between a and b in radians. More...
template<typename T >
T	degAngleBetween (const Vector< T > &a, const Vector< T > &b, const T &tolerance=SMALL)
	Calculate angle between a and b in degrees. More...

Detailed Description

Collection of functions for testing relationships between two vectors.

Function Documentation

areParallel()

bool Foam::vectorTools::areParallel	(	const Vector< T > &	a,
		const Vector< T > &	b,
		const T &	tolerance = SMALL
	)

Test if a and b are parallel: a^b = 0.

Uses the cross product, so the tolerance is proportional to the sine of the angle between a and b in radians

Definition at line 54 of file vectorTools.H.

References Foam::constant::physicoChemical::b, and Foam::mag().

Referenced by indexedCell::potentialCoplanarCell(), and test().

Here is the call graph for this function:

Here is the caller graph for this function:

areOrthogonal()

bool Foam::vectorTools::areOrthogonal	(	const Vector< T > &	a,
		const Vector< T > &	b,
		const T &	tolerance = SMALL
	)

Test if a and b are orthogonal: a.b = 0.

Uses the dot product, so the tolerance is proportional to the cosine of the angle between a and b in radians

Definition at line 71 of file vectorTools.H.

References Foam::constant::physicoChemical::b, and Foam::mag().

Referenced by test().

Here is the call graph for this function:

Here is the caller graph for this function:

areAcute()

bool Foam::vectorTools::areAcute	(	const Vector< T > &	a,
		const Vector< T > &	b
	)

Test if angle between a and b is acute: a.b > 0.

Definition at line 83 of file vectorTools.H.

References Foam::constant::physicoChemical::b.

Referenced by test().

Here is the caller graph for this function:

areObtuse()

bool Foam::vectorTools::areObtuse	(	const Vector< T > &	a,
		const Vector< T > &	b
	)

Test if angle between a and b is obtuse: a.b < 0.

Definition at line 94 of file vectorTools.H.

References Foam::constant::physicoChemical::b.

Referenced by test().

Here is the caller graph for this function:

cosPhi()

T Foam::vectorTools::cosPhi	(	const Vector< T > &	a,
		const Vector< T > &	b,
		const T &	tolerance = SMALL
	)

Calculate angle between a and b in radians.

Definition at line 105 of file vectorTools.H.

References Foam::constant::physicoChemical::b, Foam::mag(), Foam::max(), and Foam::min().

Referenced by Foam::diff(), radAngleBetween(), and radiativeIntensityRay::radiativeIntensityRay().

Here is the call graph for this function:

Here is the caller graph for this function:

radAngleBetween()

T Foam::vectorTools::radAngleBetween	(	const Vector< T > &	a,
		const Vector< T > &	b,
		const T &	tolerance = SMALL
	)

Calculate angle between a and b in radians.

Definition at line 120 of file vectorTools.H.

References Foam::acos(), Foam::constant::physicoChemical::b, cosPhi(), Foam::mag(), Foam::max(), and Foam::min().

Referenced by degAngleBetween().

Here is the call graph for this function:

Here is the caller graph for this function:

degAngleBetween()

T Foam::vectorTools::degAngleBetween	(	const Vector< T > &	a,
		const Vector< T > &	b,
		const T &	tolerance = SMALL
	)

Calculate angle between a and b in degrees.

Definition at line 135 of file vectorTools.H.

References Foam::constant::physicoChemical::b, radAngleBetween(), and Foam::radToDeg().

Referenced by test().

Here is the call graph for this function:

Here is the caller graph for this function: