quadraticEqn Class Reference

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

Inheritance diagram for quadraticEqn:

Collaboration diagram for quadraticEqn:

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

Public Member Functions
	quadraticEqn ()
	Construct null. More...
	quadraticEqn (const Foam::zero)
	Construct initialized to zero. More...
	quadraticEqn (const scalar a, const scalar b, const scalar c)
	Construct from components. More...
scalar	a () const
scalar	b () const
scalar	c () const
scalar &	a ()
scalar &	b ()
scalar &	c ()
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< 2 >	roots () const
	Get the roots. More...
Public Member Functions inherited from VectorSpace< quadraticEqn, scalar, 3 >
	VectorSpace ()
	Construct null. More...
	VectorSpace (const Foam::zero)
	Construct initialized to zero. More...
	VectorSpace (Istream &)
	Construct from Istream. More...
	VectorSpace (const VectorSpace< quadraticEqn, 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< quadraticEqn, scalar, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const
const scalar &	operator[] (const direction) const
scalar &	operator[] (const direction)
void	operator= (const VectorSpace< quadraticEqn, scalar, Ncmpts > &)
void	operator= (const Foam::zero)
void	operator+= (const VectorSpace< quadraticEqn, scalar, Ncmpts > &)
void	operator-= (const VectorSpace< quadraticEqn, scalar, Ncmpts > &)
void	operator*= (const scalar)
void	operator/= (const scalar)

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< quadraticEqn, scalar, 3 >
static direction	size ()
	Return the number of elements in the VectorSpace = Ncmpts. More...
static quadraticEqn	uniform (const scalar &s)
	Return a VectorSpace with all elements = s. More...
Public Attributes inherited from VectorSpace< quadraticEqn, scalar, 3 >
scalar	v_ [Ncmpts]
	The components of this vector space. More...
Static Public Attributes inherited from VectorSpace< quadraticEqn, scalar, 3 >
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 quadraticEqn	zero
static const quadraticEqn	one
static const quadraticEqn	max
static const quadraticEqn	min
static const quadraticEqn	rootMax
static const quadraticEqn	rootMin

Detailed Description

Quadratic equation of the form a*x^2 + b*x + c = 0.

Source files

• quadraticEqn.H
• quadraticEqnI.H
• quadraticEqn.C

Definition at line 49 of file quadraticEqn.H.

Member Enumeration Documentation

components

enum components

Component labeling enumeration.

Enumerator
A
B
C

Definition at line 56 of file quadraticEqn.H.

Constructor & Destructor Documentation

quadraticEqn() [1/3]

quadraticEqn ( )

inline

Construct null.

Definition at line 28 of file quadraticEqnI.H.

Referenced by quadraticEqn::quadraticEqn().

Here is the caller graph for this function:

quadraticEqn() [2/3]

quadraticEqn ( const Foam::zero  )

inline

Construct initialized to zero.

Definition at line 32 of file quadraticEqnI.H.

References quadraticEqn::quadraticEqn().

Here is the call graph for this function:

quadraticEqn() [3/3]

quadraticEqn ( const scalar  a, const scalar  b, const scalar  c  )

inline

Construct from components.

Definition at line 39 of file quadraticEqnI.H.

References quadraticEqn::A, quadraticEqn::a(), quadraticEqn::B, quadraticEqn::b(), quadraticEqn::C, quadraticEqn::c(), and VectorSpace< quadraticEqn, scalar, 3 >::v_.

Here is the call graph for this function:

Member Function Documentation

a() [1/2]

Foam::scalar a ( ) const

inline

Definition at line 53 of file quadraticEqnI.H.

References quadraticEqn::A, and VectorSpace< quadraticEqn, scalar, 3 >::v_.

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

Here is the caller graph for this function:

b() [1/2]

Foam::scalar b ( ) const

inline

Definition at line 59 of file quadraticEqnI.H.

References quadraticEqn::B, and VectorSpace< quadraticEqn, scalar, 3 >::v_.

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

Here is the caller graph for this function:

c() [1/2]

Foam::scalar c ( ) const

inline

Definition at line 65 of file quadraticEqnI.H.

References quadraticEqn::C, and VectorSpace< quadraticEqn, scalar, 3 >::v_.

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

Here is the caller graph for this function:

a() [2/2]

Foam::scalar & a ( )

inline

Definition at line 71 of file quadraticEqnI.H.

References quadraticEqn::A, and VectorSpace< quadraticEqn, scalar, 3 >::v_.

b() [2/2]

Foam::scalar & b ( )

inline

Definition at line 77 of file quadraticEqnI.H.

References quadraticEqn::B, and VectorSpace< quadraticEqn, scalar, 3 >::v_.

c() [2/2]

Foam::scalar & c ( )

inline

Definition at line 83 of file quadraticEqnI.H.

References quadraticEqn::C, and VectorSpace< quadraticEqn, scalar, 3 >::v_.

value()

Foam::scalar value ( const scalar  x ) const

inline

Evaluate at x.

Definition at line 89 of file quadraticEqnI.H.

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

Here is the call graph for this function:

derivative()

Foam::scalar derivative ( const scalar  x ) const

inline

Evaluate the derivative at x.

Definition at line 95 of file quadraticEqnI.H.

References quadraticEqn::a(), and quadraticEqn::b().

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 101 of file quadraticEqnI.H.

References quadraticEqn::a(), quadraticEqn::b(), and Foam::mag().

Here is the call graph for this function:

roots()

Foam::Roots< 2 > roots

(

)

const

Get the roots.

Definition at line 31 of file quadraticEqn.C.

References quadraticEqn::a(), quadraticEqn::b(), quadraticEqn::c(), Foam::roots::complex, Foam::roots::nan, linearEqn::roots(), Foam::sign(), Foam::sqrt(), and x.

Referenced by cubicEqn::roots().

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/quadraticEqn/quadraticEqn.H
• src/OpenFOAM/primitives/polynomialEqns/quadraticEqn/quadraticEqn.C
• src/OpenFOAM/primitives/polynomialEqns/quadraticEqn/quadraticEqnI.H