linearEqn Class Reference

Container to encapsulate various operations for linear equation of the forms with real coefficients: More...

Inheritance diagram for linearEqn:

Collaboration diagram for linearEqn:

Public Types
enum	components { A, B }
Public Types inherited from VectorSpace< linearEqn, scalar, 2 >
typedef VectorSpace< Form, Cmpt, Ncmpts >	vsType
typedef Cmpt	cmptType
typedef Cmpt	magType
typedef Cmpt *	iterator

Public Member Functions
	linearEqn ()
	linearEqn (const Foam::zero)
	linearEqn (const scalar a, const scalar b)
scalar	a () const
scalar	b () const
scalar &	a ()
scalar &	b ()
scalar	value (const scalar x) const
scalar	derivative (const scalar x) const
scalar	error (const scalar x) const
Roots< 1 >	roots () const
Public Member Functions inherited from VectorSpace< linearEqn, scalar, 2 >
	VectorSpace ()=default
	VectorSpace (const Foam::zero)
	VectorSpace (const VectorSpace< Form, Cmpt, Ncmpts > &vs)
	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	VectorSpace (Istream &is)
const Cmpt &	component (const direction) const
Cmpt &	component (const direction)
void	component (Cmpt &, const direction) const
void	replace (const direction, const Cmpt &)
const Cmpt *	cdata () const noexcept
Cmpt *	data () noexcept
const ConstBlock< SubVector, BStart >	block () const
const Foam::VectorSpace< Form, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const
const Cmpt &	operator[] (const direction) const
Cmpt &	operator[] (const direction)
void	operator= (const VectorSpace< Form, Cmpt, Ncmpts > &)
void	operator= (const Foam::zero)
void	operator+= (const VectorSpace< Form, Cmpt, Ncmpts > &)
void	operator-= (const VectorSpace< Form, Cmpt, Ncmpts > &)
void	operator*= (const scalar)
void	operator/= (const scalar)
iterator	begin () noexcept
const_iterator	begin () const noexcept
iterator	end () noexcept
const_iterator	end () const noexcept
const_iterator	cbegin () const noexcept
const_iterator	cend () const noexcept

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< linearEqn, scalar, 2 >
static constexpr direction	size () noexcept
static Form	uniform (const Cmpt &s)
Public Attributes inherited from VectorSpace< linearEqn, scalar, 2 >
const typedef Cmpt *	const_iterator
Cmpt	v_ [Ncmpts]
Static Public Attributes inherited from VectorSpace< linearEqn, scalar, 2 >
static constexpr direction	dim
static constexpr direction	nComponents
static constexpr direction	mRows
static constexpr direction	nCols
static const char *const	typeName
static const char *const	componentNames []
static const Form	zero
static const Form	one
static const Form	max
static const Form	min
static const Form	rootMax
static const Form	rootMin

Detailed Description

Container to encapsulate various operations for linear equation of the forms with real coefficients:

See also

Test-linearEqn.C

Source files

• linearEqn.H
• linearEqnI.H

Definition at line 56 of file linearEqn.H.

Member Enumeration Documentation

components

enum components

Enumerator
A
B

Definition at line 63 of file linearEqn.H.

Constructor & Destructor Documentation

linearEqn() [1/3]

linearEqn ( )

inline

Definition at line 24 of file linearEqnI.H.

linearEqn() [2/3]

linearEqn ( const Foam::zero  )

inline

Definition at line 28 of file linearEqnI.H.

linearEqn() [3/3]

linearEqn ( const scalar  a, const scalar  b  )

inline

Definition at line 34 of file linearEqnI.H.

References A, B, and Foam::constant::physicoChemical::b.

Member Function Documentation

a() [1/2]

Foam::scalar & a ( ) const

inline

Definition at line 43 of file linearEqnI.H.

References A.

b() [1/2]

Foam::scalar & b ( ) const

inline

Definition at line 49 of file linearEqnI.H.

References B.

a() [2/2]

scalar& a ( )

inline

b() [2/2]

scalar& b ( )

inline

value()

Foam::scalar value ( const scalar  x ) const

inline

Definition at line 67 of file linearEqnI.H.

References Foam::constant::physicoChemical::b, and x.

derivative()

Foam::scalar derivative ( const scalar  x ) const

inline

Definition at line 73 of file linearEqnI.H.

error()

Foam::scalar error ( const scalar  x ) const

inline

Definition at line 79 of file linearEqnI.H.

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

Here is the call graph for this function:

roots()

Foam::Roots< 1 > roots ( ) const

inline

Definition at line 85 of file linearEqnI.H.

References Foam::constant::physicoChemical::b, Foam::mag(), Foam::roots::nan, Foam::roots::negInf, Foam::roots::posInf, Foam::roots::real, and Foam::sign().

Here is the call graph for this function:

---

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

• src/OpenFOAM/primitives/polynomialEqns/linearEqn/linearEqn.H
• src/OpenFOAM/primitives/polynomialEqns/linearEqn/linearEqnI.H