cubicEqn Class Reference

Cubic equation of the form a*x^3 + b*x^2 + c*x + d = 0. More...

Inheritance diagram for cubicEqn:

Collaboration diagram for cubicEqn:

Public Types
enum	components { A, B, C, D }
	Component labeling enumeration. More...
Public Types inherited from VectorSpace< cubicEqn, scalar, 4 >
typedef VectorSpace< cubicEqn, scalar, Ncmpts >	vsType
	VectorSpace type. More...
typedef scalar	cmptType
	Component type. More...

Public Member Functions
	cubicEqn ()
	Construct null. More...
	cubicEqn (const Foam::zero)
	Construct initialized to zero. More...
	cubicEqn (const scalar a, const scalar b, const scalar c, const scalar d)
	Construct from components. More...
scalar	a () const
scalar	b () const
scalar	c () const
scalar	d () const
scalar &	a ()
scalar &	b ()
scalar &	c ()
scalar &	d ()
scalar	value (const scalar x) const
	Evaluate at x. More...
scalar	derivative (const scalar x) const
	Evaluate the derivative at x. More...
scalar	error (const scalar x) const
	Estimate the error of evaluation at x. More...
Roots< 3 >	roots () const
	Get the roots. More...
Public Member Functions inherited from VectorSpace< cubicEqn, scalar, 4 >
	VectorSpace ()
	Construct null. More...
	VectorSpace (const Foam::zero)
	Construct initialized to zero. More...
	VectorSpace (Istream &)
	Construct from Istream. More...
	VectorSpace (const VectorSpace< cubicEqn, scalar, Ncmpts > &)
	Construct as copy. More...
	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	Construct as copy of a VectorSpace with the same size. More...
const scalar &	component (const direction) const
scalar &	component (const direction)
void	component (scalar &, const direction) const
void	replace (const direction, const scalar &)
const ConstBlock< SubVector, BStart >	block () const
const VectorSpace< cubicEqn, scalar, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const
const scalar &	operator[] (const direction) const
scalar &	operator[] (const direction)
void	operator= (const VectorSpace< cubicEqn, scalar, Ncmpts > &)
void	operator= (const Foam::zero)
void	operator+= (const VectorSpace< cubicEqn, scalar, Ncmpts > &)
void	operator-= (const VectorSpace< cubicEqn, scalar, Ncmpts > &)
void	operator*= (const scalar)
void	operator/= (const scalar)

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< cubicEqn, scalar, 4 >
static direction	size ()
	Return the number of elements in the VectorSpace = Ncmpts. More...
static cubicEqn	uniform (const scalar &s)
	Return a VectorSpace with all elements = s. More...
Public Attributes inherited from VectorSpace< cubicEqn, scalar, 4 >
scalar	v_ [Ncmpts]
	The components of this vector space. More...
Static Public Attributes inherited from VectorSpace< cubicEqn, scalar, 4 >
static const direction	dim
	Dimensionality of space. More...
static const direction	nComponents
	Number of components in this vector space. More...
static const direction	mRows
static const direction	nCols
static const char *const	typeName
static const char *const	componentNames []
static const cubicEqn	zero
static const cubicEqn	one
static const cubicEqn	max
static const cubicEqn	min
static const cubicEqn	rootMax
static const cubicEqn	rootMin

Detailed Description

Cubic equation of the form a*x^3 + b*x^2 + c*x + d = 0.

Source files

• cubicEqn.H
• cubicEqnI.H
• cubicEqn.C

Definition at line 49 of file cubicEqn.H.

Member Enumeration Documentation

components

enum components

Component labeling enumeration.

Enumerator
A
B
C
D

Definition at line 56 of file cubicEqn.H.

Constructor & Destructor Documentation

cubicEqn() [1/3]

cubicEqn ( )

inline

Construct null.

Definition at line 28 of file cubicEqnI.H.

Referenced by cubicEqn::cubicEqn().

Here is the caller graph for this function:

cubicEqn() [2/3]

cubicEqn ( const Foam::zero  )

inline

Construct initialized to zero.

Definition at line 32 of file cubicEqnI.H.

References cubicEqn::cubicEqn().

Here is the call graph for this function:

cubicEqn() [3/3]

cubicEqn ( const scalar  a, const scalar  b, const scalar  c, const scalar  d  )

inline

Construct from components.

Definition at line 39 of file cubicEqnI.H.

References cubicEqn::A, cubicEqn::a(), cubicEqn::B, cubicEqn::b(), cubicEqn::C, cubicEqn::c(), cubicEqn::D, cubicEqn::d(), and VectorSpace< cubicEqn, scalar, 4 >::v_.

Here is the call graph for this function:

Member Function Documentation

a() [1/2]

Foam::scalar a ( ) const

inline

Definition at line 55 of file cubicEqnI.H.

References cubicEqn::A, and VectorSpace< cubicEqn, scalar, 4 >::v_.

Referenced by cubicEqn::cubicEqn(), cubicEqn::derivative(), cubicEqn::error(), cubicEqn::roots(), and cubicEqn::value().

Here is the caller graph for this function:

b() [1/2]

Foam::scalar b ( ) const

inline

Definition at line 61 of file cubicEqnI.H.

References cubicEqn::B, and VectorSpace< cubicEqn, scalar, 4 >::v_.

Referenced by cubicEqn::cubicEqn(), cubicEqn::derivative(), cubicEqn::error(), cubicEqn::roots(), and cubicEqn::value().

Here is the caller graph for this function:

c() [1/2]

Foam::scalar c ( ) const

inline

Definition at line 67 of file cubicEqnI.H.

References cubicEqn::C, and VectorSpace< cubicEqn, scalar, 4 >::v_.

Referenced by cubicEqn::cubicEqn(), cubicEqn::derivative(), cubicEqn::error(), cubicEqn::roots(), and cubicEqn::value().

Here is the caller graph for this function:

d() [1/2]

Foam::scalar d ( ) const

inline

Definition at line 73 of file cubicEqnI.H.

References cubicEqn::D, and VectorSpace< cubicEqn, scalar, 4 >::v_.

Referenced by cubicEqn::cubicEqn(), cubicEqn::roots(), and cubicEqn::value().

Here is the caller graph for this function:

a() [2/2]

Foam::scalar & a ( )

inline

Definition at line 79 of file cubicEqnI.H.

References cubicEqn::A, and VectorSpace< cubicEqn, scalar, 4 >::v_.

b() [2/2]

Foam::scalar & b ( )

inline

Definition at line 85 of file cubicEqnI.H.

References cubicEqn::B, and VectorSpace< cubicEqn, scalar, 4 >::v_.

c() [2/2]

Foam::scalar & c ( )

inline

Definition at line 91 of file cubicEqnI.H.

References cubicEqn::C, and VectorSpace< cubicEqn, scalar, 4 >::v_.

d() [2/2]

Foam::scalar & d ( )

inline

Definition at line 97 of file cubicEqnI.H.

References cubicEqn::D, and VectorSpace< cubicEqn, scalar, 4 >::v_.

value()

Foam::scalar value ( const scalar  x ) const

inline

Evaluate at x.

Definition at line 103 of file cubicEqnI.H.

References cubicEqn::a(), cubicEqn::b(), cubicEqn::c(), and cubicEqn::d().

Referenced by particle< Type >::trackToMovingTri().

Here is the call graph for this function:

Here is the caller graph for this function:

derivative()

Foam::scalar derivative ( const scalar  x ) const

inline

Evaluate the derivative at x.

Definition at line 109 of file cubicEqnI.H.

References cubicEqn::a(), cubicEqn::b(), and cubicEqn::c().

Here is the call graph for this function:

error()

Foam::scalar error ( const scalar  x ) const

inline

Estimate the error of evaluation at x.

Definition at line 115 of file cubicEqnI.H.

References cubicEqn::a(), cubicEqn::b(), cubicEqn::c(), and Foam::mag().

Here is the call graph for this function:

roots()

Foam::Roots< 3 > roots

(

)

const

Get the roots.

Definition at line 32 of file cubicEqn.C.

References cubicEqn::a(), Foam::atan2(), cubicEqn::b(), cubicEqn::c(), Foam::cbrt(), Foam::cos(), cubicEqn::d(), Foam::hypot(), Foam::mag(), Foam::roots::nan, p, linearEqn::roots(), quadraticEqn::roots(), Foam::sign(), Foam::sin(), Foam::sqrt(), Roots< N >::type(), and x.

Referenced by Foam::eigenValues().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/OpenFOAM/primitives/polynomialEqns/cubicEqn/cubicEqn.H
• src/OpenFOAM/primitives/polynomialEqns/cubicEqn/cubicEqn.C
• src/OpenFOAM/primitives/polynomialEqns/cubicEqn/cubicEqnI.H